JNI函数注册

JNI 函数注册

基本概念

函数注册简单来理解就是将 Java 层的函数和 native 层的函数一一对应起来。

种类

函数注册分为两种方式：

1. 静态注册
2. 动态注册

静态注册

• 在 Java 层使用 native 关键字描述函数

public class Utils {
    public static native int add(int a, int b);
}

• 根据在 Utils 类编写的 add 函数生成对应的 native 函数。

//javah 是 jdk 提供的一个工具
//在终端使用 cd 切换到 Utils 编译后的文件目录下，具体位置看下面的截图，不要搞错地方，否则会出现找不到Utils类
//-o Utils.h 表示输出的文件名为 Utils.h
javah -o Utils.h com.zeal.ndkdemo.Utils

image

• 生成对应的 Utils.h 文件

/* DO NOT EDIT THIS FILE - it is machine generated */
#include 
/* Header for class com_zeal_ndkdemo_Utils */

#ifndef _Included_com_zeal_ndkdemo_Utils
#define _Included_com_zeal_ndkdemo_Utils
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     com_zeal_ndkdemo_Utils
 * Method:    add
 * Signature: (II)I
 */
JNIEXPORT jint JNICALL Java_com_zeal_ndkdemo_Utils_add
  (JNIEnv *, jclass, jint, jint);

#ifdef __cplusplus
}
#endif
#endif

• 将 Utils.h 文件拷贝到存放 native 代码的文件夹中

我的工程存放 native 代码的目录是 main/cpp/
所以将生成 Utils.h 拷贝到 main/cpp 即可

• 编写 native 层的代码，我将其命名为 test.c

//引入刚才生成的 Utils.h 文件
#include "Utils.h"
#include  
//将 Utils.h 生成函数拷贝到test.c 中
//注意拷贝过来的函数是不完整的，需要手动添加参数变量名
JNIEXPORT jint JNICALL Java_com_zeal_ndkdemo_Utils_add
        (JNIEnv *env, jclass obj, jint a, jint b) {
   //返回计算结果
   return a + b;
}

• 接下来就在 java 层代码加载 so 库，并且调用该方法即可，这一步就忽略不写。

动态注册

为什么有了静态注册之后还要有一个动态注册的功能呢？

我们看到了，在静态注册中，我们使用了 javah 生成对应 native 函数，可以看出它的方法名是非常的长的，因此为了简化这个方法的表示，就有了动态注册。

• 在 Java 层使用 native 关键字描述函数

public class Utils {
    public static native int add(int a, int b);
}

• 在哪里告诉系统我要动态注册函数呢？

我们都知道 java 想要调用 c 层的代码，主要分 2 步：

1. System.loadLibrary("so name");

2. 调用对应的 native 代码
   int result = Utlils.add(1,2);

现在我们需要找到一个时机告诉系统，我要动态注册函数，并且告诉系统怎么动态注册。

而系统在执行完 System.loadLibrary("..")之后会执行 native 层的 JNI_Onload 方法，因此我们只需要在该方法完成动态注册即可。

• 在 JNI_Onload 函数动态注册

想要进行动态注册，就必须要有一个 java 层函数和 native 函数的对应关系表。

在 jni 中是使用 JNINativeMethod 来保存对应关系

typedef struct {
    char *name;//
    char *signature;
    void *fnPtr;
} JNINativeMethod;

编写对应关系表
method_table 是一个数组，它存放就是 JNINativeMethod 定义的三个属性参数。

1. name java 层的方法名
2. signature 方法的签名
3. fnPtr 对应的 native 的方法名

//下面这段代码的表示就是将 java 层的 add 方法映射
//到 native 层的 add 方法，不再是静态注册那种很长的方法名了。
static JNINativeMethod method_table[] = {
{
"add", "(II)I",(void *) add}
};

有了对应关系表 method_table 之后，我们就要开始注册了。下面的 JNI_Onload 方法就是对 method_table 表进行动态注册。

/**
 * 动态注册
 * 在 native 代码中重写该 JNI_Onload 方法即可
 */
JNIEXPORT jint JNI_OnLoad(JavaVM *vm, void *reserved) {
    //OnLoad方法是没有JNIEnv参数的，需要通过vm获取。
    JNIEnv *env = NULL;
    jint result = -1;

    if ((*vm)->GetEnv(vm, (void **) &env, JNI_VERSION_1_4) != JNI_OK) {
        return -1;
    }
    //获取对应声明native方法的Java类
    jclass clazz = (*env)->FindClass(env, "com/zeal/ndkdemo/Utils");
    if (clazz == NULL) {
        return JNI_FALSE;
    }
    //注册方法，成功返回正确的JNIVERSION。
    if ((*env)->RegisterNatives(env, clazz, method_table,
                                sizeof(method_table) / sizeof(method_table[0])) == JNI_OK) {
        return JNI_VERSION_1_4;
    }
    return JNI_FALSE;
}