來自ITwiki 的JNI

來自ITwiki的JNI

更多的JNI資訊可以在JNI的spec中找到： http://java.sun.com/javase/6/docs/technotes/guides/jni/spec/jniTOC.html

Jump to: navigation, <jumptoSearch>

JNI是Java Native Interface的縮寫。從Java 1.1開始，Java Native Interface (JNI)標準成為java平台的一部分，它允許Java代碼和其他語言寫的代碼進行互動。JNI一開始是為了本地已編譯語言，尤其是C和C++而設計的，但是它並不妨礙你使用其他語言，只要呼叫慣例受支援就可以了。

使用java與本地已編譯的代碼互動，通常會喪失平台可移植性。但是，有些情況下這樣做是可以接受的，甚至是必須的，比如，使用一些舊的庫，與硬體、作業系統進行互動，或者為了提高程式的效能。JNI標準至少保證本地代碼能工作在任何JAVA 虛擬機器實現下。

一、JNI（Java Native Interface）的設計目的

·The standard Java class library may not support the
platform-dependent features needed by your application.
·You may already have a library or application written in another
programming language and you wish to make it accessible to Java
applications
·You may want to implement a small portion of time-critical code in a
lower-level programming language, such as assembly, and then have your
Java application call these functions

二、JNI（Java Native Interface）的書寫步驟

     ·編寫帶有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”是動態庫的名字。
main()方法
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 2 #include "HelloWorld.h"
3 #include

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。^_^

三、JNI（Java Native Interface）的簡要使用例子

     下面是一個簡單的例子實現列印一句話的功能，但是用的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．然後執行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（Java Native Interface）調用中考慮的問題

     在首次使用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的基礎資料型別 (Elementary Data Type)是傳值，對象是傳遞的引用，所以將這個需要傳出的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的資料不初始化，指向傳遞出去的空間即可。

五．JNI中對JAVA傳入資料的處理

     1． 如果傳入的是bytearray的話，作如下處理得到buffer：

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

（來源：crybaby2005.bokee.com；miniufo.bokee.com）