JNI转帖

定义

　　JNI是Java Native Interface的缩写，中文为JAVA本地调用。从Java 1.1开始，Java Native Interface (JNI)标准成为java平台的一部分，它允许Java代码和其他语言写的代码进行交互。JNI一开始是为了本地已编译语言，尤其是C和C++而设计的，但是它并不妨碍你使用其他语言，只要调用约定受支持就可以了。

　　使用java与本地已编译的代码交互，通常会丧失平台可移植性。但是，有些情况下这样做是可以接受的，甚至是必须的，比如，使用一些旧的库，与硬件、操作系统进行交互，或者为了提高程序的性能。JNI标准至少保证本地代码能工作在任何Java 虚拟机实现下。

设计目的

　　·标准的java类库可能不支持你的程序所需的特性。

　　·或许你已经有了一个用其他语言写成的库或程序，而你希望在java程序中使用它。

　　·你可能需要用底层语言实现一个小型的时间敏感代码，比如汇编，然后在你的java程序中调用这些功能。

书写步骤

　　·编写带有native声明的方法的java类

　　·使用javac命令编译所编写的java类

　　·使用javah ?jni java类名生成扩展名为h的头文件

　　·使用C/C++实现本地方法

　　·将C/C++编写的文件生成动态连接库

　　·ok

　　1) 编写java程序：这里以HelloWorld为例。

　　代码1：

　　class HelloWorld {

　　public native void displayHelloWorld();

　　static {

　　System.loadLibrary("hello");

　　}

　　public static void main(String[] args) {

　　new HelloWorld().displayHelloWorld();

　　}

　　}

　　声明native方法：如果你想将一个方法做为一个本地方法的话，那么你就必须声明改方法为native的，并且不能实现。其中方法的参数和返回值在后面讲述。 Load动态库：System.loadLibrary("hello");加载动态库（我们可以这样理解：我们的方法 displayHelloWorld()没有实现，但是我们在下面就直接使用了，所以必须在使用之前对它进行初始化）这里一般是以static块进行加载的。同时需要注意的是System.loadLibrary();的参数“hello”是动态库的名字。

　　2) 编译

　　没有什么好说的了 javac HelloWorld.java

　　3) 生成扩展名为h的头文件 javah ?

　　jni HelloWorld 头文件的内容： /* DO NOT EDIT THIS FILE - it is machine generated */

　　1. include

　　/* Header for class HelloWorld */

　　1. ifndef _Included_HelloWorld

　　2. define _Included_HelloWorld

　　3. ifdef __cplusplus

