Android-JNI开发系列《一》动态库的函数注册

Android-JNI-动态库的函数注册

时光荏苒，距离上次的文章已经3年多了。那这3年干啥了呢？平凡生活，在人间凑数。

来吧，展示！show me you code

在Linux平台下so库分为动态库和静态库。表现形式以.so为后缀动态库和.a为后缀的静态库。关于这2个的有关知识这里不过多介绍，不是我们今天的重点。

在动态库里函数注册分为2种：静态注册和动态注册。

静态注册

静态注册，你工作如果是与jni打交道。我们平时写的，写一个jni方法和它对应的头文件（方法名，参数进行对应）。调用的时候，这个调用的过程就是静态注册。
但是这个调用的过程有一个查找（根据方法名，方法唯一签名）的步骤，这个查找的过程就是耗时的过程。还有一个原因是如果包名改变，那对应jni层的方法的名字也得改，这个是很繁琐的。
因此有了动态注册。

先看一下平时写jni的静态注册，方法名必须是Java_java类全名_方法名，java类全名的.用_替换，不过目前的as可以自动生成,nice。

比如：

// JNIMethodDynamic.java
package com.bj.gxz.jniapp;
public class JNIMethodDynamic {
    // Used to load the 'native-lib' library on application startup.
    static {
        System.loadLibrary("native-lib");
    }
    /**
     * A native method that is implemented by the 'native-lib' native library,
     * which is packaged with this application.
     */
    public native String stringFromJNI();

    public native int sum(int x, int y);
}

// jni_method_dynamic.cpp
#if 0
extern "C" JNIEXPORT jstring JNICALL
Java_com_bj_gxz_jniapp_JNIMethodDynamic_stringFromJNI(
        JNIEnv *env,
        jobject thiz) {
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());
}

extern "C"
JNIEXPORT jint JNICALL
Java_com_bj_gxz_jniapp_JNIMethodDynamic_sum(JNIEnv *env, jobject thiz, jint x, jint y) {
    return x + y;
}
#else
#endif

动态注册

动态注册，在jni中提供了这种机制。在<jni.h>这个头文件中提供了如下2个方法声明。

/*
 * Prototypes for functions exported by loadable shared libs.  These are
 * called by JNI, not provided by JNI.
 */
JNIEXPORT jint JNI_OnLoad(JavaVM* vm, void* reserved);
JNIEXPORT void JNI_OnUnload(JavaVM* vm, void* reserved);

注释大概意思就是：当系统加载动态库的时候（在java中就是System.loadLibrary()）由JNI调用。
如何实现呢？在jni中我们可以复写这2个方法,有点类似java语言的子类复写父类的方法的感觉。嘿嘿，什么都是靠感觉。
当然一些初始化的工作你也可以在这里来做。

复写第一个方法可以把我们自己的方法注册到系统中去，然后在jni层直接调用即可，不用按照静态注册的规则来写了。
复写第二个方法可以把我们自己的方法/jni进行解注册

如何注册呢？主要是jni头文件的

jint RegisterNatives(jclass clazz, const JNINativeMethod* methods,
        jint nMethods) 
 参数1:对应java类的native的方法声明的类
 参数2:JNINativeMethod结构体数组，java类native方法和jni方法的映射关系
 参数3:注册了的方法的个数

主要是参数2，它的结构体如下：

typedef struct {
   const char* name;   //java类native方法的名字，不带包的路径
   const char* signature; //java类native方法的签名，字符串表示
   void*       fnPtr;//void*类型的函数指针，映射到jni层的方法名字
} JNINativeMethod;

ok，我们把常规的写法（静态注册）的stringFromJNI和sum进行改造，声明一个JNINativeMethod的结构体数组并进行映射。

JNINativeMethod gMethods[] = {
       {"stringFromJNI", "()Ljava/lang/String;", (void *) getString},
       {"sum",           "(II)I",                (void *) add}
};

关于方法的签名都是固定的规则，如果你怕写错也可以用javap -s class文件命令查看，如下：

方法签名.png

getString和add方法具体实现为：

jstring getString(JNIEnv *env, jobject thiz) {
    return env->NewStringUTF("Hello from C++");
}
jint add(JNIEnv *env, jobject thiz, jint x, jint y) {
    return x + y;
}

嗯，至此我们完成了第2个参数。第3个参数我们动态注册了2个方法传2即可。我们再来看第一个参数jclass。
如果获取jclass呢，就是通过java_cls = env->FindClass(JAVA_CLASS)常见的这个方法即可JAVA_CLASS就是在java中声明native方法类的全名，我的demo里是:com/bj/gxz/jniapp/JNIMethodDynamic

那JNIEnv *env怎么获取呢？

备注：因为我们没有从头开始将jni的一些知识，这里简单说一些JNIEnv *env,它是一个结构体指针,它指向可用JNI函数表的接口指针，提供了一些JNI系统函数

在JNI_OnLoad的系统方法中的第一个参数中JavaVM *vm可以获取到JNIEnv，

JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *vm, void *reserved) {
    JNIEnv *env;
    if (vm->GetEnv(reinterpret_cast<void **>(&env), JNI_VERSION_1_6) != JNI_OK) {
        return JNI_ERR;
    }
    // ...
}

到此，注册已经完成了。
如何解注册呢？
复写系统的JNI_OnUnload方法，调用UnregisterNatives即可。

JNIEXPORT void JNI_OnUnload(JavaVM *vm, void *reserved) {
    JNIEnv *env;
    if (vm->GetEnv(reinterpret_cast<void **>(&env), JNI_VERSION_1_6) != JNI_OK) {
        return;
    }
    jclass java_cls = env->FindClass(JAVA_CLASS);
    if (java_cls != nullptr) {
        jint ret = env->UnregisterNatives(java_cls);
        LOG_D("JNI_OnUnload Call ret=%d=", ret);
    }
}

完事，我们写个demo测试一下：

public class MainActivity extends AppCompatActivity {

    private JNIMethodDynamic jniMethodDynamic = new JNIMethodDynamic();

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        TextView tv = findViewById(R.id.sample_text);
        tv.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                Log.d("jni", "stringFromJNI:" + jniMethodDynamic.stringFromJNI());
                Log.d("jni", "sum:" + jniMethodDynamic.sum(1, 2));
            }
        });
    }
}

输出

09-19 05:26:51.986 2106-2106/com.bj.gxz.jniapp D/JNI: JNI_OnLoad Call ret=1
09-19 05:27:12.590 2106-2106/com.bj.gxz.jniapp D/JNI: stringFromJNI:Hello from C++
09-19 05:27:12.590 2106-2106/com.bj.gxz.jniapp D/JNI: sum:3

代码地址
https://github.com/ta893115871/JNIAPP