Android NDK开发系列教程6：JNI函数注册（JNI_OnLoad）

在使用native方法前都会先加载该native方法的so文件，通常在一个类的静态代码块中进行加载，当然也可以在构造函数，或者调用前加载。jvm在加载so时都会先调用so中的JNI_OnLoad函数，如果你没有重写该方法，那么系统会给你自动生成一个。JNI_OnLoad方法的调用顺序可以参考我的另一篇博文：JNI_OnLoad调用时机，下面我们可以在该方法中对自己的函数进行注册。这就很爽了，jni默认的那个方法命名又臭又长，改的时候不注意还可能该错。现在我们可以定义自己的函数名称，只需要在JNI_OnLoad中注册下对应的映射。在Google官网也有介绍：https://developer.android.com/training/articles/perf-jni.html

1. JNI_OnLoad简介

在编写JNI方法时有两种方法：一种是标准的通过javah生成头文件，然后自己实现对应的cpp文件，这种办法也是官方推荐的。还有一种方法是在JNI_OnLoad函数中进行函数映射，将java里面的方法映射到自己实现的方法。
​
当Android的DVM(Virtual Machine)执行到C组件里的System.loadLibrary()函数时，首先会去执行C组件里的JNI_OnLoad()函数。它的用途有二：
1. 告诉VM此C组件使用那一个JNI版本。
如果你的*.so档没有提供JNI_OnLoad()函数，VM会默认该*.so档是使用最老的JNI 1.1版本。
由于新版的JNI做了许多扩充，如果需要使用JNI的新版功能，
例如JNI 1.4的java.nio.ByteBuffer,就必须藉由JNI_OnLoad()函数来告知VM。
2. 由于VM执行到System.loadLibrary()函数时，就会立即先呼叫JNI_OnLoad()， 所以C组件的开发者可以藉由JNI_OnLoad()来进行C组件内的初期值之设定(Initialization) 。
3. 在so被成功卸载时，会回调另一个JNI方法：JNI_UnOnLoad。这两个方法声明如下：

JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void* reserved);
JNIEXPORT void JNICALL JNI_OnUnload(JavaVM* vm, void* reserved);

其中第一个参数vm表示DVM虚拟机，该vm在应用进程中仅有一个，可以保存在native的静态变量中，供其他函数或其他线程使用。其返回值表示当前需要native library需要的版本。

2. 举个栗子

首先在Java中写好native方法：

    //JNI_OnLoads使用实例
    public native void jniOnLoadTest();
    public native String jniOnload1(Person person);

然后编写对应的native方法

//空方法可以不用传任何字段
//也可以传这两个参数：void onLoadTest(JNIEnv*env,jobject obj);两个参数含义和用javah生成的一致。
void onLoadTest() {
    LOGE("调到我啦");
}
//如果有参数，那么需要加上前面两个参数，不然会导致参数不对应。参数含义和javah生成的头文件中参数含义一致。
jstring onloadTest1(JNIEnv *env, jobject instance, jobject obj) {
    jclass pCls = env->GetObjectClass(obj);
    jfieldID nameFid = env->GetFieldID(pCls, "name", "Ljava/lang/String;");
    jstring name = (jstring) env->GetObjectField(obj, nameFid);
    char *cname = jstringToChar(env, name);
    char *tmp = new char[100];
    sprintf(tmp, "我来自Native，我叫：%s", cname);
    jstring result = charTojstring(env, tmp);
    return result;
}

然后在JNI_OnLoad中注册改函数映射

//注册函数映射
JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void* reserved) {
    JNIEnv *pEnv = NULL;
    //获取环境
    jint ret = vm->GetEnv((void**) &pEnv, JNI_VERSION_1_6);
    if (ret != JNI_OK) {
        LOGE("jni_replace JVM ERROR:GetEnv");
        return -1;
    }
    //在{}里面进行方法映射编写，第一个是java端方法名，第二个是方法签名，第三个是c语言形式签名（括号内表示方法返回值）
    JNINativeMethod g_Methods[] = {{"jniOnLoadTest", "()V", (void*) onLoadTest},
                                   {"jniOnload1", "(Lzqc/com/example/Person;)Ljava/lang/String;", (jstring*)onloadTest1}
    };
    jclass cls = pEnv->FindClass("zqc/com/example/NativeTest");
    if (cls == NULL) {
        LOGE("FindClass Error");
        return -1;
    }
    //动态注册本地方法
    ret = pEnv->RegisterNatives(cls, g_Methods,sizeof(g_Methods) / sizeof(g_Methods[0]));
    if (ret != JNI_OK) {
        LOGE("Register Error");
        return -1;
    }
    //返回java版本
    return JNI_VERSION_1_6;
}

其中JNINativeMethod的结构如下：

typedef struct {  
    const char* name;     // java层对应的方法名称  
    const char* signature;// 该方法的返回值类型和参数类型  
    void*       fnPtr;    // native中对应的函数指针  
} JNINativeMethod;  

    //注册本地方法,第一个是方法对应的类，第二个是方法映射，第三个是映射方法的个数
    jint RegisterNatives(jclass clazz, const JNINativeMethod* methods,
        jint nMethods)
    { return functions->RegisterNatives(this, clazz, methods, nMethods); }

通过以上方法就可以实现方法映射，而不用遵循原有的命名规则。

3. 总结

JNI_OnLoad是加载so时最先调用的方法，而且该方法会把JavaVM* vm指针传过来，这样在native就可以保存该指针，该指针在整个应用进程中仅有一个，可以跨线程使用。我们通过在该方法中注册函数映射，当然也可以在该方法中做其他操作。比如我们可以在该方法中进行版本校验，也可以校验当前调用该so的应用是否合乎要求。