Android JNI基础

一、JNI简介

1.1 什么是JNI

JNI（Java Native Interface）是Java提供的一种机制，用于实现Java和本地（Native）代码之间的交互。通过JNI，Java程序可以调用本地代码（如C、C++）中的函数，实现跨语言的互操作性。

1.2 用途

JNI主要用于以下几个方面：

调用系统级别的库和函数：可以使用JNI调用操作系统提供的底层功能，如文件操作、网络通信等。
提高性能：通过JNI将性能关键的部分用本地代码实现，可以提高程序的执行效率。
访问硬件资源：JNI可以用于访问硬件资源，如摄像头、传感器等。
调用第三方库：可以使用JNI调用第三方的本地库，以实现更多功能。

1.3 优点

使用JNI具有以下几个优点：

跨语言支持：可以与本地代码（如C、C++）进行无缝交互，扩展了Java的能力。
性能优势：通过JNI可以将性能关键的部分用本地代码实现，提高程序的执行效率。
访问系统资源：可以通过JNI访问系统级别的资源和功能，扩展了Java程序的能力。
调用第三方库：可以利用JNI调用第三方的本地库，扩展了Java程序的功能。
native层的代码往往更加安全，反编译so文件比反编译jar文件要难得多，往往把涉及到密码密钥相关的功能用C/C++实现，然后java层通过jni调用

通过JNI，Java程序可以充分利用本地代码的优势，实现更多功能和性能优化，同时也扩展了Java的应用领域。

二、初探JNI

为了更直接了解JNI，用一个简单的示例先来看一下JNI。

2.1 新建cpp\cmake

使用安卓Studio
在app/src/main文件夹下新建cpp文件夹

cpp文件夹下新建CMakeLists.txt和native-lib.cpp

2.2 build.gradle配置

配置模块名称"myjni"和产出的架构平台

  defaultConfig {
        applicationId "com.henry.basic"
        namespace "com.henry.basic"
		......
        ndk {
            // 指定库名称
            moduleName "myjni"
            // 指定需要产出哪些架构平台
            abiFilters "arm64-v8a", "armeabi-v7a", "x86", "x86_64"
        }
    }

指定CMake脚本路径和版本号

android {
    compileSdk 34
	......
    externalNativeBuild {
        cmake {
            path file('src/main/cpp/CMakeLists.txt')
            version '3.22.1'
        }
    }
}

2.3 java层配置

定义一个JNIDemo 类
静态加载myjni 库
native方法返回String字符串，一会在c++层面实现。

public class JNIDemo {

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

    public JNIDemo() {

    }

    public native String helloJni();

}

static { System.loadLibrary("myjni"); } 会在类被加载到内存中时执行。当首次使用该类时，Java虚拟机会加载并初始化这个类，执行静态代码块中的代码，从而加载本地库 myjni。这确保了在调用任何类方法或创建类实例之前，本地库已经被加载进内存，以便后续的JNI调用可以正常进行。

Launcher中的Activity
在Oncreate中实例化JNIDemo，并调用native方法。

public class jniActivity extends AppCompatActivity {

    String TAG = "henry";

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_dialog_test);
        JNIDemo demo = new JNIDemo();
        Log.d(TAG, "      : " + demo.helloJni());
    }
    
}

2.4 cmake和c++

上层和配置已经完成
接下来就剩下c++层面的实现和cmake脚本的编写了。

初学者看到cmake脚本肯定会头大，建议新建工程时选择C++，工程会自动生成Cmake脚本和cpp层面的实现，在此基础上学习Cmake。

回到我们当前的工程编写c++和Cmake

native-lib.cpp：

#include <jni.h>
#include <string>


extern "C"
JNIEXPORT jstring JNICALL
Java_com_henry_cmaketest_JNIDemo_helloJni(JNIEnv *env, jobject thiz) {
    // TODO: implement helloJni()
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());
}

