JNI由浅入深_4_JNI基础知识详解

Java Native Interface (JNI)标准是java平台的一部分，它允许Java代码和其他语言写的代码进行交互。JNI 是本地编程接口，它使得在 Java 虚拟机 (VM) 内部运行的 Java 代码能够与用其它编程语言(如 C、C++ 和汇编语言)编写的应用程序和库进行交互操作。

1.从如何载入.so档案谈起

由于Android的应用层的类都是以Java写的，这些Java类编译为Dex型式的Bytecode之后，必须靠Dalvik虚拟机(VM: Virtual Machine)来执行。VM在Android平台里，扮演很重要的角色。

此外，在执行Java类的过程中，如果Java类需要与C组件沟通时，VM就会去载入C组件，然后让Java的函数顺利地调用到C组件的函数。此时，VM扮演着桥梁的角色，让Java与C组件能通过标准的JNI介面而相互沟通。

应用层的Java类是在虚拟机(VM: Vitual Machine)上执行的，而C件不是在VM上执行，那么Java程式又如何要求VM去载入(Load)所指定的C组件呢? 可使用下述指令：

System.loadLibrary(*.so的档案名);

例如，Android框架里所提供的MediaPlayer.java类，含指令：

public class MediaPlayer{

static {

System.loadLibrary("media_jni");

}

}

这要求VM去载入Android的/system/lib/libmedia_jni.so档案。载入*.so之后，Java类与*.so档案就汇合起来，一起执行了。

2.如何撰写*.so的入口函数

---- JNI_OnLoad()与JNI_OnUnload()函数的用途

当Android的VM(Virtual Machine)执行到System.loadLibrary()函数时，首先会去执行C组件里的JNI_OnLoad()函数。它的用途有二：

(1)告诉VM此C组件使用那一个JNI版本。如果你的*.so档没有提供JNI_OnLoad()函数，VM会默认该*.so档是使用最老的JNI 1.1版本。由于新版的JNI做了许多扩充，如果需要使用JNI的新版功能，例如JNI 1.4的java.nio.ByteBuffer,就必须藉由JNI_OnLoad()函数来告知VM。

(2)由于VM执行到System.loadLibrary()函数时，就会立即先呼叫JNI_OnLoad()，所以C组件的开发者可以藉由JNI_OnLoad()来进行C组件内的初期值之设定(Initialization)。

例如，在Android的/system/lib/libmedia_jni.so档案里，就提供了JNI_OnLoad()函数，其程式码片段为：

//#defineLOG_NDEBUG 0
#define LOG_TAG"MediaPlayer-JNI"
jint JNI_OnLoad(JavaVM* vm, void* reserved)
{
   JNIEnv* env = NULL;
   jint result = -1;

   if (vm->GetEnv((void**) &env, JNI_VERSION_1_4) != JNI_OK) {
       LOGE("ERROR: GetEnv failed\n");
       goto bail;
    }

assert(env != NULL);

   if (register_android_media_MediaPlayer(env) < 0) {
       LOGE("ERROR: MediaPlayer native registration failed\n");
       goto bail;
    }

   if (register_android_media_MediaRecorder(env) < 0) {
       LOGE("ERROR: MediaRecorder native registration failed\n");
       goto bail;
    }

   if (register_android_media_MediaScanner(env) < 0) {
       LOGE("ERROR: MediaScanner native registration failed\n");
       goto bail;
}

   if (register_android_media_MediaMetadataRetriever(env) < 0) {
       LOGE("ERROR: MediaMetadataRetriever native registrationfailed\n");
       goto bail;
    }

   /* success -- return valid version number */
   result = JNI_VERSION_1_4;
bail:
   return result;
}

此函数回传JNI_VERSION_1_4值给VM，于是VM知道了其所使用的JNI版本了。此外，它也做了一些初期的动作(可呼叫任何本地函数)，例如指令：

if(register_android_media_MediaPlayer(env) < 0) {

LOGE("ERROR: MediaPlayer native registration failed\n");

goto bail;

}

