整理一个EOE的JNI实例讲解

整理文章

http://www.eoeandroid.com/thread-90559-1-1.html

Android系统不允许一个纯粹使用C/C++的程序出现，它要求必须是通过Java代码嵌入Native C/C++——即通过JNI的方式来使用本地(Native)代码。因此JNI对Android底层开发人员非常重要。

　　如何将.so文件打包到.APK

　　让我们 先 从最简单的情况开始，假如已有一个JNI实现——libxxx.so文件，那么如何在APK中使用它呢?
　　在我最初写类似程序的时候，我会将libxxx.so文件push到/system/lib/目录下，然后在Java代码中执行 System.loadLibrary(xxx)，这是个可行的做法，但需要取得/system/lib 目录 的写权限(模拟器通过adb remount取得该权限)。但模拟器 重启之 后libxxx.so文件会消失。现在 我找到了更好的方法，把.so文件打包到apk中分发给最终用户，不管是模拟器 或者 真机 ，都不再需要system分区的写权限。实现步骤如下：

　　1、在你的项目根目录下建立libs/armeabi目录;
　　2、将libxxx.so文件copy到 libs/armeabi/下;
　　3、此时ADT插件自动编译输出的.apk文件中已经包括.so文件了;
　　4、安装APK文件，即可直接使用JNI中的方法;

　　我想还需要简单说明一下libxxx.so的命名规则，沿袭Linux传统，lib.so是类库文件名称的格式，但在Java的System.loadLibrary(" something ")方法中指定库名称时，不能包括 前缀—— lib，以及后缀——.so。 

       准备编写自己的JNI模块

　　你一定想知道如何编写自己的xxx.so，不过这涉及了太多有关JNI的知识。简单的说：JNI是Java平台定义的用于和宿主平台上的本地代码进行交互的“Java标准”，它通常有两个使用场景：1.使用(之前使用c/c++、delphi开发的)遗留代码;2.为了更好、更直接地与硬件交互并获得更高性能。

　　1、首先创建含有native方法的Java类：

package eoe.demo; 

public final class MyJNI { 
    //native方法, 
    public static native String sayHello(String name); 
}

 2、通过javah命令生成.h文件，内容如下(com_okwap_testjni.h文件)：

/* DO NOT EDIT THIS FILE - it is machine generated */ 
#include 
/* Header for class com_okwap_testjni_MyJNI */ 
#ifndef _Included_com_okwap_testjni_MyJNI 
#define _Included_com_okwap_testjni_MyJNI 
#ifdef __cplusplus extern "C" { 
#endif /* * Class: com_okwap_testjni_MyJNI * Method: sayHello 
* Signature: 

(Ljava/lang/String;)Ljava/lang/String; 
*/ JNIEXPORT jstring JNICALL Java_com_okwap_testjni_MyJNI_sayHello (JNIEnv *, jclass, jstring); #ifdef __cplusplus } #endif #endif

这是一个标准的C语言头文件，其中的JNIEXPORT、JNICALL是JNI关键字(事实上它是没有任何内容的宏，仅用于指示性说明)，而 jint、jstring是JNI环境下对int及java.lang.String类型的映射。这些关键字的定义都可以在jni.h中看到。

　　3、在com_okwap_testjni.c文件中实现以上方法：

#include 
#include 
#include "com_okwap_testjni.h" JNIEXPORT jstring JNICALL Java_com_okwap_testjni_MyJNI_sayHello(JNIEnv* env, jclass, jstring str){ 
//从jstring类型取得c语言环境下的char*类型 
const char* name = (*env)->GetStringUTFChars(env, str, 0); 
//本地常量字符串 
char* hello = "你好，"; 
//动态分配目标字符串空间 
char* result = malloc((strlen(name) + strlen(hello) + 1)*sizeof(char)); 
memset(result,0,sizeof(result)); 
//字符串链接 
strcat(result,hello); strcat(result,name); 
//释放jni分配的内存 
(*env)->ReleaseStringUTFChars(env,str,name); 
//生成返回值对象 
str = (*env)->NewStringUTF(env, "你好 JNI~!"); 
//释放动态分配的内存 
free(result); 
// return str; 
}

 4、编译两种不同的编译环境

　　以上的C语言代码要编译成最终.so动态库文件，有两种途径：

　　Android NDK ：全称是Native Developer Kit，是用于编译本地JNI源码的工具，为开发人员将本地方法整合到Android应用中提供了方便。事实上NDK和完整源码编译环境一样，都使用Android的编译系统——即通过Android.mk文件控制编译。NDK可以运行在Linux、Mac、Window(+cygwin)三个平台上。有关NDK的使用方法及更多细节请参考以下资料：

　   不管你选择以上两种方法的哪一个，都必须编写自己的Android.mk文件，有关该文件的编写请参考相关文档。

　    JNI组件的入口函数——JNI_OnLoad()、JNI_OnUnload()
　　JNI组件被成功加载和卸载时，会进行函数回调，当VM执行到System.loadLibrary(xxx)函数时，首先会去执行JNI组件中的JNI_OnLoad()函数，而当VM释放该组件时会呼叫JNI_OnUnload()函数。先看示例代码：

