Java 代碼調(diào)用 C++ 函數(shù)

小伙伴們制作了一款獨(dú)具創(chuàng)意的Android應(yīng)用非春，只可惜這個(gè)應(yīng)用某些模塊的運(yùn)行效率非常低菩收。一個(gè)自然的想法是，使用 C++ 重寫那些已然成為性能拖油瓶的模塊。那么現(xiàn)在問(wèn)題來(lái)了重虑，我們?cè)趺床拍軓?Java 代碼里面調(diào)用 C++ 函數(shù)呢蝇裤？

通過(guò)查閱文檔廷支，小伙伴們找到了合適的方案频鉴。Java 給我們提供了一組簡(jiǎn)單的接口（Java Native Interface, JNI），允許我們?cè)?Java 應(yīng)用程序中加載和使用動(dòng)態(tài)共享庫(kù)恋拍。

首先垛孔，在 Java 的類中聲明 Native 方法。Native 方法和普通方法的聲明方式一致施敢，只是多了一個(gè) native 關(guān)鍵字：

// Dog.java
package com.example;

public class Dog {
    public native void speak();
    public native int getAge();
}

Native 方法只聲明周荐，不定義，具體的實(shí)現(xiàn)在 C++ 動(dòng)態(tài)共享庫(kù)中

應(yīng)用啟動(dòng)后僵娃，在合適的時(shí)機(jī)載入動(dòng)態(tài)共享庫(kù)概作。假設(shè)共享庫(kù)名為 libCppModule.so：

// Dog.java
package com.example;

public class Dog {
    // ...

    static {
        System.loadLibrary("CppModule");
    }
}

注意如果模塊的名稱為“l(fā)ibxxx”，在載入的時(shí)候要省略掉“l(fā)ib”默怨，只填入"xxx"讯榕。

對(duì) libCppModule 中所有的公有接口，我們都必須按照下面的規(guī)則加以封裝：

// Dog.cpp
extern "C" {

JNIEXPORT
jint JNICALL Java_com_example_Dog_getAge(JNIEnv* env, jobject thiz)
{
    return 7;
}

JNIEXPORT
void JNICALL Java_com_example_Dog_speak(JNIEnv* env, jobject thiz)
{
    // Do something.
}

}

至此匙睹，小伙伴們感慨道：美好的生活又回來(lái)了!

C++ 代碼調(diào)用 Java 方法

既然 Java 調(diào)用 C++ 函數(shù)是如此的簡(jiǎn)單愚屁，那么反過(guò)來(lái)，在 C++ 中使用 Java 某個(gè)類的方法是不是也行得通呢垃僚？

當(dāng)然也是可以的集绰！小伙伴們動(dòng)手做了一番嘗試，把具體的步驟紀(jì)錄在了下面谆棺。

第一步栽燕，在類中定義希望被 C++ 調(diào)用的方法为肮，必須是靜態(tài)方法：

// Dog.java
package com.example;

public class Dog {

    // This method is intended to be called by C++
    public static void echo(String msg) {
        Log.i("Dog", "Echo message: " + msg);
    }
}

第二步赤屋，從 C++ 代碼中調(diào)用上面定義的 echo 方法：

// Dog.cpp
void dog_echo() {
    // 取得 JNIEnv 實(shí)例
    JNIEnv *env = ...

    // 1. 找到目標(biāo)類
    jclass _class = env->FindClass("com/example/Dog");

    // 2. 找到目標(biāo)方法
    jmethodId method = env->GetStaticMethodID(_class, "echo", "(Ljava/lang/String;)V");

    // 3. 調(diào)用該方法
    env->CallStaticVoidMethod(_class, method, "I'm a foo");

    // 4. 釋放局部引用
    env->DeleteLocalRef(_class)
}

注意，JNIEnv 的實(shí)例只在當(dāng)前線程中有效擎厢。

如果你使用的是 C 語(yǔ)言朵夏，那么語(yǔ)法將稍有不同：

// Dog.c
void dog_echo() {
    // 取得 JNIEnv 實(shí)例
    JNIEnv *env = ...

    // 1. 找到目標(biāo)類
    jclass _class = (*env)->FindClass(env, "com/example/Dog");

    // 2. 找到目標(biāo)方法
    jmethodId method = (*env)->GetStaticMethodID(env, _class, "echo", "(Ljava/lang/String;)V");

    // 3. 調(diào)用該方法
    (*env)->CallStaticVoidMethod(env, _class, method, "I'm a foo");

    // 4. 釋放局部引用
    (*env)->DeleteLocalRef(env, _class)
}

你看出其中的差別來(lái)了嗎蔼啦？

幾點(diǎn)說(shuō)明