就将此组件提供的各个本地函数(NativeFunction)登记到VM里，以便能加快后续呼叫本地函数的效率。

JNI_OnUnload()函数与JNI_OnLoad()相对应的。在载入C组件时会立即呼叫JNI_OnLoad()来进行组件内的初期动作；而当VM释放该C组件时，则会呼叫JNI_OnUnload()函数来进行善后清除动作。当VM呼叫JNI_OnLoad()或JNI_Unload()函数时，都会将VM的指针(Pointer)传递给它们，其参数如下：

jint JNI_OnLoad(JavaVM* vm, void* reserved){     }
jint JNI_OnUnload(JavaVM* vm, void*reserved){     }
在JNI_OnLoad()函数里，就透过VM之指标而取得JNIEnv之指标值，并存入env指标变数里，如下述指令：

jint JNI_OnLoad(JavaVM* vm, void*reserved){
    JNIEnv* env = NULL;
    jint result = -1;
   if (vm->GetEnv((void**) &env, JNI_VERSION_1_4) != JNI_OK) {
         LOGE("ERROR: GetEnv failed\n");
         goto bail;
    }
}

由于VM通常是多执行绪(Multi-threading)的执行环境。每一个执行绪在呼叫JNI_OnLoad()时，所传递进来的JNIEnv指标值都是不同的。为了配合这种多执行绪的环境，C组件开发者在撰写本地函数时，可藉由JNIEnv指标值之不同而避免执行绪的资料冲突问题，才能确保所写的本地函数能安全地在Android的多执行绪VM里安全地执行。基于这个理由，当在呼叫C组件的函数时，都会将JNIEnv指标值传递给它，如下：

jint JNI_OnLoad(JavaVM* vm, void* reserved)

{

JNIEnv* env = NULL;

if (register_android_media_MediaPlayer(env) < 0) {

}

}

这JNI_OnLoad()呼叫register_android_media_MediaPlayer(env)函数时，就将env指标值传递过去。如此，在register_android_media_MediaPlayer()函数就能藉由该指标值而区别不同的执行绪，以便化解资料冲突的问题。

　例如，在register_android_media_MediaPlayer()函数里，可撰写下述指令：

if ((*env)->MonitorEnter(env, obj) != JNI_OK) {

}

查看是否已经有其他执行绪进入此物件，如果没有，此执行绪就进入该物件里执行了。还有，也可撰写下述指令：

if ((*env)->MonitorExit(env, obj) != JNI_OK) {

}

查看是否此执行绪正在此物件内执行，如果是，此执行绪就会立即离开。

3.registerNativeMethods()函数的用途

应用层级的Java类别透过VM而呼叫到本地函数。一般是仰赖VM去寻找*.so里的本地函数。如果需要连续呼叫很多次，每次都需要寻找一遍，会多花许多时间。此时，组件开发者可以自行将本地函数向VM进行登记。例如，在Android的/system/lib/libmedia_jni.so档案里的代码段如下：

