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类，含指令：

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()函数，其程式码片段为：

Java代码：

//#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 ");goto bail;}assert(env != NULL);if (register_android_media_MediaPlayer(env) < 0) {LOGE("ERROR: MediaPlayer native registration failed ");goto bail;}if (register_android_media_MediaRecorder(env) < 0) {LOGE("ERROR: MediaRecorder native registration failed ");goto bail;}if (register_android_media_MediaScanner(env) < 0) {LOGE("ERROR: MediaScanner native registration failed ");goto bail;}if (register_android_media_MediaMetadataRetriever(env) < 0) {LOGE("ERROR: MediaMetadataRetriever native registration failed ");goto bail;}result = JNI_VERSION_1_4;bail:return result;}

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

Java代码：

if (register_android_media_MediaPlayer(env) < 0) {LOGE("ERROR: MediaPlayer native registration failed ");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指标变数里，如下述指令：

Java代码：

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 "); goto bail; } }

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

Java代码：

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档案里的代码段如下：

java代码：

//#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));}

java代码：

jint JNI_OnLoad(JavaVM* vm, void* reserved){if (register_android_media_MediaPlayer(env) < 0) {LOGE("ERROR: MediaPlayer native registration failed ");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，定义如下：

java代码：

typedef struct {const char* name;const char* signature;void* fnPtr;} JNINativeMethod;

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

java代码：

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

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

　　"()" 中的字符表示参数，后面的则代表返回值。例如"()V" 就表示void Func();
　　"(II)V" 表示 void Func(int, int);
　　具体的每一个字符的对应关系如下
　　字符 Java类型 C类型

java代码：

V void voidZ jboolean booleanI jint intJ jlong longD jdouble doubleF jfloat floatB jbyte byteC jchar charS jshort short

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

java代码：

[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"

　　Android JNI编程实践

　　一、直接使用java本身jni接口(windows/ubuntu)

　　1.在Eclipsh中新建一个android应用程序。两个类：一个继承于Activity，UI显示用。另一个包含native方法。编译生成所有类。

java代码：

package eoe.jnitest;import android.app.Activity;import android.os.Bundle;public class jnitest extends Activity {@Overridepublic void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.main);Nadd cal = new Nadd();setTitle("The Native Add Result is " + String.valueOf(cal.nadd(10, 19)));}}//Nadd.java文件：package eoe.jnitest;public class Nadd {static {System.loadLibrary ("Nadd");}public native int nadd(int a, int b);}

使用javah命令生成C/C++的.h文件。注意类要包含包名，路径文件夹下要包含所有包中的类，否则会报找不到类的错误。classpath参数指定到包名前一级文件夹，文件夹层次结构要符合java类的组织层次结构。

java代码：

#include #ifndef _Included_com_hello_jnitest_Nadd#define _Included_com_hello_jnitest_Nadd#ifdef __cplusplusextern "C" {#endifJNIEXPORT jint JNICALL Java_com_hello_jnitest_Nadd_nadd(JNIEnv *, jobject, jint, jint);#ifdef __cplusplus}

3.编辑.c文件实现native方法。
　　com_hello_jnitest_Nadd.c文件：

java代码：

#include #include "com_hello_jnitest_Nadd.h"JNIEXPORT jint JNICALL Java_com_hello_jnitest_Nadd_nadd(JNIEnv * env, jobject c, jint a, jint b){return (a+b);}

4.编译.c文件生存动态库。

arm-none-linux-gnueabi-gcc -I/home/a/work/android/jdk1.6.0_17/include -I/home/a/work/android/jdk1.6.0_17/include/linux -fpic -c com_hello_jnitest_Nadd.c

　　 arm-none-linux-gnueabi-ld -T/home/a/CodeSourcery/Sourcery_G++_Lite/arm-none-linux-gnueabi/lib/ldscripts/armelf_linux_eabi.xsc -share -o libNadd.so com_hello_jnitest_Nadd.o

得到libNadd.so文件。
　　以上在ubuntu中完成。

5.将相应的动态库文件push到avd的system/lib中:adb push libNadd.so /system/lib。若提示Read-only file system错误，运行adb remount命令，即可。

　　Adb push libNadd.so /system/lib

　　6.在eclipsh中运行原应用程序即可。

　对于一中生成的so文件也可采用二中的方法编译进apk包中。只需在工程文件夹中建libsarmeabi文件夹(其他文件夹名无效，只建立libs文件夹也无效)，然后将so文件拷入，编译工程即可。

二.使用NDK生成本地方法(ubuntu and windows)

　　1.安装NDK：解压，然后进入NDK解压后的目录，运行build/host-setup.sh(需要Make 3.81和awk)。若有错，修改host-setup.sh文件：将#!/bin/sh修改为#!/bin/bash，再次运行即可。

　　2.在apps文件夹下建立自己的工程文件夹，然后在该文件夹下建一文件Application.mk和项project文件夹。

java代码：

Application.mk文件：APP_PROJECT_PATH := $(call my-dir)/projectAPP_MODULES := myjni

3.在project文件夹下建一jni文件夹，然后新建Android.mk和myjni.c。这里不需要用javah生成相应的.h文件，但函数名要包含相应的完整的包、类名。

　　4.编辑相应文件内容。

　 Android.mk文件：

java代码：

# Copyright (C) 2009 The Android Open Source Project## Licensed under the Apache License, Version 2.0 (the "License");# you may not use this file except in compliance with the License.# You may obtain a copy of the License at# Unless required by applicable law or agreed to in writing, software# distributed under the License is distributed on an "AS IS" BASIS,# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.# See the License for the specific language governing permissions and# limitations under the License.#LOCAL_PATH := $(call my-dir)include $(CLEAR_VARS)LOCAL_MODULE := myjniLOCAL_SRC_FILES := myjni.cinclude $(BUILD_SHARED_LIBRARY)//myjni.c文件：#include jstringJava_com_hello_NdkTest_NdkTest_stringFromJNI( JNIEnv* env,jobject thiz ){return (*env)->NewStringUTF(env, "Hello from My-JNI !");}//myjni文件组织：[email protected]:~/work/android/ndk-1.6_r1/apps$ tree myjnimyjni|-- Application.mk`-- project|-- jni| |-- Android.mk| `-- myjni.c`-- libs`-- armeabi`-- libmyjni.so

4 directories, 4 files

　　5.编译：make APP=myjni.

　　以上内容在ubuntu完成。以下内容在windows中完成。当然也可以在ubuntu中完成。

　　6.在eclipsh中创建android application。将myjni中自动生成的libs文件夹拷贝到当前工程文件夹中，编译运行即可。

Java代码：

package eoe.demo;import android.app.Activity;import android.os.Bundle;import android.widget.TextView;public class NdkTest extends Activity {@Overridepublic void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);TextView tv = new TextView(this);tv.setText( stringFromJNI() );setContentView(tv);}public native String stringFromJNI();static {System.loadLibrary("myjni");}}

