Android JNI详述(一)

Android 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() 函数，其程式码片段为：
　　
　　//#define LOG_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 registration failed\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;
　　
　　 }
　　
　　就将此组件提供的各个本地函数(Native Function) 登记到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 int register_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" 就表示void Func();
　　
　　"(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"