1.#include <jni.h>：包含了JNI的头文件，提供了JNI的相关函数和数据结构的定义。
2.#include < string>：包含了C++标准库中的字符串处理相关的头文件。
3.extern “C”：指定了使用C语言的调用约定，确保编译器正确处理函数名。
4.JNIEXPORT jstring JNICALL：定义了本地方法的返回类型为 jstring，表示返回一个Java的字符串对象。JNIEXPORT 和 JNICALL 是JNI的宏定义，用于声明本地方法。
5.Java_com_henry_cmaketest_JNIDemo_helloJni(JNIEnv *env, jobject thiz)：实现了一个名为 helloJni 的本地方法，该方法与Java中的 JNIDemo 类中的 helloJni 方法对应。JNIEnv *env 是JNI环境指针，jobject thiz 是Java对象。
std::string hello = “Hello from C++”;：创建一个C++字符串 hello，内容为 “Hello from C++”。
return env->NewStringUTF(hello.c_str());：使用JNI环境指针 env 的 NewStringUTF 方法将C++字符串转换为Java字符串对象，并返回给Java调用方。

CMakeLists.txt

cmake_minimum_required(VERSION 3.22.1)

project("myjni")

add_library(${CMAKE_PROJECT_NAME} SHARED
        # List C/C++ source files with relative paths to this CMakeLists.txt.
        native-lib.cpp)

target_link_libraries(${CMAKE_PROJECT_NAME}
        # List libraries link to the target library
        android
        log)

1.指定了CMake的最低版本要求为3.22.1
2.定义了项目名称为 “myjni”。
3.添加一个名为 ${CMAKE_PROJECT_NAME} 的共享库，这里会被替换为 “myjni”。共享库类型为 SHARED，表示构建一个共享库。native-lib.cpp 是该共享库的源文件，用于实现JNI的本地方法。
4.将目标库 ${CMAKE_PROJECT_NAME} 与指定的库进行链接。在这里，目标库会链接到 android 库和 log 库。android 库提供了Android平台相关的功能和API，而 log 库用于在Android平台上输出日志。

运行，看一下LOG输出： 正是我们native-lib.cpp里面定义的字符串。

本地使用Everything搜一下myjni字段：

打开.bat:
相关命令带一些参数

打开txt:
先编译cpp文件
然后链接共享库生成libmyjni.so

打开相关.so所在文件夹：四个架构的so库都已生成。

三、API详解

初探JNI已经完毕，接下来需要归纳一些知识了，稍微大一点的项目用到的不仅仅是上面的皮毛，比如CMake脚本的各种命令所代表的含义?native-lib.cpp里的JNIEXPORT、jstring 、JNICALL都是什么意思？

3.1 JNI API

上例只是简单的返回了一个字符串，实际上我们还可以做很多事情，jni.h都给我们定义好了标准，我们按照它的标准来即可。
比如，java中叫boolean，jni中叫jboolean，jni给我们提供了若干个映射表，将java中的类型与jni中的类型进行了一 一映射，其中包括基本数据类型映射，引用数据类型映射，方法签名(包含参数和返回值)映射，以下是这三个映射表：

3.1.1 数据类型

基本数据类型映射表

引用数据类型映射表

方法签名

示例

    public native String stringJni();
    public native float floatJni(int number,Boolean enabled);

对应的native层：

extern "C"
JNIEXPORT jfloat JNICALL
Java_com_henry_cmaketest_JNIDemo_floatJni(JNIEnv *env, jobject thiz, jint number, jobject enabled) {
}
extern "C"
JNIEXPORT jstring JNICALL
Java_com_henry_cmaketest_JNIDemo_stringJni(JNIEnv *env, jobject thiz) {
}

顺便讲一下J开头所代表的含义：

3.1.2 方法

jni访问调用对象

jni访问java成员变量的值

jni访问java静态变量的值

jni访问java成员方法

jni访问java静态方法

jni访问java构造方法

jni创建引用

除此之外，jni还提供了异常处理机制，处理方式跟java一样有两种，要么往上(java层)抛，要么自己捕获处理

以上只是常用API,其他的可以自行到jni.h文件里去查看。

3.2 CMake脚本

CMake编写规则:

CMakeLists会自动创建两个变量，PROJECT_SOURCE_DIR和PROJECT_NAME

四、再探JNI

这一次，多用一些JNI相关知识写一个demo

新建一个test方法，并添加到native-lib.cpp中。

再新建一个mycpp.cpp文件，activity中新建一个test2()方法，jni实现在mycpp.cpp文件中

CMakeLists.txt中添加mycpp.cpp：

cmake_minimum_required(VERSION 3.22.1)

project("myjni")

add_library(${CMAKE_PROJECT_NAME} SHARED
        # List C/C++ source files with relative paths to this CMakeLists.txt.
        native-lib.cpp mycpp.cpp)

target_link_libraries(${CMAKE_PROJECT_NAME}
        # List libraries link to the target library
        android
        log)

