[Enhancement](java-udf) java-udf module split to sub modules

apache · Jun 4, 2023 · 5526a97 · 5526a97
1 parent 8ca4f93
commit 5526a97
Show file tree

Hide file tree

Showing 56 changed files with 629 additions and 183 deletions.
diff --git a/be/src/util/jni-util.cpp b/be/src/util/jni-util.cpp
@@ -267,7 +267,7 @@ Status JniUtil::Init() {
     RETURN_IF_ERROR(JniUtil::GetJNIEnv(&env));
     if (env == NULL) return Status::InternalError("Failed to get/create JVM");
     // Find JniUtil class and create a global ref.
-    jclass local_jni_util_cl = env->FindClass("org/apache/doris/udf/JniUtil");
+    jclass local_jni_util_cl = env->FindClass("org/apache/doris/common/jni/utils/JniUtil");
     if (local_jni_util_cl == NULL) {
         if (env->ExceptionOccurred()) env->ExceptionDescribe();
         return Status::InternalError("Failed to find JniUtil class.");
@@ -283,7 +283,7 @@ Status JniUtil::Init() {
     }
 
     // Find InternalException class and create a global ref.
-    jclass local_internal_exc_cl = env->FindClass("org/apache/doris/udf/InternalException");
+    jclass local_internal_exc_cl = env->FindClass("org/apache/doris/common/exception/InternalException");
     if (local_internal_exc_cl == NULL) {
         if (env->ExceptionOccurred()) env->ExceptionDescribe();
         return Status::InternalError("Failed to find JniUtil class.");
@@ -299,7 +299,7 @@ Status JniUtil::Init() {
     }
 
     // Find JNINativeMethod class and create a global ref.
-    jclass local_jni_native_exc_cl = env->FindClass("org/apache/doris/udf/JNINativeMethod");
+    jclass local_jni_native_exc_cl = env->FindClass("org/apache/doris/common/jni/utils/JNINativeMethod");
     if (local_jni_native_exc_cl == nullptr) {
         if (env->ExceptionOccurred()) {
             env->ExceptionDescribe();

diff --git a/be/src/util/jni_native_method.h b/be/src/util/jni_native_method.h
@@ -24,7 +24,7 @@
 namespace doris {
 
 /**
- * Java native methods for org.apache.doris.udf.JNINativeMethod.
+ * Java native methods for org.apache.doris.common.jni.utils.JNINativeMethod.
  */
 struct JavaNativeMethods {
     /**

diff --git a/be/src/vec/exec/jni_connector.cpp b/be/src/vec/exec/jni_connector.cpp
@@ -67,7 +67,7 @@ Status JniConnector::open(RuntimeState* state, RuntimeProfile* profile) {
         return Status::InternalError("Failed to get/create JVM");
     }
     RETURN_IF_ERROR(_init_jni_scanner(_env, state->batch_size()));
-    // Call org.apache.doris.jni.JniScanner#open
+    // Call org.apache.doris.common.jni.JniScanner#open
     _env->CallVoidMethod(_jni_scanner_obj, _jni_scanner_open);
     RETURN_ERROR_IF_EXC(_env);
     return Status::OK();
@@ -78,7 +78,7 @@ Status JniConnector::init(
     _generate_predicates(colname_to_value_range);
     if (_predicates_length != 0 && _predicates != nullptr) {
         int64_t predicates_address = (int64_t)_predicates.get();
-        // We can call org.apache.doris.jni.vec.ScanPredicate#parseScanPredicates to parse the
+        // We can call org.apache.doris.common.jni.vec.ScanPredicate#parseScanPredicates to parse the
         // serialized predicates in java side.
         _scanner_params.emplace("push_down_predicates", std::to_string(predicates_address));
     }
@@ -88,7 +88,7 @@ Status JniConnector::init(
 Status JniConnector::get_nex_block(Block* block, size_t* read_rows, bool* eof) {
     JniLocalFrame jni_frame;
     RETURN_IF_ERROR(jni_frame.push(_env));
-    // Call org.apache.doris.jni.JniScanner#getNextBatchMeta
+    // Call org.apache.doris.common.jni.JniScanner#getNextBatchMeta
     // return the address of meta information
     long meta_address = _env->CallLongMethod(_jni_scanner_obj, _jni_scanner_get_next_batch);
     RETURN_ERROR_IF_EXC(_env);
@@ -117,7 +117,7 @@ Status JniConnector::get_nex_block(Block* block, size_t* read_rows, bool* eof) {
 Status JniConnector::close() {
     if (!_closed) {
         // _fill_block may be failed and returned, we should release table in close.
-        // org.apache.doris.jni.JniScanner#releaseTable is idempotent
+        // org.apache.doris.common.jni.JniScanner#releaseTable is idempotent
         _env->CallVoidMethod(_jni_scanner_obj, _jni_scanner_release_table);
         _env->CallVoidMethod(_jni_scanner_obj, _jni_scanner_close);
         _env->DeleteLocalRef(_jni_scanner_obj);
@@ -191,7 +191,7 @@ Status JniConnector::_fill_column(ColumnPtr& doris_column, DataTypePtr& data_typ
     TypeIndex logical_type = remove_nullable(data_type)->get_type_id();
     void* null_map_ptr = _next_meta_as_ptr();
     if (null_map_ptr == nullptr) {
-        // org.apache.doris.jni.vec.ColumnType.Type#UNSUPPORTED will set column address as 0
+        // org.apache.doris.common.jni.vec.ColumnType.Type#UNSUPPORTED will set column address as 0
         return Status::InternalError("Unsupported type {} in java side", getTypeName(logical_type));
     }
     MutableColumnPtr data_column;

diff --git a/be/src/vec/exec/jni_connector.h b/be/src/vec/exec/jni_connector.h
@@ -55,13 +55,13 @@ struct Decimal;
 namespace doris::vectorized {
 
 /**
- * Connector to java jni scanner, which should extend org.apache.doris.jni.JniScanner
+ * Connector to java jni scanner, which should extend org.apache.doris.common.jni.JniScanner
  */
 class JniConnector {
 public:
     /**
      * The predicates that can be pushed down to java side.
-     * Reference to java class org.apache.doris.jni.vec.ScanPredicate
+     * Reference to java class org.apache.doris.common.jni.vec.ScanPredicate
      */
     template <typename CppType>
     struct ScanPredicate {
@@ -102,7 +102,7 @@ class JniConnector {
         /**
          * The value ranges can be stored as byte array as following format:
          * number_filters(4) | length(4) | column_name | op(4) | scale(4) | num_values(4) | value_length(4) | value | ...
-         * The read method is implemented in org.apache.doris.jni.vec.ScanPredicate#parseScanPredicates
+         * The read method is implemented in org.apache.doris.common.jni.vec.ScanPredicate#parseScanPredicates
          */
         int write(std::unique_ptr<char[]>& predicates, int origin_length) {
             int num_filters = 0;
@@ -233,7 +233,7 @@ class JniConnector {
     std::unique_ptr<char[]> _predicates = nullptr;
 
     /**
-     * Set the address of meta information, which is returned by org.apache.doris.jni.JniScanner#getNextBatchMeta
+     * Set the address of meta information, which is returned by org.apache.doris.common.jni.JniScanner#getNextBatchMeta
      */
     void _set_meta(long meta_addr) {
         _meta_ptr = static_cast<long*>(reinterpret_cast<void*>(meta_addr));

diff --git a/be/src/vec/exec/scan/jni_reader.cpp b/be/src/vec/exec/scan/jni_reader.cpp
@@ -58,7 +58,7 @@ MockJniReader::MockJniReader(const std::vector<SlotDescriptor*>& file_slot_descs
     std::map<String, String> params = {{"mock_rows", "10240"},
                                        {"required_fields", required_fields.str()},
                                        {"columns_types", columns_types.str()}};
-    _jni_connector = std::make_unique<JniConnector>("org/apache/doris/jni/MockJniScanner", params,
+    _jni_connector = std::make_unique<JniConnector>("org/apache/doris/common/jni/MockJniScanner", params,
                                                     column_names);
 }
 

diff --git a/be/src/vec/exec/vjdbc_connector.cpp b/be/src/vec/exec/vjdbc_connector.cpp
@@ -61,7 +61,7 @@
 
 namespace doris {
 namespace vectorized {
-const char* JDBC_EXECUTOR_CLASS = "org/apache/doris/udf/JdbcExecutor";
+const char* JDBC_EXECUTOR_CLASS = "org/apache/doris/jdbc/JdbcExecutor";
 const char* JDBC_EXECUTOR_CTOR_SIGNATURE = "([B)V";
 const char* JDBC_EXECUTOR_WRITE_SIGNATURE = "(Ljava/lang/String;)I";
 const char* JDBC_EXECUTOR_STMT_WRITE_SIGNATURE = "(Ljava/util/Map;)I";

diff --git a/build.sh b/build.sh
@@ -38,23 +38,23 @@ usage() {
     echo "
 Usage: $0 <options>
   Optional options:
-     [no option]        build all components
-     --fe               build Frontend and Spark DPP application. Default ON.
-     --be               build Backend. Default ON.
-     --meta-tool        build Backend meta tool. Default OFF.
-     --broker           build Broker. Default ON.
-     --audit            build audit loader. Default ON.
-     --spark-dpp        build Spark DPP application. Default ON.
-     --hive-udf         build Hive UDF library for Spark Load. Default ON.
-     --java-udf         build Java UDF. Default ON.
-     --clean            clean and build target
-     --output           specify the output directory
-     -j                 build Backend parallel
+     [no option]            build all components
+     --fe                   build Frontend and Spark DPP application. Default ON.
+     --be                   build Backend. Default ON.
+     --meta-tool            build Backend meta tool. Default OFF.
+     --broker               build Broker. Default ON.
+     --audit                build audit loader. Default ON.
+     --spark-dpp            build Spark DPP application. Default ON.
+     --hive-udf             build Hive UDF library for Spark Load. Default ON.
+     --be-java-extensions   build Backend java extensions. Default ON.
+     --clean                clean and build target
+     --output               specify the output directory
+     -j                     build Backend parallel
 
   Environment variables:
     USE_AVX2                    If the CPU does not support AVX2 instruction set, please set USE_AVX2=0. Default is ON.
     STRIP_DEBUG_INFO            If set STRIP_DEBUG_INFO=ON, the debug information in the compiled binaries will be stored separately in the 'be/lib/debug_info' directory. Default is OFF.
-    DISABLE_JAVA_UDF            If set DISABLE_JAVA_UDF=ON, we will do not build binary with java-udf. Default is OFF.
+    DISABLE_BE_JAVA_EXTENSIONS  If set DISABLE_BE_JAVA_EXTENSIONS=ON, we will do not build binary with java-udf,hudi-scanner,jdbc-scanner and so on Default is OFF.
     DISABLE_JAVA_CHECK_STYLE    If set DISABLE_JAVA_CHECK_STYLE=ON, it will skip style check of java code in FE.
   Eg.
     $0                                      build all
@@ -119,7 +119,7 @@ if ! OPTS="$(getopt \
     -l 'meta-tool' \
     -l 'spark-dpp' \
     -l 'hive-udf' \
-    -l 'java-udf' \
+    -l 'be-java-extensions' \
     -l 'clean' \
     -l 'coverage' \
     -l 'help' \
@@ -138,7 +138,7 @@ BUILD_BROKER=0
 BUILD_AUDIT=0
 BUILD_META_TOOL='OFF'
 BUILD_SPARK_DPP=0
-BUILD_JAVA_UDF=0
+BUILD_BE_JAVA_EXTENSIONS=0
 BUILD_HIVE_UDF=0
 CLEAN=0
 HELP=0
@@ -154,7 +154,7 @@ if [[ "$#" == 1 ]]; then
     BUILD_META_TOOL='OFF'
     BUILD_SPARK_DPP=1
     BUILD_HIVE_UDF=1
-    BUILD_JAVA_UDF=1
+    BUILD_BE_JAVA_EXTENSIONS=1
     CLEAN=0
 else
     while true; do
@@ -163,12 +163,12 @@ else
             BUILD_FE=1
             BUILD_SPARK_DPP=1
             BUILD_HIVE_UDF=1
-            BUILD_JAVA_UDF=1
+            BUILD_BE_JAVA_EXTENSIONS=1
             shift
             ;;
         --be)
             BUILD_BE=1
-            BUILD_JAVA_UDF=1
+            BUILD_BE_JAVA_EXTENSIONS=1
             shift
             ;;
         --broker)
@@ -191,8 +191,8 @@ else
             BUILD_HIVE_UDF=1
             shift
             ;;
-        --java-udf)
-            BUILD_JAVA_UDF=1
+        --be-java-extensions)
+            BUILD_BE_JAVA_EXTENSIONS=1
             shift
             ;;
         --clean)
@@ -239,7 +239,7 @@ else
         BUILD_META_TOOL='ON'
         BUILD_SPARK_DPP=1
         BUILD_HIVE_UDF=1
-        BUILD_JAVA_UDF=1
+        BUILD_BE_JAVA_EXTENSIONS=1
         CLEAN=0
     fi
 fi
@@ -343,8 +343,8 @@ if [[ -z "${OUTPUT_BE_BINARY}" ]]; then
     OUTPUT_BE_BINARY=${BUILD_BE}
 fi
 
-if [[ -z "${DISABLE_JAVA_UDF}" ]]; then
-    DISABLE_JAVA_UDF='OFF'
+if [[ -z "${BUILD_BE_JAVA_EXTENSIONS}" ]]; then
+    BUILD_BE_JAVA_EXTENSIONS='OFF'
 fi
 
 if [[ -z "${DISABLE_JAVA_CHECK_STYLE}" ]]; then
@@ -355,7 +355,7 @@ if [[ -z "${RECORD_COMPILER_SWITCHES}" ]]; then
     RECORD_COMPILER_SWITCHES='OFF'
 fi
 
-if [[ "${BUILD_JAVA_UDF}" -eq 1 && "$(uname -s)" == 'Darwin' ]]; then
+if [[ "${BUILD_BE_JAVA_EXTENSIONS}" -eq 1 && "$(uname -s)" == 'Darwin' ]]; then
     if [[ -z "${JAVA_HOME}" ]]; then
         CAUSE='the environment variable JAVA_HOME is not set'
     else
@@ -369,13 +369,13 @@ if [[ "${BUILD_JAVA_UDF}" -eq 1 && "$(uname -s)" == 'Darwin' ]]; then
 
     if [[ -n "${CAUSE}" ]]; then
         echo -e "\033[33;1mWARNNING: \033[37;1mSkip building with Java UDF due to ${CAUSE}.\033[0m"
-        BUILD_JAVA_UDF=0
-        DISABLE_JAVA_UDF_IN_CONF=1
+        BUILD_BE_JAVA_EXTENSIONS=0
+        BUILD_BE_JAVA_EXTENSIONS_IN_CONF=1
     fi
 fi
 
-if [[ "${DISABLE_JAVA_UDF}" == "ON" ]]; then
-    BUILD_JAVA_UDF=0
+if [[ "${BUILD_BE_JAVA_EXTENSIONS}" == "ON" ]]; then
+    BUILD_BE_JAVA_EXTENSIONS=0
 fi
 
 echo "Get params:
@@ -385,7 +385,7 @@ echo "Get params:
     BUILD_AUDIT         -- ${BUILD_AUDIT}
     BUILD_META_TOOL     -- ${BUILD_META_TOOL}
     BUILD_SPARK_DPP     -- ${BUILD_SPARK_DPP}
-    BUILD_JAVA_UDF      -- ${BUILD_JAVA_UDF}
+    BUILD_BE_JAVA_EXTENSIONS      -- ${BUILD_BE_JAVA_EXTENSIONS}
     BUILD_HIVE_UDF      -- ${BUILD_HIVE_UDF}
     PARALLEL            -- ${PARALLEL}
     CLEAN               -- ${CLEAN}
@@ -424,14 +424,18 @@ if [[ "${BUILD_SPARK_DPP}" -eq 1 ]]; then
     modules+=("fe-common")
     modules+=("spark-dpp")
 fi
-if [[ "${BUILD_JAVA_UDF}" -eq 1 ]]; then
-    modules+=("fe-common")
-    modules+=("java-udf")
-fi
 if [[ "${BUILD_HIVE_UDF}" -eq 1 ]]; then
     modules+=("fe-common")
     modules+=("hive-udf")
 fi
+if [[ "${BUILD_BE_JAVA_EXTENSIONS}" -eq 1 ]]; then
+    modules+=("fe-common")
+    modules+=("be-java-extensions/hudi-scanner")
+    modules+=("be-java-extensions/java-common")
+    modules+=("be-java-extensions/java-udf")
+    modules+=("be-java-extensions/jdbc-scanner")
+    modules+=("be-java-extensions/paimon-scanner")
+fi
 FE_MODULES="$(
     IFS=','
     echo "${modules[*]}"
@@ -596,11 +600,11 @@ if [[ "${OUTPUT_BE_BINARY}" -eq 1 ]]; then
         rm -rf "${DORIS_OUTPUT}/be/lib/hadoop_hdfs/native/"
     fi
 
-    if [[ "${DISABLE_JAVA_UDF_IN_CONF}" -eq 1 ]]; then
+    if [[ "${BUILD_BE_JAVA_EXTENSIONS_IN_CONF}" -eq 1 ]]; then
         echo -e "\033[33;1mWARNNING: \033[37;1mDisable Java UDF support in be.conf due to the BE was built without Java UDF.\033[0m"
         cat >>"${DORIS_OUTPUT}/be/conf/be.conf" <<EOF
 
-# Java UDF support
+# Java UDF and BE-JAVA-EXTENSION support
 enable_java_support = false
 EOF
     fi
@@ -626,11 +630,16 @@ EOF
     if [[ "${STRIP_DEBUG_INFO}" = "ON" ]]; then
         cp -r -p "${DORIS_HOME}/be/output/lib/debug_info" "${DORIS_OUTPUT}/be/lib"/
     fi
-
-    java_udf_path="${DORIS_HOME}/fe/java-udf/target/java-udf-jar-with-dependencies.jar"
+    # java udf
+    java_udf_path="${DORIS_HOME}/fe/be-java-extensions/java-udf/target/java-udf-jar-with-dependencies.jar"
     if [[ -f "${java_udf_path}" ]]; then
         cp "${java_udf_path}" "${DORIS_OUTPUT}/be/lib"/
     fi
+    # jdbc scanner
+    jdbc_scanner_path="${DORIS_HOME}/fe/be-java-extensions/jdbc-scanner/target/jdbc-scanner-jar-with-dependencies.jar"
+    if [[ -f "${jdbc_scanner_path}" ]]; then
+        cp "${jdbc_scanner_path}" "${DORIS_OUTPUT}/be/lib"/
+    fi
 
     cp -r -p "${DORIS_THIRDPARTY}/installed/webroot"/* "${DORIS_OUTPUT}/be/www"/
     copy_common_files "${DORIS_OUTPUT}/be/"
@@ -659,12 +668,12 @@ if [[ "${BUILD_AUDIT}" -eq 1 ]]; then
     cd "${DORIS_HOME}"
 fi
 
-if [[ "${BUILD_JAVA_UDF}" -eq 1 && "${BUILD_BE}" -eq 0 && "${BUILD_FE}" -eq 0 ]]; then
+if [[ "${BUILD_BE_JAVA_EXTENSIONS}" -eq 1 && "${BUILD_BE}" -eq 0 && "${BUILD_FE}" -eq 0 ]]; then
     install -d "${DORIS_OUTPUT}/be/lib"
 
     rm -rf "${DORIS_OUTPUT}/be/lib/java-udf-jar-with-dependencies.jar"
 
-    java_udf_path="${DORIS_HOME}/fe/java-udf/target/java-udf-jar-with-dependencies.jar"
+    java_udf_path="${DORIS_HOME}/fe/be-java-extensions/java-udf/target/java-udf-jar-with-dependencies.jar"
     if [[ -f "${java_udf_path}" ]]; then
         cp "${java_udf_path}" "${DORIS_OUTPUT}/be/lib"/
     fi

diff --git a/docs/en/docs/faq/install-faq.md b/docs/en/docs/faq/install-faq.md
@@ -298,8 +298,8 @@ If the output contains ``libssl.so.10``, there may be problems using it, if it c
 <version since="1.2"> Java UDF dependency error </version>
 If the upgrade support starts be, the following Java `NoClassDefFoundError` error occurs
 ```
-Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/doris/udf/IniUtil
-Caused by: java.lang.ClassNotFoundException: org.apache.doris.udf.JniUtil
+Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/doris/common/jni/utils/JniUtil
+Caused by: java.lang.ClassNotFoundException: org.apache.doris.common.jni.utils.JniUtil
 ```
 You need to download the Java UDF function dependency package of `apache-doris-java-udf-jar-with-dependencies-1.2.0` from the official website, put it in the lib directory under the BE installation directory, and then restart BE
 

diff --git a/docs/zh-CN/docs/faq/install-faq.md b/docs/zh-CN/docs/faq/install-faq.md
@@ -300,8 +300,8 @@ ldd /path/to/libmyodbc8w.so |grep libssl.so
 如果升级后启动 be 出现下面这种 Java `NoClassDefFoundError` 错误
 
 ```
-Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/doris/udf/JniUtil
-Caused by: java.lang.ClassNotFoundException: org.apache.doris.udf.JniUtil
+Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/doris/common/jni/utils/JniUtil
+Caused by: java.lang.ClassNotFoundException: org.apache.doris.common.jni.utils.JniUtil
 ```
 需要从官网下载 `apache-doris-java-udf-jar-with-dependencies-1.2.0` 的 Java UDF 函数依赖包，放到 BE 安装目录下的 lib 目录，然后重新启动 BE