//onLoad方法，在System.loadLibrary()执行时被调用 
jint JNI_OnLoad(JavaVM* vm, void* reserved){ 
LOGI("JNI_OnLoad startup~~!"); 
return JNI_VERSION_1_4; 
} 
//onUnLoad方法，在JNI组件被释放时调用 
void JNI_OnUnload(JavaVM* vm, void* reserved){ 
LOGE("call JNI_OnUnload ~~!!"); 

}

JNI_OnLoad()有两个重要的作用：

　　指定JNI版本：告诉VM该组件使用那一个JNI版本(若未提供JNI_OnLoad()函数，VM会默认该使用最老的JNI 1.1版)，如果要使用新版本的JNI，例如JNI 1.4版，则必须由JNI_OnLoad()函数返回常量JNI_VERSION_1_4(该常量定义在jni.h中) 来告知VM。

　　初始化设定，当VM执行到System.loadLibrary()函数时，会立即先呼叫JNI_OnLoad()方法，因此在该方法中进行各种资源的初始化操作最为恰当。

　　JNI_OnUnload()的作用与JNI_OnLoad()对应，当VM释放JNI组件时会呼叫它，因此在该方法中进行善后清理，资源释放的动作最为合适。

　　 使用registerNativeMethods方法

　　对Java程序员来说，可能我们总是会遵循：

       1.编写带有native方法的Java类;
       2.使用javah命令生成.h头文件;
       3.编写代码实现头文件中的方法，这样的“官方” 流程，但也许有人无法忍受那“丑陋”的方法名称，RegisterNatives方法能帮助你把c/c++中的方法隐射到Java中的native方法，而无需遵循特定的方法命名格式。来看一段示例代码吧：

//定义目标类名称 
static const char *className = "com/okwap/testjni/MyJNI"; 
//定义方法隐射关系 
static JNINativeMethod methods[] = { 
{"sayHello", "(Ljava/lang/String;)Ljava/lang/String;", (void*)sayHello}, }; 
jint JNI_OnLoad(JavaVM* vm, void* reserved){ 
//声明变量 
jint result = JNI_ERR; JNIEnv* env = NULL; 
jclass clazz; 
int methodsLenght; 
//获取JNI环境对象 
if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_4) != JNI_OK) { 
LOGE("ERROR: GetEnv failed "); 
return JNI_ERR; 
} assert(env != NULL); 
//注册本地方法.Load 目标类 
clazz = (*env)->FindClass(env,className); 
if (clazz == NULL) { 
LOGE("Native registration unable to find class '%s'", className); 
return JNI_ERR; 
} 
//建立方法隐射关系 
//取得方法长度 
methodsLenght = sizeof(methods) / sizeof(methods[0]); 
if ((*env)->RegisterNatives(env,clazz, methods, methodsLenght) < 0) { 
LOGE("RegisterNatives failed for '%s'", className); 
return JNI_ERR; 
} 
// result = JNI_VERSION_1_4; 
return result; 
} 

建立c/c++方法和Java方法之间映射关系的关键是 JNINativeMethod 结构，该结构定义在jni.h中，具体定义如下：

typedef struct { 
const char* name;//java方法名称 
const char* signature; //java方法签名 
void* fnPtr;//c/c++的函数指针 
} 
JNINativeMethod 
//参照上文示例中初始化该结构的代码：//定义方法隐射关系 
static JNINativeMethod methods[] = { 
{"sayHello", "(Ljava/lang/String;)Ljava/lang/String;", (void*)sayHello}, }; 

其中比较难以理解的是第二个参数——signature字段的取值，实际上这些字符与函数的参数类型/返回类型一一对应，其中"()" 中的字符表示参数，后面的则代表返回值。例如"()V" 就表示void func()，"(II)V" 表示 void func(int, int)，具体的每一个字符的对应关系如下：字符 Java类型 C/C++类型V void voidZ jboolean booleanI jint intJ jlong longD jdouble doubleF jfloat floatB jbyte byteC jchar charS jshort short数组则以"["开始，用两个字符表示：字符 java类型 c/c++类型[Z jbooleanArray boolean[][I jintArray int[][F jfloatArray float[][B jbyteArray byte[][C jcharArray char[][S jshortArray short[][D jdoubleArray double[][J jlongArray long[]上面的都是基本类型，如果参数是Java类，则以"L"开头，以";"结尾，中间是用"/"隔开包及类名，而其对应的C函数的参数则为 jobject，一个例外是String类，它对应C类型jstring，例如：Ljava/lang /String; 、Ljava/net/Socket; 等，如果JAVA函数位于一个嵌入类(也被称为内部类)，则用$作为类名间的分隔符，

       例如："Landroid/os /FileUtils$FileStatus;"。使用registerNativeMethods方法不仅仅是为了改变那丑陋的长方法名，最重要的是可以提高效率，因为当Java类别透过VM呼叫到本地函数时，通常是依靠VM去动态寻找.so中的本地函数(因此它们才需要特定规则的命名格式)，如果某方法需要连续呼叫很多次，则每次都要寻找一遍，所以使用RegisterNatives将本地函数向VM进行登记，可以让其更有效率的找到函数。registerNativeMethods方法的另一个重要用途是，运行时动态调整本地函数与Java函数值之间的映射关系，只需要多次调用registerNativeMethods()方法，并传入不同的映射表参数即可。JNI中的日志输出你一定非常熟悉在Java代码中使用Log.x(TAG,“message”)系列方法，在c/c++代码中也一样，不过首先你要include相关头文件。遗憾的是你使用不同的编译环境。