我們知道，一個(gè)函數(shù)的簽名包括返回值仰猖、函數(shù)名和參數(shù)三部分（如果是類方法的話捏肢，還需要包括類名），在匹配目標(biāo)方法的時(shí)候饥侵，必須無(wú)二義性地分別描述出這幾個(gè)組成部分鸵赫。GetStaticMethodId 有三個(gè)參數(shù)，第一個(gè)參數(shù)指明了類名躏升，第二個(gè)參數(shù)指明了函數(shù)名辩棒。第三個(gè)參數(shù)最特別，它使用一種事先約定好的格式指明了目標(biāo)函數(shù)的參數(shù)和返回類型：(<arg1_type><arg2_type><…?>)return_type，多個(gè)參數(shù)類型直接拼裝成字符串一睁，中間沒(méi)有分隔字符钻弄。

Java 中的數(shù)據(jù)類型并不能直接在原生代碼中使用，你必須使用它們經(jīng)過(guò)編碼之后的版本：

例如：

jclass _class = env->FindClass(env, "com/example/Dog");
jmethodId method = env->GetStaticMethodID(_class, "hasError", "(Ljava/lang/String;IID)Z");

上面的代碼將會(huì)匹配 com.example.Dog 類中具有如下簽名的方法：boolean hasError(String msg, int param1, int param2, double param3)者吁。

進(jìn)行實(shí)際調(diào)用的時(shí)候需要根據(jù)不同的返回類型使用不同的調(diào)用函數(shù)窘俺，比如CallStaticVoidMethod、CallStaticBooleanMethod 等砚偶。這組函數(shù)的參數(shù)相同：第一個(gè)參數(shù)是已取得的目標(biāo)類批销，第二個(gè)參數(shù)是已匹配的目標(biāo)方法洒闸，接下來(lái)是傳遞給目標(biāo)方法的不定個(gè)數(shù)的實(shí)參染坯。

C++ 代碼調(diào)用 Java 方法時(shí)的異步回調(diào)模式

嘖嘖，探索到了這么多實(shí)用的技能丘逸，小伙伴們?cè)桨l(fā)開心起來(lái)单鹿。趁著這股探索的熱情還沒(méi)有消散，小伙伴們又提出了下面的問(wèn)題：怎樣在 C++ 代碼調(diào)用 Java 方法的時(shí)候使用異步回調(diào)模式深纲？

異步回調(diào)模式無(wú)處不在仲锄，尤其是在涉及到網(wǎng)絡(luò)通信的編程中。通過(guò)上面所討論的內(nèi)容湃鹊，我們知道儒喊，C++ 調(diào)用 Java 方法的時(shí)候并不能直接傳遞回調(diào)函數(shù)作為參數(shù)。

但是我們完全可以傳遞回調(diào)函數(shù)的指針氨液恰怀愧！

Java 中的 long 類型使用8個(gè)字節(jié)來(lái)表示整數(shù)，足夠存儲(chǔ)一個(gè)函數(shù)指針余赢。千萬(wàn)不能使用 int 類型芯义，因?yàn)?int 類型只有4個(gè)字節(jié)，在64位機(jī)器上不足以表示一個(gè)指針值妻柒。相對(duì)應(yīng)的扛拨，我們?cè)?C++ 代碼中使用 long long 類型來(lái)表示一個(gè)8字節(jié)整數(shù)。

原理分析透徹之后举塔，實(shí)現(xiàn)就再簡(jiǎn)單不過(guò)了绑警。下面是一個(gè)完整的示例：

// Dog.java
package com.example;

public class Dog {
    private static Dog _instance = NULL;

    public static Dog getInstance() {
        if (_instance == NULL) {
            _instance = new Dog();
        }
        return _instance;
    }

    public static void echo(String msg, long ptrToCallback) {
        Log.i("Dog", "Echo message: " + msg);

        getInstance().onEchoComplete(ptrToCallback);
    }

    public native void onEchoComplete(long ptrToCallback);
}

// Dog.cpp
typedef long long ptr_to_func;

// 回調(diào)函數(shù)
void onCallback() {
    // Do something.
}

// C++ 調(diào)用 Java
void dog_echo() {
    // 取得 JNIEnv 實(shí)例
    JNIEnv *env = ...

    // 回調(diào)函數(shù)的指針
    ptr_to_func ptrToCallback = onCallback;

    jclass _class = env->FindClass("com/example/Dog");
    jmethodId method = env->GetStaticMethodID(_class, "echo", "(Ljava/lang/String;D)V");

    // 傳遞回調(diào)函數(shù)的指針給 Java 方法
    env->CallStaticVoidMethod(_class, method, ptrToCallback);
    env->DeleteLocalRef(_class)
}

extern "C" {

// Native方法 Java調(diào)用C++
JNIEXPORT void JNICALL Java_com_example_Dog_onEchoComplete(JNIEnv *env, jobject obj, jlong ptrToCallback) {
    onCallback cb = (onCallback)ptrToCallback;

    // 調(diào)用回調(diào)函數(shù)
    cb();
}

}

如果你需要獲取更多關(guān)于 JNI 的參考內(nèi)容，請(qǐng)?jiān)L問(wèn) 這里央渣。