Kotlin/Java JNI方法的两种注册方法

最近在处理基于 JNI 算法C++库的对接问题，除了翻阅一次《JNI API完全手册》外，还拓展了一些内容，增强对 JNI 内容的理解

当前环境是 macOS 10.15.7, AS 4.1, Android SDK, NDK 21.2.6528147, Cmake 3.10.2

一 JNI 方法注册的两种方法

1.1 生成 Java/Kotlin类对应的头文件

首先需要安装 jdk 的工具包（并配置系统变量环境）

java 文件生成JNI头文件

javac

$javac -encoding utf8 -h targetDir sourceFile
// 比如：$javac -encoding utf8 -h ./ Test.java
// -encoding：指定 Test.java 的编码
// -h：指定头文件输出目录
// 最后参数是源文件文件

javah

$javah -d targetDir  -classpath . 包路径+类名（类名不包含文件后缀名）
// $javah -d . -classpath . com.xx.xx.JniBridge1
// com.xx.xx 为文件夹的路径，也就是 cd 到 com 那个同级的目录，然后执行指令
// -d：指定输出目录 . 表示输出到当前目录
// -classpath：指定类的路径

kotlin 文件生成JNI头文件

配置 kotlinc 到环境路径，macOS 环境下，可能需要增加一下可执行权限（最好是备份），然后配置到Path

将 .kt 文件编译成 .class
AS kotlin 插件的位置 xxx/AndroidStudio4.1/plugins/Kotlin/kotlinc/bin

然后执行指令编译 xx1.kt 和 xx2.kt，然后输出到桌面的 xxx 文件夹的 xx1.class xx2.class
kotlinc -cp "xxx/Library/Android/sdk/platforms/android-30/android.jar" ~/Desktop/xx/xx1.kt ~/Desktop/xx/xx2.kt -d ~/Desktop/xxx
-d: 指定输出目录
-cp: 指定其它类的路径（比如 Log, String等等的类，都在android.jar中，如果不添加这个，可能会报 Log 等符号找不到）

或者AS项目中，查找 .kt 编译成的 .class 的目录 build/tmp/kotlin-classes/debug/

然后使用上面javah指令对 .class 生成JNI头文件

完成所生成头文件对应的 .cpp

按业务需要实现头文件方法 Java_com_xx_xx_xxClass_xxMethod ，然后在 CMakeLists.txt 文件中增加 .cpp 为动态库源码，并在Java代码中调用 System.loadLibrary("native-lib") 加载动态库，编译项目并运行。

至此，完成了第一种方法注册。

注意：

Java 的 static 方法，对应的JNI方法的第二个参数为 jclass 类型
Kotlin 的 companion object 中的方法，生成后，都会由一个前缀 _00024Companion，这是因为 companion object 属于该类的一个内部类 Companion，java/kotlin 编译后，内部类使用 $ 符号和外部类连接，形式为：Outter$Companion,而 $的unicode为0024,_0 在JNI API中定义为unicode转义符，所以：$Companion 使用 _00024Companion 来表示

1.2 在 JNI_OnLoad 时 RegisterNatives

实现 jni.h 文件中的 JNI_OnLoad 方法

// c++ static 限定变量的作用范围
// java的权限定类名：用 _ 代替 .
static const char *const jniBridgeClsName = "com/anter/cmakepractice/jni/JniBridge";
static jclass jniBridgeCls;
// java/kotlin类和C++方法类对应关系
// 比如 java/kotlin 的 stringFromJni 对应 C++ 的 stringFromJni 
// 这里 java/kotlin 和 C++ 的方法名字可以是不同的，只要中间的方法签名保持一致便可！
static JNINativeMethod jniBridgeMethods[] = {
        {"stringFromJni", "()Ljava/lang/String;",                                          (jbyteArray *) stringFromJni},
        {"classMethod",   "(Ljava/lang/String;)Lcom/anter/cmakepractice/entity/FaceInfo;", (jbyteArray *) classMethod},
        {"exceptionTest", "()V",                                                           (jbyteArray *) exceptionTest},
        {"arrayTest",     "([I)V",                                                         (jbyteArray *) arrayTest},
        // 如果 java 的静态方法，或者 kotlin 使用 @JvmStatic 注释的方法，可以直接这么写
        // {"staticMethod", "(Ljava/lang/String;)Ljava/lang/String;", (jbyteArray *) staticMethod}
};

// 加载 kotlin 中 companion object {} 中的方法
// 这里其实就类似与内部类的方式加载
static const char *const jniBridgeClsName1 = "com/anter/cmakepractice/jni/JniBridge$Companion";
static jclass jniBridgeCls1;
static JNINativeMethod jniBridgeMethods1[] = {
        {"staticMethod", "(Ljava/lang/String;)Ljava/lang/String;", (jbyteArray *) staticMethod}
};

// 在 System.loadLibrary("xxx.so ") 时调用
JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *vm, void *reserved) {
    //注册时在JNIEnv中实现的，所以必须首先获取它
    JNIEnv *env = nullptr;
    jint result = -1;
    //从JavaVM获取JNIEnv，一般使用1.4的版本
    if (vm->GetEnv((void **) &env, JNI_VERSION_1_4) != JNI_OK) {
        return result;
    }
    jniBridgeCls = env->FindClass(jniBridgeClsName);
    if (jniBridgeCls == nullptr) {
        log_v(LOG_DEFAULT_TAG, "JNI_OnLoad: cannot get class: %s", jniBridgeClsName);
        return result;
    }
    jint jniBridgeClsMethodSize = sizeof(jniBridgeMethods) / sizeof(jniBridgeMethods[0]);
    // 通过RegisterNatives方法动态注册登记
    if (env->RegisterNatives(jniBridgeCls, jniBridgeMethods, jniBridgeClsMethodSize) < 0) {
        log_v(LOG_DEFAULT_TAG, "JNI_OnLoad: register method failed!");
        return result;
    }

    jniBridgeCls1 = env->FindClass(jniBridgeClsName1);
    jint jniBridgeClsMethodSize1 = sizeof(jniBridgeMethods1) / sizeof(jniBridgeMethods1[0]);
    // 通过RegisterNatives方法动态注册登记
    if (env->RegisterNatives(jniBridgeCls1, jniBridgeMethods1, jniBridgeClsMethodSize1) < 0) {
        log_v(LOG_DEFAULT_TAG, "JNI_OnLoad: register method failed!");
        return result;
    }
    log_v(LOG_DEFAULT_TAG, "JNI_OnLoad: register method success.");
     // 必须返回版本，否则加载会失败。
    return JNI_VERSION_1_4;
}

按业务需要实现头文件C++的方法，然后在 CMakeLists.txt 文件中增加 .cpp 为动态库源码，并在Java/Kotlin代码中调用 System.loadLibrary("native-lib") 加载动态库，编译项目并运行。

至此，完成了第二种方法注册。

参考链接：
https://juejin.im/post/6844903985111908359
https://stackoverflow.com/questions/49554430/how-to-declare-native-cpp-method-for-which-declared-in-kotlin-companion-object
https://yalantis.com/blog/android-ndk-the-interaction-between-kotlin-and-c-c-plus-plus/