NDK 学习笔记(一）

在 Android 开发中会有部分场景需要大量计算，因为语言的特性，Java 并不能满足计算性能，因此需要用到 C/C++ 来处理计算过程。
Android 中为我们提供了 JNI（Java Nactive Interface）以及 NDK （Native Development Kit）来实现 Java 对本地代码（C/C++）的交互。同时使用 JNI 编译出来的.so库可以重复利用，并且比 Java 更难被反编译破解。

JNI 是 Java 中提供 Java 与 本地代码通信的接口
NDK 是 Android 的开发工具包，提供快速开发 C 动态库，并自动打包.so文件到应用中去

本次笔记记录NDK以下知识点：

1. 在 Java 中关联本地代码
   • JNI 关联方法命名定义
   • JNI 与 Java 对应类型以及签名
2. 在本地代码中调用 Java 的属性/方法
   • 调用类的构造函数

添加 static 静态引用

在我们需要使用到 JNI 本地代码(native)的 Java 文件中添加以下代码

static {
    System.loadLibrary("native-lib");
}

「static」静态代码块，在项目启动时，虚拟机加载类时会主动加载执行

JNI 方法定义

当我们需要调用 JNI 接口方法处理数据时，我们先需要在 Java 文件中定义所需要的本地方法名
例：

public native String strFromJNI();

注意，此时在本地代码中需要有一个与之一一对应的本地方法
本地方法名有一下格式要求：

//包名中的 . 需要改成 _ , _ 需要改成 1 (阿拉伯数字1)
JNIEXPORT '返回类型' JNICALL   
'方法名（Java_包名_类名_方法名)'(JNIEnv *env, jobject instance)

假设当前我们的包名是

com.example.jni

与之对应的 Java 方法名为

public native String strFromJNI() 

则当前 JNI 方法名以及参数表定义应为

JNIEXPORT jstring JNICALL
Java_com_example_jni_strFromJNI(JNIEnv *env, jobject instance)

「JNIEnv」
方法参数表中的「JNIEnv」接口指针用来提供 JNI 中函数的调用

JNIEnv类型是一个指向全部JNI方法的指针。该指针只在创建它的线程有效，不能跨线程传递。其声明如下：

struct _JNIEnv;
struct _JavaVM;
typedef const struct JNINativeInterface* C_JNIEnv;

//C++定义部分
#if defined(__cplusplus) 
typedef _JNIEnv JNIEnv;
typedef _JavaVM JavaVM;
//C定义部分
#else 
typedef const struct JNINativeInterface* JNIEnv;
typedef const struct JNIInvokeInterface* JavaVM;
#endif

从这一部分我们可以看出的是对于 JNIEnv 在 C 语言环境和 C++ 语言环境中的实现是不一样的。也就是说我们在 C 语言和 C++ 语言中对于 JNI 方法的调用是有区别的。

C 语言环境调用方法如下

(*env)->GetJNIMethod(env, ...);

C++ 语言环境调用方法如下

env->GetJNIMethod(env, ...);

「jobject」
代表当前调用本地方法的实体对象 例如在以下情况

Class clazz = new Class;
clazz.strFromJNI();

jobject 代表的就是上述的 clazz 实体, 可以在 JNI 方法中对其进行操作
以上我们就已经知道了 JNI 中如何定义与 Java 中对应的方法，已经方法参数的作用以及意义

---

JNI 与 Java 类型对应

在 JNI 中有与 Java 一一对应的所有基本类型以及object对象类型，基本数据类型对应表以及 JNI 中的签名如下：

「类型签名」可以理解为方法描述符，在 JNI 调用 Java 属性或方法时，只知道属性或方法名是不能够定位调用的是那个属性或方法，因此需要「类型签名」来标示属性类型，或是参数返回类型以及参数表

Java类型名	JNI类型名	JNI签名
void	void	V
boolean	jboolean	Z
byte	jbyte	B
char	jchar	C
short	jshort	S
int	jint	I
long	jlong	J
float	jfloat	F
double	jdouble	D

引用数据类型(类,对象，数组)对应表以及 JNI 中的签名如下：

Java类型名	JNI类型名	JNI签名
Object	jobject	Ljava/lang/Object;
Class	jclass	Ljava/lang/Class;
String	jstring	Ljava/lang/String;
int[]	jintArray	[I
long[]	jlongArray	[J
Throwable	jthrowable	Ljava/lang/Throwable;

以上没有将所有数组类型列出来，不过我们可以很明显得找到规律:

如果是数组，其 JNI 类型名称为 'j'+'java名称',其 JNI 签名为 '['+'对应类型的签名'
如果是类或者对象，其签名则是 'L' + "类或对象路径" + ';'
例如，我们在 com.example.jni.bean 路径下有一个实体类 Bean ，此时 Bean 对应的签名就是 Lcom/example/jni/bean/Bean; (注意对象签名结尾分号)

了解了 Java 与 JNI 中的类型对应关系以及类型签名之后，我们就可以开始使用JNI工作了

---

调用 Java 属性/方法

使用 JNI 调用 Java 中的属性或方法时，需要先通过

//当前持有需要获取「属性」或「方法」的对象时，调用这个方法
jclass clazz = env->GetObjectClass(jobject);

或

//当前没有持有需要操作的对象时，调用这个方法
jclass clazz = env->FindClass('ClassPathName');

其中一个方法获取到需要操作的 Java 类引用(jclass)
为了方便下面讲述调用 Java 属性/方法，我们先创建一个提供调用的类

package com.example.jni.bean

class Bean{
    static{
        System.loadLibrary('native_lib')
    }
    //赋初始值 1
    private int variable = 1;
    //将 addVal 的值添加到 variable 成员属性上
    private int addVariable(int addVal){
       return variable += addVal;
    }
   
    //这里只是个普通的 Java 方法，加上 native 关键字后与本地代码中名称对应的方法关联
    public native int addVariableInNative(int addVal);
}

**** nactive ****
//获取 jclass
jclass clazz = env->GetObjectClass(jobject);
或
jclass clazz = env->FindClass("com/example/jni/Bean");

以下调用的过程以 已经拿到需要操作的 Java 类引用(现在变量名为 clazz) 为前提
在 JNI 中每个 Java 中的属性/方法都有对应的 Id，当我们需要操作对应属性/方法时，需要获取属性/方法的Id

调用 Java 属性

在 JNI 中使用 GetFieldID(jclass, fieldName, sign) 方法来获取属性id，使用 jfieldID 来接收，然后使用 GetObjectField(jobject, jfieldid) 方法获取属性对象

//获取 variable 属性id 
jfieldId id = env->GetFieldID(clazz, "variable", "I");
//获取 variable 属性对象 GetObjectField 返回的时 jobject 类型， 使用需要转化成对应的类型
jint var = static_cast<jint>(env->GetObjectField(instance, id));

当我们需要将修改后的值同步到 Java 属性中时，使用 SetObjectField(jobject, jfieldId, val) 方法来同步值

var = 2;
env->SetObjectField(instance, id, var);

此时在 Java 中调用对象的 variable 属性值时，它的值就为 2 ；

调用 Java 方法

同理，在 JNI 中调用 Java 方法，需要先用 GetMethodId(jclass, methodName, sign) 方法获取方法id，使用 jmethodID来接收，然后使用 CallXXMethod(jobject, jmethodId, ...) 方法调用对应的 Java 方法，第三个参数为调用方法的参数值

//获取 int addVariable(int) 方法id
jmethodID id = env->GetMethodID(clazz, "addVariable", "(I)I")
//调用方法 获取返回值
int val = env->CallIntMethod(instance, id, 1);

此时返回的 val 值为 variable + 1 = 3

调用类的构造方法

当我们需要使用某个其他类的方法时（例如我们需要使用 Date 下的 getTime 方法时，我们需要先构建一个这个类型的对象，才能去调用对应的方法
我们先来看下如果初始化构建一个对象，在 env 下有一个 jobject NewObject(jclass, initId) 方法，我们需要一个 jclass ，以及一个 构造方法Id。
jclass 我们通过 FindClass(classPath) 方法获取,并获取到它的 构造方法Id

jclass clazz = env->FindClass("java/util/Date");
//调用构造方法不关心类名时什么，统一使用 ‘<init>’代表调用的是构造方法
jmethodId initId = env->GetMethodId(clazz, "<init>", "()V");
//生成 Date 对象
jobject date = env->NewObject(clazz, initId);

实体对象创建完成后 接下来只要调用 Java 方法即可

jmethodId getTimeId = env->GetMethodId(clazz, "GetTime", "()J");
//调用 getTime 方法 这里在实际使用时发现 long 类型精度不够，推荐使用 long long 类型
long long time = env->CallLongMethod(date, getTimeId);

什么时候需要在 本地代码 中调用 Java 中的方法 ？

比如在本地代码中需要获取当前的时间戳，使用 Java 比较容易实现，此时就可以调用 Java 中的实现代码

---

需要注意的点
jstring 类型是 jint 与 java 的映射类型，其指向 JVM 内部的字符串，与常规 C 的 char* 字符串类型不同，因此不能直接使用，在 本地代码 中使用 jstring 类型的变量时，需要使用 env->GetStringUTFChars(jstring, NULL) 转化成 char* 类型，在被使用完之后调用 ReleaseStringUTFChars(jstring, char*) 释放字符串