//#define LOG_NDEBUG 0
#define LOG_TAG "MediaPlayer-JNI"
static JNINativeMethod gMethods[] = {
   {"setDataSource",  "(Ljava/lang/String;)V",
    (void *)android_media_MediaPlayer_setDataSource},
   {"setDataSource",   "(Ljava/io/FileDescriptor;JJ)V",
(void *)android_media_MediaPlayer_setDataSourceFD},
   {"prepare",  "()V",     (void*)android_media_MediaPlayer_prepare},
   {"prepareAsync",  "()V",   (void*)android_media_MediaPlayer_prepareAsync},
   {"_start",  "()V",   (void*)android_media_MediaPlayer_start},
   {"_stop",  "()V",    (void*)android_media_MediaPlayer_stop},
   {"getVideoWidth",  "()I",      (void*)android_media_MediaPlayer_getVideoWidth},
   {"getVideoHeight",  "()I",      (void*)android_media_MediaPlayer_getVideoHeight},
   {"seekTo",         "(I)V",      (void*)android_media_MediaPlayer_seekTo},
   {"_pause",         "()V",       (void*)android_media_MediaPlayer_pause},
   {"isPlaying",       "()Z",       (void*)android_media_MediaPlayer_isPlaying},
   {"getCurrentPosition", "()I",  (void*)android_media_MediaPlayer_getCurrentPosition},
   {"getDuration",     "()I",     (void*)android_media_MediaPlayer_getDuration},
   {"_release",        "()V",      (void*)android_media_MediaPlayer_release},
   {"_reset",           "()V",        (void*)android_media_MediaPlayer_reset},
   {"setAudioStreamType","(I)V", (void*)android_media_MediaPlayer_setAudioStreamType},
   {"setLooping",     "(Z)V",      (void*)android_media_MediaPlayer_setLooping},
   {"setVolume",     "(FF)V",     (void*)android_media_MediaPlayer_setVolume},
   {"getFrameAt",    "(I)Landroid/graphics/Bitmap;",
        (void *)android_media_MediaPlayer_getFrameAt},
   {"native_setup",   "(Ljava/lang/Object;)V",
          (void *)android_media_MediaPlayer_native_setup},
   {"native_finalize",    "()V",    (void*)android_media_MediaPlayer_native_finalize},
};

static intregister_android_media_MediaPlayer(JNIEnv *env){
   return AndroidRuntime::registerNativeMethods(env,
                "android/media/MediaPlayer",gMethods, NELEM(gMethods));
}

jint JNI_OnLoad(JavaVM* vm, void*reserved){
   if (register_android_media_MediaPlayer(env) < 0) {
       LOGE("ERROR: MediaPlayer native registration failed\n");
       goto bail;
    }
}

当VM载入libmedia_jni.so档案时，就呼叫JNI_OnLoad()函数。接着，JNI_OnLoad()呼叫register_android_media_MediaPlayer()函数。此时，就呼叫到AndroidRuntime::registerNativeMethods()函数，向VM(即AndroidRuntime)登记gMethods[]表格所含的本地函数了。简而言之，registerNativeMethods()函数的用途有二：

(1)更有效率去找到函数。

(2)可在执行期间进行抽换。由于gMethods[]是一个<名称，函数指针>对照表，在程序执行时，可多次呼叫registerNativeMethods()函数来更换本地函数之指针，而达到弹性抽换本地函数之目的。

4.Andoird 中使用了一种不同传统Java JNI的方式来定义其native的函数。

其中很重要的区别是Andorid使用了一种Java 和 C 函数的映射表数组，并在其中描述了函数的参数和返回值。这个数组的类型是JNINativeMethod，定义如下：

typedef struct {

const char* name;            /*Java中函数的名字*/

const char* signature;      /*描述了函数的参数和返回值*/

void* fnPtr;               /*函数指针，指向C函数*/

} JNINativeMethod;

其中比较难以理解的是第二个参数，例如

"()V"

"(II)V"

"(Ljava/lang/String;Ljava/lang/String;)V"

实际上这些字符是与函数的参数类型一一对应的。

"()" 中的字符表示参数，后面的则代表返回值。例如"()V"就表示voidFunc();

"(II)V" 表示 void Func(int, int);

具体的每一个字符的对应关系如下

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

数组则以"["开始，用两个字符表示

