JNI快速学习

JNI是JVM中的一部分，它的存在就是为了打通java和native模块的桥梁。刚接触的时候会遇到一堆陌生的api，其实这些api的命名比较规范，调用几次之后就能举一反三。关键是要弄懂JNI的一些调用顺序，以下就是我用JNI碰到的一些关键点所做的记录。

JNI_OnLoad

JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *vm, void *reserved)
{
    // TODO: 保存vm在本地
｝

JNI_OnLoad是JNI调用native的第一个函数，算是JNI的入口。参数vm一般是需要保存下来，因为它是访问JVM的一个关键对象。

JNIEnv

env对象是每次Java和Navtive调用的必须参数，这个参数可以每次用的时候由JavaVM对象获取得到

static bool getEnv(JNIEnv **env)
{
    bool bRet = false;
    do 
    {
        if (JAVAVM->GetEnv((void**)env, JNI_VERSION_1_4) != JNI_OK)
        {
            LOGD("Failed to get the environment using GetEnv()");
            break;
        }

        if (JAVAVM->AttachCurrentThread(env, 0) < 0)
        {
            LOGD("Failed to get the environment using AttachCurrentThread()");
            break;
        }
        bRet = true;
    } while (0);        

    return bRet;
}

上面的代码来自coco2d-x-qt，大家的写法大同小异。

JNI中两个最重要的对象理解到后，剩下的工作就是具体的调用而已。

Java -> Native

java调navtive就只有一种方式：function

class JClass {
  private navtive void cfunc();
}

只需要在java函数前加上native，调用的时候就自动到native模块中寻找对应的方法。
native中函数声明的样式是固定的 Java_包名_类名_函数名，参数第一个是JNIEnv，第二个是jobject，如果是静态函数则是jclass；后面的参数视情况而定。

#include 
   
JNIEXPORT void JNICALL Java_JCalss_cfunc(JNIEnv *env, jobject
obj)  {
}

native头文件推荐用javah -jni命令直接生成，以防参数写错。参考链接

javah使用注意事项:

javah -classpath 路径(不包含包名) -jni 完整类名(包含包名)

路径必须是完整路径

Native->Java

对象创建

创建对象先要得到对象的class，然后用对象创建方法创建

jclass jcls = env->FindClass("java/lang/String");
jobject jobj = env->AllocateObject(jcls);

或者，自己指定构造函数

jmethodID mID1 = env->GetMethodID(jcls,
   "", "()V");
jobj1 = env->NewObject(jcls, mID1); // 这种方式等同与AllocateObject

jmethodID mID2 = env->GetMethodID(jcls,
   "", "(I)V");
jobj2 = env->NewObject(jcls, mID2, 123); // 用带一个参数为整数的构造函数

JNI也提供了诸如NewIntArray等创建数组包装函数，文档地址

在4.0上，NewStringUTF8有bug，如果字符串包含中文或emoji，可能造成crash。解决方案见 https://stackoverflow.com/a/34218851/1118964

访问属性

属性的访问先要通过jclass得到jfiledID。JNI包装了各种类型的访问函数，通过filedID就可以访问到这些属性了

jfieldID valId = env->GetFieldID(jcls, "val", "I"); // 获取熟悉val的fileID
jint intVal = env->GetIntField(jobj, valId); // read
env->SetIntField(jobj, valId, intVal);       // write

静态属性fileID是通过GetStaticFieldID，read和write时，第一个参数时jclass。

方法调用

方法调用第一步也是要通过jclass得到jmethodID。然后直接调用就可以了

jmethodID mID = env->GetMethodID(jcls, "method", "()V");
env->CallVoidMethod(mID);

如果java的方法带参数，调CallMethod的时候直接在后面加上，有多少个就加多少个。要保持与函数签名一致

jmethodID mID = env->GetMethodID(jcls, "method", "(I)V");
env->CallVoidMethod(mID, 123);

如果函数有返回值，相应的CallMethod也可以带上

jmethodID mID = env->GetMethodID(jcls, "method", "(I)I");
int res = env->CallIntMethod(mID, 123); // 返回整数

静态方法也静态属性一样，把GetMethodID换成GetStaticMethodID即可，其他无变化。

参考链接

线程安全

线程安全主要发生在native调java时，一般表现为地址访问非法。

因为JNIEnv是一个线程相关的变量，每个线程都有不同的env。所以为了安全起见，env对象都是在使用前通过JavaVM获取（参考上面getEnv代码），JavaVM是全局有效的。

一个线程中的jobject是不能在另一个线程中使用的，解决方法是调用 env->NewGlobalRef 创建一个全局变量。jclass继承于jobject，所以跨线程访问也需要创建全局变量。 jmethodID/jfieldID 与 jobject 没有继承关系，它只是个整数。

内存管理

内存管理指的是native创建的java释放的问题。基本原则：如果创建的对象不返回java，就需要delete掉。

全局对象不会被java回收，所以 NewGlobalRef/DeleteGlobalRef 需要配套使用。

从java对象里的到的指针也必须手动释放，举例

const char* str = env->GetStringUTFChars(jstr, NULL);
// do something
env->ReleaseStringUTFChars(jstr, str);

除了NewXXX，在栈内创建的对象，如果没有返回给java，也需要Delete，比如：

FindClass
NewString/ NewStringUTF/NewObject/NewByteArray
GetObjectField/GetObjectClass/GetObjectArrayElement
GetByteArrayElements/GetStringUTFChars

上面的代码也印证了，在java和native之间传递大量传递数据，并不是一个很明智的做法。因为JNI层必须拷贝一份后才能访问

我们可以把native的指针，保存在java的一个 long 类型的属性中，在需要的时候，调JNI的方法在native层去释放。