对于二中生成的so文件也可采用一中的方法push到avd中运行。

　　本篇将介绍在JNI编程中如何传递参数和返回值。

　　首先要强调的是，native方法不但可以传递Java的基本类型做参数，还可以传递更复杂的类型，比如String，数组，甚至自定义的类。这一切都可以在jni.h中找到答案。

　　 1. Java基本类型的传递

　　用过Java的人都知道，Java中的基本类型包括boolean，byte，char，short，int，long，float，double 这样几种，如果你用这几种类型做native方法的参数，当你通过javah -jni生成.h文件的时候，只要看一下生成的.h文件，就会一清二楚，这些类型分别对应的类型是 jboolean，jbyte，jchar，jshort，jint，jlong，jfloat，jdouble 。这几种类型几乎都可以当成对应的C++类型来用，所以没什么好说的。

　　2. String参数的传递

　　Java的String和C++的string是不能对等起来的，所以处理起来比较麻烦。先看一个例子，

Java代码：

class Prompt {// native method that prints a prompt and reads a lineprivate native String getLine(String prompt);public static void main(String args[]) {Prompt p = new Prompt();String input = p.getLine("Type a line: ");System.out.println("User typed: " + input);}static {System.loadLibrary("Prompt");}}

在这个例子中，我们要实现一个native方法 String getLine(String prompt);

　　读入一个String参数，返回一个String值。
　　通过执行javah -jni得到的头文件是这样的

Java代码：

#include #ifndef _Included_Prompt#define _Included_Prompt#ifdef __cplusplusextern "C" {#endifJNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject this, jstring prompt);#ifdef __cplusplus}#endif#endif

jstring是JNI中对应于String的类型，但是和基本类型不同的是，jstring不能直接当作C++的string用。如果你用cout << prompt << endl;

　　编译器肯定会扔给你一个错误信息的。

　　其实要处理jstring有很多种方式，这里只讲一种我认为最简单的方式，看下面这个例子，

Java代码：

#include "Prompt.h"#include JNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject obj, jstring prompt){const char* str;str = env->GetStringUTFChars(prompt, false);if(str == NULL) {return NULL;}std::cout << str << std::endl;env->ReleaseStringUTFChars(prompt, str);char* tmpstr = "return string succeeded";jstring rtstr = env->NewStringUTF(tmpstr);return rtstr;}

在上面的例子中，作为参数的prompt不能直接被C++程序使用，先做了如下转换
　　str = env->GetStringUTFChars(prompt, false);
　　将jstring类型变成一个char*类型。
　　返回的时候，要生成一个jstring类型的对象，也必须通过如下命令，
　　jstring rtstr = env->NewStringUTF(tmpstr);
　　这里用到的GetStringUTFChars和NewStringUTF都是JNI提供的处理String类型的函数，还有其他的函数这里就不一一列举了。
3. 数组类型的传递

　　和String一样，JNI为Java基本类型的数组提供了j*Array类型，比如int[]对应的就是jintArray。来看一个传递int数组的例子，

Java代码：

JNIEXPORT jint JNICALL Java_IntArray_sumArray(JNIEnv *env, jobject obj, jintArray arr){jint *carr;carr = env->GetIntArrayElements(arr, false);if(carr == NULL) {return 0;}jint sum = 0;for(int i=0; i<10; i++) {sum += carr[i];}env->ReleaseIntArrayElements(arr, carr, 0);return sum;}

这个例子中的GetIntArrayElements和ReleaseIntArrayElements函数就是JNI提供用于处理int数组的函数。如果试图用arr的方式去访问jintArray类型，毫无疑问会出错。JNI还提供了另一对函数GetIntArrayRegion和 ReleaseIntArrayRegion访问int数组，就不介绍了，对于其他基本类型的数组，方法类似。

　　 4. 二维数组和String数组

　　在JNI中，二维数组和String数组都被视为object数组，因为数组和String被视为object。仍然用一个例子来说明，这次是一个二维int数组，作为返回值。

Java代码：

JNIEXPORT jobjectArray JNICALL Java_ObjectArrayTest_initInt2DArray(JNIEnv *env, jclass cls, int size){jobjectArray result;jclass intArrCls = env->FindClass("[I");result = env->NewObjectArray(size, intArrCls, NULL);for (int i = 0; i < size; i++) {jint tmp[256];jintArray iarr = env->NewIntArray(size);for(int j = 0; j < size; j++) {tmp[j] = i + j;}env->SetIntArrayRegion(iarr, 0, size, tmp);env->SetObjectArrayElement(result, i, iarr);env->DeleteLocalRef(iarr);}return result;}

上面代码中的第三行，
　　jobjectArray result;

　　因为要返回值，所以需要新建一个jobjectArray对象。
　　jclass intArrCls = env->FindClass("[I");

　　是创建一个jclass的引用，因为 result的元素是一维int数组的引用，所以intArrCls必须是一维int数组的引用，这一点是如何保证的呢?注意FindClass的参数" [I"，JNI就是通过它来确定引用的类型的，I表示是int类型，[标识是数组。对于其他的类型，都有相应的表示方法，

Java代码：

Z booleanB byteC charS shortI intJ longF floatD double

String是通过“Ljava/lang/String;”表示的，那相应的，String数组就应该是“[Ljava/lang/String;”。
　　还是回到代码，
　　result = env->NewObjectArray(size, intArrCls, NULL);
　　的作用是为result分配空间。
　　jintArray iarr = env->NewIntArray(size);
　　是为一维int数组iarr分配空间。
　　env->SetIntArrayRegion(iarr, 0, size, tmp);
　　是为iarr赋值。
　　env->SetObjectArrayElement(result, i, iarr);
　　是为result的第i个元素赋值。

通过上面这些步骤，我们就创建了一个二维int数组，并赋值完毕，这样就可以做为参数返回了。

　　如果了解了上面介绍的这些内容，基本上大部分的任务都可以对付了。虽然在操作数组类型，尤其是二维数组和String数组的时候，比起在单独的语言中编程要麻烦，但既然我们享受了跨语言编程的好处，必然要付出一定的代价。

　　有一点要补充的是，本文所用到的函数调用方式都是针对C++的，如果要在C中使用，所有的env->都要被替换成(*env)->，而且后面的函数中需要增加一个参数env，具体请看一下jni.h的代码。另外还有些省略的内容，可以参考JNI的文档：Java Native Interface 6.0 Specification，在JDK的文档里就可以找到。如果要进行更深入的JNI编程，需要仔细阅读这个文档。接下来的高级篇，也会讨论更深入的话题。

更多相关文章

随机推荐