1. 簡介
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
2. JNI的書寫步驟
? 編寫帶有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 */
#include <jni.h>
/* Header for class HelloWorld */
#ifndef _Included_HelloWorld
#define _Included_HelloWorld
#ifdef __cplusplus
extern "C" {
#endif
/*
* Class: HelloWorld
* Method: displayHelloWorld
* Signature: ()V
*/
JNIEXPORT void JNICALL Java_HelloWorld_displayHelloWorld
(JNIEnv *, jobject);
#ifdef __cplusplus
}
#endif
#endif
(這里我們可以這樣理解:這個h文件相當于我們在java里面的接口,這里聲明了一個Java_HelloWorld_displayHelloWorld (JNIEnv *, jobject);方法,然后在我們的本地方法里面實現這個方法,也就是說我們在編寫C/C++程序的時候所使用的方法名必須和這里的一致)。
4) 編寫本地方法
實現和由javah命令生成的頭文件里面聲明的方法名相同的方法。
代碼2:
1 #include <jni.h>
2 #include "HelloWorld.h"
3 #include <stdio.h>
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) 運行程序
teaspjava HelloWorld就ok。^_^
3. Java類型和本地類型對應
在如下情況下,需要在本地方法中應用java對象的引用,就會用到類型之間的轉換:
1) java方法里面將參數傳入本地方法;
2) 在本地方法里面創建java對象;
3) 在本地方法里面return結果給java程序。
分為如下兩種情況:
? Java原始類型
像booleans、integers、floats等從Java程序中傳到本地方法中的原始類型可以直接使用,下面是java中的原始類型和本地方法中的類型的對應:
Java類型 本地類型 字節(bit)
boolean jboolean 8, unsigned
byte jbyte 8
char jchar 16, unsigned
short jshort 16
int jint 32
long jlong 64
float jfloat 32
double jdouble 64
void void n/a
也就是說如果我在方法中傳進去了一個boolean的參數的話,那么我在本地方法中就有jboolean類型與之對應。同理,如果在本地方法中return一個jint的話,那么在java中就返回一個int類型。
? Java對象
Java對象做為引用被傳遞到本地方法中,所有這些Java對象的引用都有一個共同的父類型jobject(相當于java中的Object類是所有類的父類一樣)。下面是JNI實現的一些jobject的子類:
圖一:jobject子類
4. 本地方法中訪問java程序中的內容
1) 訪問String對象:
從java程序中傳過去的String對象在本地方法中對應的是jstring類型,jstring類型和c中的char*不同,所以如果你直接當做char*使用的話,就會出錯。因此在使用之前需要將jstring轉換成為c/c++中的char*,這里使用JNIEnv的方法轉換。下面是一個例子:
代碼3:
JNIEXPORT jstring JNICALL Java_Prompt_getLine
(JNIEnv *env, jobject obj, jstring prompt)
{
char buf[128];
const char *str = (*env)->GetStringUTFChars(env, prompt, 0);
printf("%s", str);
(*env)->ReleaseStringUTFChars(env, prompt, str);
這里使用GetStringUTFChars方法將傳進來的prompt(jstring類型)轉換成為UTF-8的格式,就能夠在本地方法中使用了。
注意:在使用完你所轉換之后的對象之后,需要顯示調用ReleaseStringUTFChars方法,讓JVM釋放轉換成UTF-8的string的對象的空間,如果不顯示的調用的話,JVM中會一直保存該對象,不會被垃圾回收器回收,因此就會導致內存溢出。
下面是訪問String的一些方法:
◆GetStringUTFChars將jstring轉換成為UTF-8格式的char*
◆GetStringChars將jstring轉換成為Unicode格式的char*
◆ReleaseStringUTFChars釋放指向UTF-8格式的char*的指針
◆ReleaseStringChars釋放指向Unicode格式的char*的指針
◆NewStringUTF創建一個UTF-8格式的String對象
◆NewString創建一個Unicode格式的String對象
◆GetStringUTFLengt獲取UTF-8格式的char*的長度
◆GetStringLength獲取Unicode格式的char*的長度
2) 訪問Array對象:
和String對象一樣,在本地方法中不能直接訪問jarray對象,而是使用JNIEnv指針指向的一些方法來是用。
? 訪問Java原始類型數組:
1) 獲取數組的長度:
代碼4:
JNIEXPORT jint JNICALL Java_IntArray_sumArray
(JNIEnv *env, jobject obj, jintArray arr)
{
int i, sum = 0;
jsize len = (*env)->GetArrayLength(env, arr);
如代碼4所示,這里獲取數組的長度和普通的c語言中的獲取數組長度不一樣,這里使用JNIEvn的一個函數GetArrayLength。
2) 獲取一個指向數組元素的指針:
代碼4:
jint *body = (*env)->GetIntArrayElements(env, arr, 0);
使用GetIntArrayElements方法獲取指向arr數組元素的指針,注意該函數的參數,第一個是JNIEnv,第二個是數組,第三個是數組里面第三個是數組里面開始的元素
3) 使用指針取出Array中的元素
代碼5:
for (i=0; i<len; i++) {
sum += body[i];
}
這里使用就和普通的c中的數組使用沒有什么不同了
4) 釋放數組元素的引用
代碼6:
(*env)->ReleaseIntArrayElements(env, arr, body, 0);
和操作String中的釋放String的引用是一樣的,提醒JVM回收arr數組元素的引用。
這里舉的例子是使用int數組的,同樣還有boolean、float等對應的
數組。
獲取數組元素指針的對應關系:
函數 數組類型
GetBooleanArrayElements boolean
GetByteArrayElements byte
GetCharArrayElements char
GetShortArrayElements short
GetIntArrayElements int
GetLongArrayElements long
GetFloatArrayElements float
GetDoubleArrayElements double
釋放數組元素指針的對應關系:
Function Array Type
ReleaseBooleanArrayElements boolean
ReleaseByteArrayElements byte
ReleaseCharArrayElements char
ReleaseShortArrayElements short
ReleaseIntArrayElements int
ReleaseLongArrayElements long
ReleaseFloatArrayElements float
ReleaseDoubleArrayElements double
? 訪問自定義Java對象數組
The JNI provides a separate set of functions to access elements of object arrays. You can use these functions to get and set individual object array elements.
Note: You cannot get all the object array elements at once.
• GetObjectArrayElement returns the object element at a given index.
• SetObjectArrayElement updates the object element at a given index.
3) 訪問Java對象的方法:
? 在本地方法中調用Java對象的方法的步驟:
①. 獲取你需要訪問的Java對象的類:
jclass cls = (*env)->GetObjectClass(env, obj);
使用GetObjectClass方法獲取obj對應的jclass。
②. 獲取MethodID:
jmethodID mid = (*env)->GetMethodID(env, cls, "callback", "(I)V");
使用GetMethdoID方法獲取你要使用的方法的MethdoID。其參數的意義:
env??>JNIEnv
cls??>第一步獲取的jclass
"callback"??>要調用的方法名
"(I)V"??>方法的Signature
③. 調用方法:
(*env)->CallVoidMethod(env, obj, mid, depth);
使用CallVoidMethod方法調用方法。參數的意義:
env??>JNIEnv
obj??>通過本地方法穿過來的jobject
mid??>要調用的MethodID(即第二步獲得的MethodID)
depth??>方法需要的參數(對應方法的需求,添加相應的參數)
注:這里使用的是CallVoidMethod方法調用,因為沒有返回值,如果有返回值的話使用對應的方法,在后面會提到。
? 方法的Signature
方法的Signature是由方法的參數和返回值的類型共同構成的,下面是他們的結構:
"(argument-types)return-type"
其中Java程序中參數類型和其對應的值如下:
Signature Java中的類型
Z boolean
B byte
C char
S short
I int
J long
F float
D double
L fully-qualified-class; fully-qualified-class
[ type type[]
( arg-types ) ret-type method type
一個Java類的方法的Signature可以通過javap命令獲取:
javap -s -p Java類名
? 給調用的函數傳參數:
通常我們直接在methodID后面將要傳的參數添加在后面,但是還有其他的方法也可以傳參數:
CallVoidMethodV可以獲取一個數量可變的列表作為參數;
CallVoidMethodA可以獲取一個union。
? 調用靜態方法:
就是將第二步和第三步調用的方法改為對應的:
GetStaticMethodID獲取對應的靜態方法的ID
CallStaticIntMethod調用靜態方法
? 調用超類的方法:
用的比較少,自己看啦。^_^。
4) 訪問Java對象的屬性:
訪問Java對象的屬性和訪問Java對象的方法基本上一樣,只需要將函數里面的Method改為Field即可(當然還有不同的地方)。
另外獲取屬性的Signature的命令:
javap -s -p Java類名
5. 捕捉和處理異常
Java里面有很經典的try、catch、finally來處理異常,但是在c或者c++里沒有對應的異常處理機制。但是如果一個方法申明了有異常拋出怎么辦呢?因此在可能出現異常的地方在調用JNI之后需要檢查異常。為此JNI提供了一些函數允許呢能夠在有異常的時候拋出異常。
使用的步驟:
1) 聲明異常
JNI提供了jthrowable作為異常,其聲明如下:
jthrowable exc;
2) 在需要檢查異常的地方檢查
exc = (*env)->ExceptionOccurred(env);
3) 判斷exc如果存在就進行異常處理
jclass newExcCls;
(*env)->ExceptionDescribe(env);
(*env)->ExceptionClear(env);
newExcCls = (*env)->FindClass(env, "teaspjava/lang/IllegalArgumentException");
if (newExcCls == 0) { /* Unable to find the new exception class, give up. */
return;
}
(*env)->ThrowNew(env, newExcCls, "thrown from C code");
4) 如果exc不存在就繼續
6. 局部和全局引用
^_^
7. 線程和本地方法
1) 線程和JNI
有幾個需要注意的地方:
? JNI接口的指針JNIEnv*只在該線程內有效;
? 不能將局部引用傳到其他的線程;
? 在使用全局引用的時候請注意同步。
2) 本地方法中的同步
定義同步塊開始
(*env)->MonitorEnter(env, obj);
... /* 同步塊 */
定一同步塊結束
(*env)->MonitorExit(env, obj);
這里就和Java中的
synchronized (obj) {
... /* synchronized block */
...
}
有一樣的效果。
3) Wait和Notify
Java中的Object.wait、 Object.notify和 and Object.notifyAll在多線程的時候非常有用,但是JNI沒有支持這幾個方法。因此如果我們需要使用這些方法的功能的時候,可以通過調用Java對象方法的方式來調用。
全文完。
轉自:gee的專欄
posted @
2007-08-10 09:36 teasp 閱讀(146) |
評論 (0) |
編輯 收藏