ReactNative4Android源码分析1: JNI智能指针之介绍篇

通常的app中, JNI提供的native函数主要充当Java类的扩展，逻辑层在Java端，JNI端较少使用OOP的设计思想。而对于native端功能较重的模块，例如开源的阅读器FBReader，native端与Java端有较多交互，即native会主动创建Java对象并调用它们的方法以实现功能，这时就需要考虑将native至Java的操作与访问框架化，形成更高层次的封装，以避免直接使用原始的JNI反射API集去操作Java对象。

对于ReactNative For Android而言，这套访问框架尤其重要，其核心就是JNI智能指针这个基本数据类型。它的实现基于C11标准，将先用几篇对这套native至Java的操作框架进行介绍，为后续分析打下良好基础。

首先回顾一下java object（jobject）在native端的三种引用类型：

全局引用

类似于C语言中的全局变量。使用NewGlobalRef创建，支持跨线程访问 ，在调用释放DeleteGlobalRef销毁前，GC无法回收该引用对应的java object。

局部引用

概念上与C语言中的局部变量有相似点，但不等同。使用NewLocalRef创建, 只能在本线程内安全访问，当创建该引用的native调用链返回至JVM时，未销毁的局部引用会被JVM自动GC回收。但由于局部引用表容量有限，在返回至JVM前，可以调用DeleteLocalRef先行销毁，避免局部引用表超限引起崩溃。

弱全局引用

与全局引用一样具有全局作用域，但不会影响GC回收, GC可以随时回收该引用对应的java object。使用NewWeakGlobalRef创建，当需要使用时，需要将其升级为全局引用或者局部引用，若已被回收，会返回null，使用DeleteWeakGlobalRef销毁。该引用类型使用场景较少。

由上可见，JNI智能指针的第一个需求，就是要自动管理jobject的生命周期，当进入与离开对应作用域时，需要自动调用对应生命周期的创建与销毁函数。这在C++中，通常会结合构造与析构函数来进行配对调用。若功能仅限于此，就与普通的智能指针和mutext锁管理机制类似了，更重要的需求是在C++层提供与被管理的Java对象镜像结构的C++对象,形成高层次封装。这样，对jobject的访问与操作就会被封装在对应的镜像C++对象中，相关JNI反射调用的细节被隐藏，对于其他native模块而言，与Java层的交互被转化成了与这些镜像C++对象的交互，整个实现风格OOP化了。这些镜像C++对象被称为wrapper对象，其定义代码位于ReactAndroid/src/main/jni/first-party/fb/include/fb/fbjni/CoreClasses.h文件中。

先看一个使用范例：

struct MyClass : public JavaClass<MyClass> {
constexpr static auto kJavaDescriptor = "Lcom/example/package/MyClass;";

void foo() {
static auto method = javaClassStatic()->getMethod<void()>("foo");
method(self());
}

static local_ref<javaobject> create(int i) {
return newInstance(i);
}
};

auto obj = MyClass::create(10);
obj->foo();

native的需求是在native端创建com.example.package.MyClass这个自定义的Java类的对象，并访问它的foo方法。例子中实现的步骤是：

定义java的MyClass的wrapper C++类MyClass，所有wrapper均需要继承于JavaClass的一个模板实例，并将自身类型做为JavaClass的第一个模板类型参数,以供JavaClass获取具体wrapper的类型。

给static成员变量kJavaDescriptor赋值为对应Java类的全类名。

在wrapper类实现镜像方法foo(), 其会获取jclass的包装类JClass对象，并获取jmethod的包装类JMethod进行调用。

create工厂方法中使用newInstance构建镜像对象的实例，并将其存至局部智能指针local_ref<javaobject>。这样就可以通过智能指针访问wrapper class提供的foo方法，实现了native至Java的镜像映射。

除了实现对一个java类的的映射，还需要支持对java继承关系的映射。若java的MyClass有一子类MyChildClass，native层为其建立的wrapper class可如下：

struct MyChildClass : public JavaClass<MyChildClass, MyClass> {
constexpr static auto kJavaDescriptor = "Lcom/example/package/MyChildClass;";
};

这里需要用到JavaClass的第二个模板参数，设为MyClass，它是JavaClass<MyChildClass, MyClass>这个模板实例的父类型。通过构造这样的继承链，MyChildClass获得了父类MyClass提供的java方法映射，完成了继承关系在native层的映射。

上面例子中，返回的obj可以调用wrapper提供的镜像方法，应可以看出，智能指针存放的并不是原始的jobject，而是更抽象的wrapper MyClass对象。与通常的智能指针不一样，local_ref局部指针的模板参数并不直接指代其存储值的类型。在上面代码中，obj的类型除了根据create函数签名推导出的local_ref<MyClass::javaobject>,也可以写成local_ref<MyClass>，这两者是等价的。若native端只需要保存jobject，不需直接调用wrapper类的方法，也可以使用local_ref<jobject>。这就带来几个问题：

javaobject与jobject的关系是什么？

为什么智能指针的模板参数能够接受多种类型？

模板参数起到的作用是什么？

这些问题将在下一篇智能指针的具体实现篇中解答。

总结一下，在ReactNative for Android中，为了简化native层对Java层的调用，提供了镜像结构的wrapper class，结合智能指针，将jobject的生命周期管理、java method的反射调用等“样板”代码封装起来，是比较优雅的JNI调用框架。