Java 代码调用 C++ 函数

小伙伴们制作了一款独具创意的Android应用，只可惜这个应用某些模块的运行效率非常低。一个自然的想法是，使用 C++ 重写那些已然成为性能拖油瓶的模块。那么现在问题来了，我们怎么才能从 Java 代码里面调用 C++ 函数呢？

通过查阅文档，小伙伴们找到了合适的方案。Java 给我们提供了一组简单的接口（Java Native Interface, JNI），允许我们在 Java 应用程序中加载和使用动态共享库。

首先，在 Java 的类中声明 Native 方法。Native 方法和普通方法的声明方式一致，只是多了一个 native 关键字：

// Dog.java
package com.example;

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

Native 方法只声明，不定义，具体的实现在 C++ 动态共享库中

应用启动后，在合适的时机载入动态共享库。假设共享库名为 libCppModule.so：

// Dog.java
package com.example;

public class Dog {
    // ...

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

注意如果模块的名称为“libxxx”，在载入的时候要省略掉“lib”，只填入"xxx"。

对 libCppModule 中所有的公有接口，我们都必须按照下面的规则加以封装：

// 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.
}

}

至此，小伙伴们感慨道：美好的生活又回来了!

C++ 代码调用 Java 方法

既然 Java 调用 C++ 函数是如此的简单，那么反过来，在 C++ 中使用 Java 某个类的方法是不是也行得通呢？

当然也是可以的！小伙伴们动手做了一番尝试，把具体的步骤纪录在了下面。

第一步，在类中定义希望被 C++ 调用的方法，必须是静态方法：

// 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++ 代码中调用上面定义的 echo 方法：

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

    // 1. 找到目标类
    jclass _class = env->FindClass("com/example/Dog");

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

    // 3. 调用该方法
    env->CallStaticVoidMethod(_class, method, "I'm a foo");

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

注意，JNIEnv 的实例只在当前线程中有效。

如果你使用的是 C 语言，那么语法将稍有不同：

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

    // 1. 找到目标类
    jclass _class = (*env)->FindClass(env, "com/example/Dog");

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

    // 3. 调用该方法
    (*env)->CallStaticVoidMethod(env, _class, method, "I'm a foo");

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

你看出其中的差别来了吗？

几点说明

我们知道，一个函数的签名包括返回值、函数名和参数三部分（如果是类方法的话，还需要包括类名），在匹配目标方法的时候，必须无二义性地分别描述出这几个组成部分。GetStaticMethodId 有三个参数，第一个参数指明了类名，第二个参数指明了函数名。第三个参数最特别，它使用一种事先约定好的格式指明了目标函数的参数和返回类型：(<arg1_type><arg2_type><…​>)return_type，多个参数类型直接拼装成字符串，中间没有分隔字符。

Java 中的数据类型并不能直接在原生代码中使用，你必须使用它们经过编码之后的版本：

例如：

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

上面的代码将会匹配 com.example.Dog 类中具有如下签名的方法：boolean hasError(String msg, int param1, int param2, double param3)。

进行实际调用的时候需要根据不同的返回类型使用不同的调用函数，比如CallStaticVoidMethod、CallStaticBooleanMethod 等。这组函数的参数相同：第一个参数是已取得的目标类，第二个参数是已匹配的目标方法，接下来是传递给目标方法的不定个数的实参。

C++ 代码调用 Java 方法时的异步回调模式

啧啧，探索到了这么多实用的技能，小伙伴们越发开心起来。趁着这股探索的热情还没有消散，小伙伴们又提出了下面的问题：怎样在 C++ 代码调用 Java 方法的时候使用异步回调模式？

异步回调模式无处不在，尤其是在涉及到网络通信的编程中。通过上面所讨论的内容，我们知道，C++ 调用 Java 方法的时候并不能直接传递回调函数作为参数。

但是我们完全可以传递回调函数的指针啊！

Java 中的 long 类型使用8个字节来表示整数，足够存储一个函数指针。千万不能使用 int 类型，因为 int 类型只有4个字节，在64位机器上不足以表示一个指针值。相对应的，我们在 C++ 代码中使用 long long 类型来表示一个8字节整数。

原理分析透彻之后，实现就再简单不过了。下面是一个完整的示例：

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

// 回调函数
void onCallback() {
    // Do something.
}

// C++ 调用 Java
void dog_echo() {
    // 取得 JNIEnv 实例
    JNIEnv *env = ...

    // 回调函数的指针
    ptr_to_func ptrToCallback = onCallback;

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

    // 传递回调函数的指针给 Java 方法
    env->CallStaticVoidMethod(_class, method, ptrToCallback);
    env->DeleteLocalRef(_class)
}

extern "C" {

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

    // 调用回调函数
    cb();
}

}

如果你需要获取更多关于 JNI 的参考内容，请访问 这里。