[I    jintArray       int[]
[F    jfloatArray     float[]
[B    jbyteArray     byte[]
[C   jcharArray      char[]
[S   jshortArray      short[]
[D   jdoubleArray    double[]
[J    jlongArray      long[]
[Z   jbooleanArray    boolean[]

上面的都是基本类型。如果Java函数的参数是class，则以"L"开头，以";"结尾，中间是用"/" 隔开的包及类名。而其对应的C函数名的参数则为jobject. 一个例外是String类，其对应的类为jstring

Ljava/lang/String; String jstring

Ljava/net/Socket; Socket jobject

如果JAVA函数位于一个嵌入类，则用$作为类名间的分隔符。

例如"(Ljava/lang/String;Landroid/os/FileUtils$FileStatus;)Z"。

5、JNI中常用的方法汇总

打开android-ndk-r9d\platforms\android-18\arch-arm\usr\include目录下的jni.h文件，在这个文件里面就可以看到很多的方法供我们调用，仔细发现这些方法其实都有一个共同点，只要会应用其中的一个方法，那么类似的方法也就可以达到举一反三的效果。下面主要介绍方法的用途，对于具体的方法大家可以查看相关文档。

5.1  类型对应的字母

下面的结构体表示了数据类型所对应的字母，就是上面的 "(II)V" 表示 void Func(int, int);

typedef union jvalue {
    jboolean    z;
    jbyte       b;
    jchar       c;
    jshort      s;
    jint        i;
    jlong       j;
    jfloat      f;
    jdouble     d;
    jobject     l;
} jvalue;

5.2  以New开发的方法

以new开发的方法一般都是创建一个对象或者数组等。

//创建一个jobject对象，jmethodID是方法id，可以找到该对象的构造函数
    jobject     (*NewObject)(JNIEnv*, jclass, jmethodID, ...);
	//创建一个jstring对象
	jstring     (*NewString)(JNIEnv*, const jchar*, jsize);
    jstring     (*NewStringUTF)(JNIEnv*, const char*);
	//下面都是创建一个数组，jsize类型是JNI提供的，它最终的类型还是jint
    jobjectArray (*NewObjectArray)(JNIEnv*, jsize, jclass, jobject);
    jbooleanArray (*NewBooleanArray)(JNIEnv*, jsize);
    jbyteArray    (*NewByteArray)(JNIEnv*, jsize);
    jcharArray    (*NewCharArray)(JNIEnv*, jsize);
    jshortArray   (*NewShortArray)(JNIEnv*, jsize);
    jintArray     (*NewIntArray)(JNIEnv*, jsize);
    jlongArray    (*NewLongArray)(JNIEnv*, jsize);
    jfloatArray   (*NewFloatArray)(JNIEnv*, jsize);
    jdoubleArray  (*NewDoubleArray)(JNIEnv*, jsize);

5.3 以Get或Set开始的方法

get开始的方法是获取对象的值，set开发的方法是给对象设置值。

//获取obj对象的字段名称为fieldName，字段类型为fieldType的字段ID。比如(*env)->GetFieldID(env, personClass, "name","Ljava/lang/String;")。
	jfieldID    (*GetFieldID)(JNIEnv*, jclass obj, const char* fieldName, const char* fieldType);
	//获取obj对象字段ID为fieldId的值
    jobject     (*GetObjectField)(JNIEnv*, jobject obj, jfieldID fieldId);
    jboolean    (*GetBooleanField)(JNIEnv*, jobject, jfieldID);
    jbyte       (*GetByteField)(JNIEnv*, jobject, jfieldID);
    jchar       (*GetCharField)(JNIEnv*, jobject, jfieldID);
    jshort      (*GetShortField)(JNIEnv*, jobject, jfieldID);
    jint        (*GetIntField)(JNIEnv*, jobject, jfieldID);
    jlong       (*GetLongField)(JNIEnv*, jobject, jfieldID);
    jfloat      (*GetFloatField)(JNIEnv*, jobject, jfieldID) __NDK_FPABI__;
    jdouble     (*GetDoubleField)(JNIEnv*, jobject, jfieldID) __NDK_FPABI__;
	//给obj对象字段ID为fieldId的属性设值，比如(*env)->SetObjectField(env, mPerson, field_name, (*env)->NewStringUTF(env,"val native"));
    void        (*SetObjectField)(JNIEnv*, jobject obj, jfieldID fieldId, jobject val);
    void        (*SetBooleanField)(JNIEnv*, jobject, jfieldID, jboolean);
    void        (*SetByteField)(JNIEnv*, jobject, jfieldID, jbyte);
    void        (*SetCharField)(JNIEnv*, jobject, jfieldID, jchar);
    void        (*SetShortField)(JNIEnv*, jobject, jfieldID, jshort);
    void        (*SetIntField)(JNIEnv*, jobject, jfieldID, jint);
    void        (*SetLongField)(JNIEnv*, jobject, jfieldID, jlong);
    void        (*SetFloatField)(JNIEnv*, jobject, jfieldID, jfloat) __NDK_FPABI__;
    void        (*SetDoubleField)(JNIEnv*, jobject, jfieldID, jdouble) __NDK_FPABI__;

	//下面静态属性。
	jobject     (*GetStaticObjectField)(JNIEnv*, jclass, jfieldID);
    jboolean    (*GetStaticBooleanField)(JNIEnv*, jclass, jfieldID);
    jbyte       (*GetStaticByteField)(JNIEnv*, jclass, jfieldID);
    jchar       (*GetStaticCharField)(JNIEnv*, jclass, jfieldID);
    jshort      (*GetStaticShortField)(JNIEnv*, jclass, jfieldID);
    jint        (*GetStaticIntField)(JNIEnv*, jclass, jfieldID);
    jlong       (*GetStaticLongField)(JNIEnv*, jclass, jfieldID);
    jfloat      (*GetStaticFloatField)(JNIEnv*, jclass, jfieldID) __NDK_FPABI__;
    jdouble     (*GetStaticDoubleField)(JNIEnv*, jclass, jfieldID) __NDK_FPABI__;

    void        (*SetStaticObjectField)(JNIEnv*, jclass, jfieldID, jobject);
    void        (*SetStaticBooleanField)(JNIEnv*, jclass, jfieldID, jboolean);
    void        (*SetStaticByteField)(JNIEnv*, jclass, jfieldID, jbyte);
    void        (*SetStaticCharField)(JNIEnv*, jclass, jfieldID, jchar);
    void        (*SetStaticShortField)(JNIEnv*, jclass, jfieldID, jshort);
    void        (*SetStaticIntField)(JNIEnv*, jclass, jfieldID, jint);
    void        (*SetStaticLongField)(JNIEnv*, jclass, jfieldID, jlong);
    void        (*SetStaticFloatField)(JNIEnv*, jclass, jfieldID, jfloat) __NDK_FPABI__;
    void        (*SetStaticDoubleField)(JNIEnv*, jclass, jfieldID, jdouble) __NDK_FPABI__;

	//获取数组长度
	jboolean*   (*GetBooleanArrayElements)(JNIEnv*, jbooleanArray, jboolean*);
    jbyte*      (*GetByteArrayElements)(JNIEnv*, jbyteArray, jboolean*);
    jchar*      (*GetCharArrayElements)(JNIEnv*, jcharArray, jboolean*);
    jshort*     (*GetShortArrayElements)(JNIEnv*, jshortArray, jboolean*);
    jint*       (*GetIntArrayElements)(JNIEnv*, jintArray, jboolean*);
    jlong*      (*GetLongArrayElements)(JNIEnv*, jlongArray, jboolean*);
    jfloat*     (*GetFloatArrayElements)(JNIEnv*, jfloatArray, jboolean*);
    jdouble*    (*GetDoubleArrayElements)(JNIEnv*, jdoubleArray, jboolean*);

	//获取方法ID
	jmethodID   (*GetStaticMethodID)(JNIEnv*, jclass, const char*, const char*);

5.4 call开始的方法

以call开始的方法主要用于c调用Java的方法，常用于回调函数。

jobject     (*CallObjectMethod)(JNIEnv*, jobject, jmethodID, ...);
    jobject     (*CallObjectMethodV)(JNIEnv*, jobject, jmethodID, va_list);
    jobject     (*CallObjectMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);
    jboolean    (*CallBooleanMethod)(JNIEnv*, jobject, jmethodID, ...);
    jboolean    (*CallBooleanMethodV)(JNIEnv*, jobject, jmethodID, va_list);
    jboolean    (*CallBooleanMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);
    jbyte       (*CallByteMethod)(JNIEnv*, jobject, jmethodID, ...);
    jbyte       (*CallByteMethodV)(JNIEnv*, jobject, jmethodID, va_list);
    jbyte       (*CallByteMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);
    jchar       (*CallCharMethod)(JNIEnv*, jobject, jmethodID, ...);
    jchar       (*CallCharMethodV)(JNIEnv*, jobject, jmethodID, va_list);
    jchar       (*CallCharMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);
    jshort      (*CallShortMethod)(JNIEnv*, jobject, jmethodID, ...);
    jshort      (*CallShortMethodV)(JNIEnv*, jobject, jmethodID, va_list);
    jshort      (*CallShortMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);
    jint        (*CallIntMethod)(JNIEnv*, jobject, jmethodID, ...);
    jint        (*CallIntMethodV)(JNIEnv*, jobject, jmethodID, va_list);
    jint        (*CallIntMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);
    jlong       (*CallLongMethod)(JNIEnv*, jobject, jmethodID, ...);
    jlong       (*CallLongMethodV)(JNIEnv*, jobject, jmethodID, va_list);
    jlong       (*CallLongMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);
    jfloat      (*CallFloatMethod)(JNIEnv*, jobject, jmethodID, ...) __NDK_FPABI__;
    jfloat      (*CallFloatMethodV)(JNIEnv*, jobject, jmethodID, va_list) __NDK_FPABI__;
    jfloat      (*CallFloatMethodA)(JNIEnv*, jobject, jmethodID, jvalue*) __NDK_FPABI__;
    jdouble     (*CallDoubleMethod)(JNIEnv*, jobject, jmethodID, ...) __NDK_FPABI__;
    jdouble     (*CallDoubleMethodV)(JNIEnv*, jobject, jmethodID, va_list) __NDK_FPABI__;
    jdouble     (*CallDoubleMethodA)(JNIEnv*, jobject, jmethodID, jvalue*) __NDK_FPABI__;
    void        (*CallVoidMethod)(JNIEnv*, jobject, jmethodID, ...);
    void        (*CallVoidMethodV)(JNIEnv*, jobject, jmethodID, va_list);
    void        (*CallVoidMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);

    jobject     (*CallStaticObjectMethod)(JNIEnv*, jclass, jmethodID, ...);
    jobject     (*CallStaticObjectMethodV)(JNIEnv*, jclass, jmethodID, va_list);
    jobject     (*CallStaticObjectMethodA)(JNIEnv*, jclass, jmethodID, jvalue*);
    jboolean    (*CallStaticBooleanMethod)(JNIEnv*, jclass, jmethodID, ...);
    jboolean    (*CallStaticBooleanMethodV)(JNIEnv*, jclass, jmethodID,

5.5 release开始的方法

用于释放资源。

 void ReleaseBooleanArrayElements(jbooleanArray array, jboolean* elems,
        jint mode)
    { functions->ReleaseBooleanArrayElements(this, array, elems, mode); }
    void ReleaseByteArrayElements(jbyteArray array, jbyte* elems,
        jint mode)
    { functions->ReleaseByteArrayElements(this, array, elems, mode); }
    void ReleaseCharArrayElements(jcharArray array, jchar* elems,
        jint mode)
    { functions->ReleaseCharArrayElements(this, array, elems, mode); }
    void ReleaseShortArrayElements(jshortArray array, jshort* elems,
        jint mode)
    { functions->ReleaseShortArrayElements(this, array, elems, mode); }
    void ReleaseIntArrayElements(jintArray array, jint* elems,
        jint mode)
    { functions->ReleaseIntArrayElements(this, array, elems, mode); }
    void ReleaseLongArrayElements(jlongArray array, jlong* elems,
        jint mode)
    { functions->ReleaseLongArrayElements(this, array, elems, mode); }
    void ReleaseFloatArrayElements(jfloatArray array, jfloat* elems,
        jint mode)