　　extern "C" {

　　1. endif

　　/*

　　* Class: HelloWorld

　　* Method: displayHelloWorld

　　* Signature: ()V

　　* /

　　JNIEXPORT void JNICALL Java_HelloWorld_displayHelloWorld (JNIEnv *, jobject);

　　1. ifdef __cplusplus

　　}

　　1. endif

　　2. endif

　　（这里我们可以这样理解：这个h文件相当于我们在java里面的接口，这里声明了一个 Java_HelloWorld_displayHelloWorld (JNIEnv *, jobject);方法，然后在我们的本地方法里面实现这个方法，也就是说我们在编写C/C++程序的时候所使用的方法名必须和这里的一致）。

　　4) 编写本地方法实现和由javah命令生成的头文件里面声明的方法名相同的方法。

　　代码2：

　　1 #include "jni.h"

　　2 #include "HelloWorld.h"

　　3 //#include other headers

　　4 JNIEXPORT void JNICALL Java_HelloWorld_displayHelloWorld(JNIEnv *env, jobject obj)

　　{

　　printf("Hello world!/n");

　　return;

　　}

　　注意代码2中的第1行，需要将jni.h（该文件可以在%JAVA_HOME%/include文件夹下面找到）文件引入，因为在程序中的JNIEnv、 jobject等类型都是在该头文件中定义的；另外在第2行需要将HelloWorld.h头文件引入（我是这么理解的：相当于我们在编写java程序的时候，实现一个接口的话需要声明才可以，这里就是将HelloWorld.h头文件里面声明的方法加以实现。当然不一定是这样）。然后保存为 HelloWorldImpl.c就ok了。

　　5) 生成动态库

　　这里以在Windows中为例，需要生成dll文件。在保存HelloWorldImpl.c文件夹下面，使用VC的编译器cl成。 cl -I%java_home%/include -I%java_home%/include/win32 -LD HelloWorldImp.c -Fehello.dll 注意：生成的dll文件名在选项-Fe后面配置，这里是hello，因为在HelloWorld.java文件中我们loadLibary的时候使用的名字是hello。当然这里修改之后那里也需要修改。另外需要将-I%java_home%/include -I%java_home%/include/win32参数加上，因为在第四步里面编写本地方法的时候引入了jni.h文件。

　　6) 运行程序 java HelloWorld就ok.

简要使用例子

　　下面是一个简单的例子实现打印一句话的功能，但是用的c的printf最终实现。一般提供给java的jni接口包括一个so文件（封装了c函数的实现）和一个java文件（需要调用path的类）。

　　1． JNI的目的是使java方法中能够调用c实现的一些函数，比如以下的java类，就需要调用一个本地函数testjni（一般声明为private native类型），首先需要创建文件weiqiong.java，内容如下：

　　class weiqiong { static { System.loadLibrary("testjni");//载入静态库，test函数在其中实现 } private native void testjni(); //声明本地调用 public void test() { testjni(); } public static void main(String args[]) { weiqiong haha = new weiqiong(); haha.test(); } }

　　2．然后执行javac weiqiong.java，如果没有报错，会生成一个weiqiong.class。

　　3．然后设置classpath为你当前的工作目录，如直接输入命令行：set classpath = weiqiong.class所在的完整目录（如 c:/test)再执行javah weiqiong，会生成一个文件weiqiong.h文件，其中有一个函数的声明如下：

　　JNIEXPORT void JNICALL Java_weiqiong_testjni (JNIEnv *, jobject);

　　4．创建文件testjni.c将上面那个函数实现，内容如下：

　　1. include

　　2. include

　　JNIEXPORT void JNICALL Java_weiqiong_testjni (JNIEnv *env, jobject obj) { printf("haha---------go into c!!!/n"); }

　　5．为了生成.so文件，创建makefile文件如下：

　　libtestjni.so:testjni.o makefile gcc -Wall -rdynamic -shared -o libtestjni.so testjni.o testjni.o:testjni.c weiqiong.h gcc -Wall -c testjni.c -I./ -I/usr/java/j2sdk1.4.0/include -I/usr/java/j2sdk1.4.0/include/linux cl: rm -rf *.o *.so 注意：gcc前面是tab空，j2sdk的目录根据自己装的j2sdk的具体版本来写，生成的so文件的名字必须是loadLibrary的参数名前加“lib”。

　　6．export LD_LIBRARY_PATH=.，由此设置library路径为当前目录，这样java文件才能找到so文件。一般的做法是将so文件copy到本机的LD_LIBRARY_PATH目录下。

　　7．执行java weiqiong，打印出结果：“haha---------go into c!!!”

调用中考虑的问题

　　在首次使用JNI的时候有些疑问，后来在使用中一一解决，下面就是这些问题的备忘：

　　1。 java和c是如何互通的？

　　其实不能互通的原因主要是数据类型的问题，jni解决了这个问题，例如那个c文件中的jstring数据类型就是java传入的String对象，经过jni函数的转化就能成为c的char*。

　　对应数据类型关系如下表：

　　Java 类型 本地c类型 说明 boolean jboolean 无符号，8 位 byte jbyte 无符号，8 位 char jchar 无符号，16 位 short jshort 有符号，16 位 int jint 有符号，32 位 long jlong 有符号，64 位 float jfloat 32 位 double jdouble 64 位 void void N/A

　　JNI 还包含了很多对应于不同 Java 对象的引用类型如下图：

　　2. 如何将java传入的String参数转换为c的char*，然后使用?

　　java传入的String参数，在c文件中被jni转换为jstring的数据类型，在c文件中声明char* test，然后test = (char*)(*env)->GetStringUTFChars(env, jstring, NULL);注意：test使用完后，通知虚拟机平台相关代码无需再访问：(*env)->ReleaseStringUTFChars(env, jstring, test);

　　3. 将c中获取的一个char*的buffer传递给java？

　　这个char*如果是一般的字符串的话，作为string传回去就可以了。如果是含有’/0’的buffer，最好作为bytearray传出，因为可以制定copy的length，如果copy到string，可能到’/0’就截断了。

　　有两种方式传递得到的数据：

　　一种是在jni中直接new一个byte数组，然后调用函数(*env)->SetByteArrayRegion(env, bytearray, 0, len, buffer);将buffer的值copy到bytearray中，函数直接return bytearray就可以了。

　　一种是return错误号，数据作为参数传出，但是java的基本数据类型是传值，对象是传递的引用，所以将这个需要传出的byte数组用某个类包一下，如下：

　　class RetObj { public byte[] bytearray; } 这个对象作为函数的参数retobj传出，通过如下函数将retobj中的byte数组赋值便于传出。代码如下： jclass cls; jfieldID fid; jbyteArray bytearray; bytearray = (*env)->NewByteArray(env,len); (*env)->SetByteArrayRegion(env, bytearray, 0, len, buffer); cls = (*env)->GetObjectClass(env, retobj); fid = (*env)->GetFieldID(env, cls, "retbytes", "[B"]); (*env)->SetObjectField(env, retobj, fid, bytearray);

　　4. 不知道占用多少空间的buffer，如何传递出去呢？

　　在jni的c文件中new出空间，传递出去。java的数据不初始化，指向传递出去的空间即可。

对JAVA传入数据的处理

　　1． 如果传入的是bytearray的话，作如下处理得到buffer：

　　char *tmpdata = (char*)(*env)->GetByteArrayElements(env, bytearray, NULL); (*env)->ReleaseByteArrayElements(env, bytearray, tmpdata, 0);

 

 

、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、、

 

 

 

Android的SDK中没有包括JNI的支持，而且对如何支持JNI也没有任何文档说明。不过既然整个Android平台是开源的，我们可以通过Google发布的源代码来找到一些线索（比如frameworks/base/media/jni/目录），依葫芦画瓢的实现上层JAVA程序通过JNI来调用Native C程序中的函数。

　　依照下面的步骤可以实现一个非常简单的JNI的实例程序：

　　1．首先编写C模块，实现动态库。（关于如何在Android中编译C模块的更多细节，请参考《Android编译环境(1) - 编译Native C的helloworld模块》。）
在development目录下添加新目录hellolib，并添加hellolib.c和Android.mk文件。hellolib.c的内容如下：
#include <jni.h>

#define LOG_TAG "TestLib"
#undef LOG
#include <utils/Log.h>

JNIEXPORT void JNICALL Java_com_test_TestHelloLib_printHello(JNIEnv * env, jobject jobj)
{

LOGD("Hello LIB!/n");
}
 
注意这里的函数名需要按照JNI的规范（因此也可以用javah -jni工具来生成头文件，来保证函数名的正确性），Java_com_test_TestHelloLib_printHello的命名对应后面在java代码中，package名字是com.test，类名是TestHelloLib，native函数名是printHello。
另外，LOGD及#define LOG_TAG "TestLib"等打印log的方式是采用了Android所提供的LOG机制，这样才能通过Android的logcat工具看到log。
用于编译C模块的Android.mk文件内容如下：
LOCAL_PATH:= $(call my-dir)
include $(CLEAR_VARS)
LOCAL_SRC_FILES:= /

hellolib.c

LOCAL_C_INCLUDES := /

$(JNI_H_INCLUDE)

LOCAL_SHARED_LIBRARIES := /

libutils

LOCAL_PRELINK_MODULE := false

LOCAL_MODULE := libhello

include $(BUILD_SHARED_LIBRARY)
 
该文件中的一些变量分别对应的含义如下：
LOCAL_SRC_FILES －
编译的源文件
LOCAL_C_INCLUDES －
需要包含的头文件目录
LOCAL_SHARED_LIBRARIES －
链接时需要的外部库
LOCAL_PRELINK_MODULE －
是否需要prelink处理（参考prelink的详细介绍：《动态库优化——Prelink（预连接）技术》，Android的Toolchain, prelink工具：《Android Toolchain与Bionic Libc》）
LOCAL_MODULE －
编译的目标对象
BUILD_SHARED_LIBRARY －
指明要编译成动态库。

接下来回到Android顶层目录，并执行make libhello来编译：
# cd $(YOUR_ANDROID) && make libhello
target thumb C: libhello <= development/hellolib/hellolib.c
target SharedLib: libhello (out/target/product/generic/obj/SHARED_LIBRARIES/libhello_intermediates/LINKED/libhello.so)
target Non-prelinked: libhello (out/target/product/generic/symbols/system/lib/libhello.so)
target Strip: libhello (out/target/product/generic/obj/lib/libhello.so)
Install: out/target/product/generic/system/lib/libhello.so

　　编译结果可得到位于out/target/product/generic/system/lib/目录的动态共享库libhello.so

　　2．编写Java模块，来通过JNI方式调用C接口。具体Eclipse环境的搭建请参考Android SDK文档中的详细说明，及Hello Android程序的创建过程，这里仅给出我们需要修改的TestHelloLib.java文件：

package com.test;
import android.app.Activity;

import android.os.Bundle;
public
class TestHelloLib extends Activity {
/**
Called
when
the
activity
is
first
created.
*/
@Override
public
void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);