Activity:

public class jniActivity extends AppCompatActivity {
    static {
        System.loadLibrary("myjni");
    }
    private int num = 1;
    String TAG = "henry";
    private TextView tv;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.jnitest);
        JNIDemo demo = new JNIDemo();
        tv = findViewById(R.id.jniview);
        Log.d(TAG, "      : " + demo.stringJni());
        tv.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                test();
                test2();
            }
        });
    }

    public native void test();
    public native void test2();
}

mycpp.cpp:

#include <jni.h>
#include <string>
#include <android/log.h>
#define TAG    "henry"
#define LOGD(...)  __android_log_print(ANDROID_LOG_DEBUG,TAG,__VA_ARGS__) // 定义LOGD类型

extern "C"
JNIEXPORT void JNICALL
Java_com_henry_cmaketest_jniActivity_test2(JNIEnv *env, jobject thiz) {
    LOGD("-------------new cpp test");
}

native-lib.cpp:

#include <jni.h>
#include <string>
#include <android/log.h>

#define TAG    "henry"
#define LOGD(...)  __android_log_print(ANDROID_LOG_DEBUG,TAG,__VA_ARGS__) // 定义LOGD类型


extern "C"
JNIEXPORT jstring JNICALL
Java_com_henry_cmaketest_JNIDemo_stringJni(JNIEnv *env, jobject thiz) {
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());
}

/**
 * 参数一：JNIEnv* env表示指向可用JNI函数表的接口指针，所有跟jni相关的操作都需要通过env来完成
 * 参数二：jobject是调用该方法的java对象，这里是MainActivity调用的，所以thiz代表MainActivity
 * 方法名：Java_包名_类名_方法名
 */
extern "C"
JNIEXPORT void JNICALL
Java_com_henry_cmaketest_jniActivity_test(JNIEnv *env, jobject thiz) {
    //获取Activity的class对象
    jclass clazz = env->GetObjectClass(thiz);
    //获取MainActivity中num变量id
    /**
    参数1：MainActivity的class对象
    参数2：变量名称
    参数3：变量类型，具体见上《表3-方法签名》
    **/
    jfieldID numFieldId = env->GetFieldID(clazz, "num", "I");
    //根据变量id获取num的值
    jint oldValue = env->GetIntField(thiz, numFieldId);
    //将num变量的值+1
    env->SetIntField(thiz, numFieldId, oldValue + 1);
    //重新获取num的值
    jint num = env->GetIntField(thiz, numFieldId);
    //先获取tv变量id
    jfieldID tvFieldId = env->GetFieldID(clazz, "tv", "Landroid/widget/TextView;");
    //根据变量id获取textview对象
    jobject tvObject = env->GetObjectField(thiz, tvFieldId);
    //获取textview的class对象
    jclass tvClass = env->GetObjectClass(tvObject);
    //获取setText方法ID
    /**
    参数1：textview的class对象
    参数2：方法名称
    参数3：方法参数类型和返回值类型，具体见上《表3-方法签名》
    **/
    jmethodID methodId = env->GetMethodID(tvClass, "setText", "([CII)V");
    //获取setText所需的参数
    //先将num转化为jstring
    char buf[64];
    sprintf(buf, "%d", num);
    jstring pJstring = env->NewStringUTF(buf);
    const char *value = env->GetStringUTFChars(pJstring, JNI_FALSE);
    //创建char数组，长度为字符串num的长度
    jcharArray charArray = env->NewCharArray(strlen(value));
    //开辟jchar内存空间
    jchar *pArray = (jchar *) calloc(strlen(value), sizeof(jchar));
    //将num字符串缓冲到内存空间中
    for (int i = 0; i < strlen(value); ++i) {
        *(pArray + i) = *(value + i);
    }
    //将缓冲的值写入到上面创建的char数组中
    env->SetCharArrayRegion(charArray, 0, strlen(value), pArray);
    //调用setText方法
    env->CallVoidMethod(tvObject, methodId, charArray, 0, env->GetArrayLength(charArray));
    //释放资源
    env->ReleaseCharArrayElements(charArray, env->GetCharArrayElements(charArray, JNI_FALSE), 0);
    free(pArray);
    pArray = NULL;
}

看一下效果：

参考链接：
CMakeLists.txt的超傻瓜手把手教程
JNI 从入门到实践，爆肝万字详解！
基础JNI语法和常见使用