JNI实战（二）：Java 调用 C

2023-08-14 15:09:52

1. JNI Env 和 Java VM 关系说明

JNIEnv 是 Java的本地化环境，是Java与C的交互的重要桥梁。

在Android上，一个进程对应一个JavaVM，也就是一个app对应一个JavaVM。

一个JavaVM可以有很多个线程，每一个Java线程对应一个JNI Env。

我们可以通过JavaVM获取到JNIEnv，但是在C层访问Java对象时，必须在当前的线程下。所以我们需要合理使用JNI Env来保证不出现异常问题。

2. Java 调用 C 的流程

Java调用C的流程为：

在Java层定义native关键字函数
在C/C++层创建Java_packname_classname_methodname函数（虚拟机会将定义的两个方法进行映射关联）

对应的，在上节，我们看到Java声明的native方法：

    /**

     * A native method that is implemented by the 'native-lib' native library,

     * which is packaged with this application.

     */

    public native String stringFromJNI();

也看到了C实现的native方法：

extern "C"   // 指示编译器这部分代码按C语言的进行编译

JNIEXPORT jstring JNICALL Java_com_renhui_jnihelloworld_MainActivity_stringFromJNI(JNIEnv *env, jobject /* this */)

这里的JNIEnv指的是当前的Java线程环境，我们可以利用JNIEnv来操作Java代码。jobject 指代的是 jni 函数对应的 Java Native 方法的类实例，如果 Java方法是 static，则代表的是 Class对象；在以后的开发中，我们会使用到这两个参数做很多事情。

这里可能有人会问，为啥要添加 extern "C" ，可以去看一下之前总结的 C++ 基础知识回顾总结。

这里再写一下这个问题的答案：

[ extern "C"的主要作用就是为了能够正确实现C++代码调用其他C语言代码。加上extern "C"后，会指示编译器这部分代码按C语言的进行编译，而不是C++的。由于C++支持函数重载，因此编译器编译函数的过程中会将函数的参数类型也加到编译后的代码中，而不仅仅是函数名；而C语言并不支持函数重载，因此编译C语言代码的函数时不会带上函数的参数类型，一般只包括函数名。

extern "C" 这段声明在做JNI开发的时候会经常用到，主要原因是C++语言在编译的时候为了解决函数的多态问题，会将函数名和参数联合起来生成一个中间的函数名称，而C语言则不会，因此会造成C++文件里面的JNI方法在链接时找不到对应函数的情况，此时就需要用extern "C"进行链接指定，这告诉编译器，请保持我的名称，不要给我生成用于链接的中间函数名；exter "C"{jni代码}。]

3. JNI 静态注册和动态注册

看完上面的内容，可能有人会问，如果我添加一个方法，使用静态注册，会比较繁琐，而且函数方法名称过长，也不利于后期的扩展和维护。那么有什么办法呢？

这里我们引入两个概念：JNI 静态注册、JNI 动态注册。

a). JNI静态注册

JNI 静态注册的实现方式就是我们在HelloWorld的实现方式，可以看出来其原理就是根据函数名来建立 java 方法与 JNI 函数的一一对应关系。基本的实现流程如下：

编写Java代码
使用javah指令生成对应的.h文件
对.h文件中声明的方法进行实现

JNI 静态注册的弊端很多，上面我们也提到了一些，下面说明一下这中实现方式的其他弊端：

编写不方便，JNI 方法名字必须遵循规则且名字很长
编写过程步骤较多，相对来说很不方便
程序的运行效率较低，因为初次调用native函数时，需要根据函数名在JNI层搜索对应的本地函数，然后建立对应关系，这个过程会比较耗时。

b). JNI动态加载

了解到JNI静态加载的问题后，我们这里推荐JNI动态加载的方式，来建立Java方法与JNI函数的映射关系 —— JNI动态加载。

JNI动态加载的原理就是利用 RegisterNatives 方法来注册Java方法与 JNI 函数的一一对应关系。基本的实现流程如下：

利用结构体 JNINativeMethod 数组记录 Java 方法与 JNI 函数的对应关系
实现 JNI_OnLoad 方法，在加载动态库后，执行动态注册
调用 FindClass 方法，获取 Java 对象
调用 RegisterNatives 方法，传入 Java 对象、JNINativeMethod 数组及注册方法数完成注册；

动态注册的优点为：代码流程更加清晰可控，运行效率更高。

4. JNI 动态注册实战

Java层基本不变，代码如下：

package com.renhui.jnihelloworld;

import android.os.Bundle;

import android.support.v7.app.AppCompatActivity;

import android.widget.TextView;

public class MainActivity extends AppCompatActivity {

    // Used to load the 'native-lib' library on application startup.

    static {

        System.loadLibrary("native-lib");

    }

    @Override

    protected void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_main);

        // Example of a call to a native method

        TextView tv = findViewById(R.id.sample_text);

        tv.setText(_jnitest());

    }

    public native String _jnitest();

}

C++层代码修改为：

#include <jni.h>

#include <string>

#define JNI_CLASS_PAPT "com/renhui/jnihelloworld/MainActivity"

extern "C"

JNIEXPORT jstring JNICALL my_test_register(JNIEnv *env, jobject instance) {

    return env->NewStringUTF("xxxooo");

}

static JNINativeMethod g_methods[] = {

        // Java层方法、参数类型、JNI方法

        {"_jnitest", "()Ljava/lang/String;", (void*)my_test_register}

};

// 动态库加载时回调方法

jint JNI_OnLoad(JavaVM *vm, void *reserved) {

    JNIEnv *env = NULL;

    vm->GetEnv((void**)&env, JNI_VERSION_1_6);

    jclass clazz= env->FindClass(JNI_CLASS_PAPT);

    // 注册Java和natvie方法映射表

    env->RegisterNatives(clazz, g_methods, sizeof(g_methods)/sizeof(g_methods[]));

    return JNI_VERSION_1_6;

}

运行代码，可以看到，同静态注册一样，动态注册的代码能狗正常的运行并返回数据。

5. JNI 动态注册核心方法 env->RegisterNatives()

JNI动态注册的核心方法为env->RegisterNatives()，此方法使用了JNINativeMethod 结构体，此结构体位于jni.h 文件中，定义如下：

typedef struct {

    const char* name;

    const char* signature;

    void*       fnPtr;

} JNINativeMethod;

第一个参数 name 是 Java 方法名

第二个参数 signature 用于描述方法的参数与返回值

第三个参数 fnPtr 是函数指针，指向 jni 函数

其中，第二个参数 signature 使用字符串记录方法的参数与返回值，具体格式形如“()V”、“(II)V”，其中分为两部分，括号内表示的是参数，括号右侧表示的是返回值（注：此参数会在后面的文章进行详细说明）

码农公寓