printHello();
}

static {

System.loadLibrary("hello");

}

private
native
void printHello();

}
 
　　注意上面代码中粗体字部分：private native void printHello()用来声明一个native接口，static { System.loadLibrary("hello"); } 用来加载上面步骤中生成libhello.so（注意loadLibrary方法的参数不是”libhello.so”，而是去掉前缀和后缀之后的”hello”），onCreate()方法中则调用了printHello()接口。

　　通过这一步骤可生成Android开发者所熟悉的apk文件：TestHelloLib.apk。

　　3．集成测试TestHelloLib.apk和libhello.so。先运行emulator并将TestHelloLib.apk和libhello.so上传至emulator中。注意要将libhello.so上传到emulator的/system/lib目录，由于该目录是只读的，上传之前先要执行adb remount：
# adb remount
# adb push out/target/product/generic/system/lib/libhello.so /system/lib
# adb install TestHelloLib.apk

　　接下来在模拟器菜单中可以看到已经安装的TestHelloLib程序，运行即可。

　　由于JNI接口printHello()并没有作界面上的改动，要验证其效果需要用Android的logcat工具来查看。运行”adb logcat”可以找到下面的log片断：

I/ActivityManager(
48): Starting activity: Intent { action=android.intent.action.MAIN categories={android.intent.category.LAUNCHER} flags=0x10200000 comp={com.test/com.test.TestHelloLib} }
I/ActivityManager(
48): Start proc com.test for activity com.test/.TestHelloLib: pid=174 uid=10024 gids={}
D/dalvikvm(
174): Trying to load lib /system/lib/libhello.so 0x43481c58
D/dalvikvm(
174): Added shared lib /system/lib/libhello.so 0x43481c58
D/dalvikvm(
174): No JNI_OnLoad found in /system/lib/libhello.so 0x43481c58
D/dalvikvm(
174): +++ not scanning '/system/lib/libwebcore.so' for 'printHello' (wrong CL)
D/dalvikvm(
174): +++ not scanning '/system/lib/libmedia_jni.so' for 'printHello' (wrong CL)
D/TestLib (
174): Hello LIB!
I/ActivityManager(
48): Displayed activity com.test/.TestHelloLib: 806 ms

　　这里包含了调用printHello()接口的log信息，其中”D/TestLib (
174): Hello LIB!”就是printHello()所打印的信息。至此成功完成Android JNI的实例验证。