Android-JNI-動(dòng)態(tài)庫的函數(shù)注冊(cè)

時(shí)光荏苒，距離上次的文章已經(jīng)3年多了。那這3年干啥了呢？平凡生活，在人間湊數(shù)。

來吧，展示！show me you code

在Linux平臺(tái)下so庫分為動(dòng)態(tài)庫和靜態(tài)庫。表現(xiàn)形式以.so為后綴動(dòng)態(tài)庫和.a為后綴的靜態(tài)庫。關(guān)于這2個(gè)的有關(guān)知識(shí)這里不過多介紹，不是我們今天的重點(diǎn)。

在動(dòng)態(tài)庫里函數(shù)注冊(cè)分為2種：靜態(tài)注冊(cè)和動(dòng)態(tài)注冊(cè)。

靜態(tài)注冊(cè)

靜態(tài)注冊(cè)，你工作如果是與jni打交道。我們平時(shí)寫的，寫一個(gè)jni方法和它對(duì)應(yīng)的頭文件（方法名，參數(shù)進(jìn)行對(duì)應(yīng)）。調(diào)用的時(shí)候，這個(gè)調(diào)用的過程就是靜態(tài)注冊(cè)。
但是這個(gè)調(diào)用的過程有一個(gè)查找（根據(jù)方法名，方法唯一簽名）的步驟，這個(gè)查找的過程就是耗時(shí)的過程。還有一個(gè)原因是如果包名改變，那對(duì)應(yīng)jni層的方法的名字也得改，這個(gè)是很繁瑣的。
因此有了動(dòng)態(tài)注冊(cè)。

先看一下平時(shí)寫jni的靜態(tài)注冊(cè)，方法名必須是Java_java類全名_方法名，java類全名的.用_替換，不過目前的as可以自動(dòng)生成,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

動(dòng)態(tài)注冊(cè)

動(dòng)態(tài)注冊(cè)，在jni中提供了這種機(jī)制。在<jni.h>這個(gè)頭文件中提供了如下2個(gè)方法聲明。

/*
 * 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);

注釋大概意思就是：當(dāng)系統(tǒng)加載動(dòng)態(tài)庫的時(shí)候（在java中就是System.loadLibrary()）由JNI調(diào)用。
如何實(shí)現(xiàn)呢？ 在jni中我們可以復(fù)寫這2個(gè)方法,有點(diǎn)類似java語言的子類復(fù)寫父類的方法的感覺。嘿嘿，什么都是靠感覺。
當(dāng)然一些初始化的工作你也可以在這里來做。

復(fù)寫第一個(gè)方法可以把我們自己的方法注冊(cè)到系統(tǒng)中去，然后在jni層直接調(diào)用即可，不用按照靜態(tài)注冊(cè)的規(guī)則來寫了。
復(fù)寫第二個(gè)方法可以把我們自己的方法/jni進(jìn)行解注冊(cè)

如何注冊(cè)呢 ？ 主要是jni頭文件的

jint RegisterNatives(jclass clazz, const JNINativeMethod* methods,
        jint nMethods) 
 參數(shù)1:對(duì)應(yīng)java類的native的方法聲明的類
 參數(shù)2:JNINativeMethod結(jié)構(gòu)體數(shù)組，java類native方法和jni方法的映射關(guān)系
 參數(shù)3:注冊(cè)了的方法的個(gè)數(shù)

主要是參數(shù)2，它的結(jié)構(gòu)體如下：

typedef struct {
   const char* name;   //java類native方法的名字，不帶包的路徑
   const char* signature; //java類native方法的簽名，字符串表示
   void*       fnPtr;//void*類型的函數(shù)指針，映射到j(luò)ni層的方法名字
} JNINativeMethod;

ok，我們把常規(guī)的寫法（靜態(tài)注冊(cè)）的stringFromJNI和sum進(jìn)行改造，聲明一個(gè)JNINativeMethod的結(jié)構(gòu)體數(shù)組并進(jìn)行映射。

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

關(guān)于方法的簽名都是固定的規(guī)則，如果你怕寫錯(cuò)也可以用javap -s class文件命令查看，如下：

方法簽名.png

getString和add方法具體實(shí)現(xiàn)為：

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個(gè)參數(shù)。第3個(gè)參數(shù)我們動(dòng)態(tài)注冊(cè)了2個(gè)方法傳2即可。 我們?cè)賮砜吹谝粋€(gè)參數(shù)jclass。
如果獲取jclass呢，就是通過java_cls = env->FindClass(JAVA_CLASS)常見的這個(gè)方法即可JAVA_CLASS就是在java中聲明native方法類的全名，我的demo里是:com/bj/gxz/jniapp/JNIMethodDynamic

那JNIEnv *env怎么獲取呢？

備注：因?yàn)槲覀儧]有從頭開始將jni的一些知識(shí)，這里簡(jiǎn)單說一些JNIEnv *env,它是一個(gè)結(jié)構(gòu)體指針,它指向可用JNI函數(shù)表的接口指針，提供了一些JNI系統(tǒng)函數(shù)

在JNI_OnLoad的系統(tǒng)方法中的第一個(gè)參數(shù)中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;
    }
    // ...
}

到此，注冊(cè)已經(jīng)完成了。
如何解注冊(cè)呢 ？
復(fù)寫系統(tǒng)的JNI_OnUnload方法，調(diào)用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);
    }
}

完事，我們寫個(gè)demo測(cè)試一下：

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