1. 前言

JNI (Java Native Interface) 定义了运行在虚拟机中的 Java 代码与本地代码 (使用 C, C++ 等语言编写) 交互的方式。

JNI 规范可在 Java Native Interface Specification 查阅，接下来对规范中的部分内容做些笔记。

2. JNI 的数据类型

2.1 基本类型

下面列出 Java 基本类型与本地类型的对应关系：

Java 类型	本地类型	说明
boolean	jboolean	无符号 8 位
byte	jbyte	有符号 8 位
char	jchar	无符号 16 位
short	jshort	有符号 16 位
int	jint	有符号 32 位
long	jlong	有符号 64 位
float	jfloat	32 位
double	jdouble	64 位
void	void	N/A

2.2 引用类型

JNI 包含了许多对应于不同 Java 对象的引用类型，这些引用类型的组织结构如图所示：

在 C 中，所有的引用类型都被定义成和类型 jobject 一样：

typedef void*           jobject;
typedef jobject         jclass;
typedef jobject         jstring;
typedef jobject         jarray;
typedef jarray          jobjectArray;
...

在 C++ 中，JNI 引入了一个空类 _jobject 来增加类型之间的继承关系：

class _jobject {};
class _jclass : public _jobject {};
class _jstring : public _jobject {};
class _jarray : public _jobject {};
class _jobjectArray : public _jarray {};
...

typedef _jobject*       jobject;
typedef _jclass*        jclass;
typedef _jstring*       jstring;
typedef _jarray*        jarray;
typedef _jobjectArray*  jobjectArray;
...

2.3 类型签名

JNI 使用的是 Java 虚拟机的类型签名，如下表所示：

类型签名	Java 类型
Z	boolean
B	byte
C	char
S	short
I	int
J	long
F	float
D	double
V	void
L fully-qualified-class ;	全限定类名
[ type	type[]
( arg-types ) ret-type	方法类型

2.3.1 例子

对于 Java 方法：

1	long f(int n, String s, int[] arr);

其对应的类型签名为：

1	(ILjava/lang/String;[I)J

3. 本地方法的命名和参数

3.1 命名

一般地，本地方法的名称由以下几部分组成：

前缀 Java_
全限定类名
下划线 _ 分隔符
方法名
对于重载的本地方法，需要加上两个下划线 __，然后加上方法的参数签名

同时，为了确保所有 Unicode 字符都转换为有效的 C 函数名称，应使用下划线 _ 来替代全限定类名中的斜杠 /。

下面列出 Unicode 字符的转换关系：

转义字符序列	表示
_0XXXX	一个 Unicode 字符 `XXXX`
_1	字符 `_`
_2	在签名中的字符 `;`
_3	在签名中的字符 `[`

3.2 参数

本地方法的第一个参数固定为 JNI 接口指针，指针类型是 JNIEnv。关于 JNIEnv 有以下几个要点：
- JNIEnv 具有指向函数表的指针，通过 JNIEnv 可以调用大部分的 JNI 函数。
- JNIEnv 是线程私有的，无法在线程之间共享一个 JNIEnv。
第二个参数的类型为 jobject。如果 Java 代码上定义的本地方法是非静态方法，那么 jobject 是对该 Java 对象的引用；如果 Java 代码上定义的本地方法是静态方法，那么 jobject 是对该 Java 类对象的引用。
其余的参数对应于 Java 方法上的参数。

3.3 例子

Java 代码中，在 com/example 包的 Main 类定义了本地方法：

1	native int hello();

则在 C/C++ 中，其对应的本地方法为：

1	jint Java_com_example_Main_hello(JNIEnv * env, jobject obj);

如果在 Main 类中还定义了 hello 的重载方法：

1	native int hello(int n, String s, int [] arr);

那么在 C/C++ 中，其对应的本地方法为：

1	jint Java_com_example_Main_hello__ILjava_lang_String_2_3I(JNIEnv * env, jobject obj, jint i, jstring s, jintArray arr);

而且，对于原本定义的 Java 本地方法：

1	native int hello();

其对应的 C/C++ 本地方法需要改为：

1	jint Java_com_example_Main_hello__(JNIEnv * env, jobject obj);

4. 加载本地方法

在 Java 代码中调用 System.loadLibrary 方法，可以从本地库中加载本地方法。

一般地，如果一个类定义了本地方法，那么可以将 System.loadLibrary 方法的调用放置于类的静态代码块中，该代码块会随着类的初始化而执行。

例如：

package pkg;

class Cls {

     native double f(int i, String s);

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

其中 "XXXX" 表示目标本地库的名称。

5. 注册本地方法

按照章节三的规范，便可以将 Java 类中的本地方法和使用本地代码 (C/C++) 编写的函数建立起对应关系，但是这种方式会使得方法的命名较为复杂。除了这种方式以外，JNI 还提供了显式注册本地方法的方式。

5.1 显式注册本地方法

JNI 提供了 RegisterNatives 函数，可用于显式地注册本地方法，其函数原型为 jint RegisterNatives(JNIEnv *env, jclass clazz, const JNINativeMethod *methods, jint nMethods)。

现在来分析函数的入参：

env 是 JNI 接口指针，指针类型为 JNIEnv。
clazz 的类型为 jclass，是目标本地方法所在 Java 类的类对象。
methods 是一个 JNINativeMethod 指针，用于指定要注册的本地方法。其中 JNINativeMethod 是一个结构体，其定义如下：
1
2
3
4
5
6
7
8
9
typedef struct {

char *name;

char *signature;

void *fnPtr;

} JNINativeMethod;
- 结构体成员 name 是本地方法的名称。
- 结构体成员 signature 是本地方法的类型签名。
- 结构体成员 fnPtr 是一个函数指针，指向本地方法的实现。此函数指针名义上应当有如下的函数签名：
  1
  ReturnType (*fnPtr)(JNIEnv *env, jobject objectOrClass, ...);
nMethods 表示本地方法的数量，即参数 methods 所包含 JNINativeMethod 的数量。

通过显式注册的本地方法，其方法名不再需要按照 [3.1] 的规则进行命名。

下面给出显式注册本地方法的例子。

5.1.1 例子