張翼翔 李慶明,
簡介: 本文簡要介紹了 JNI 調用規範,及常用函數。並通過具體樣本程式展示了實現一個本地調用的基本步驟。
本文的標籤: best_practices, jni, 應用開發
標記本文!
發布日期: 2002 年 10 月 29 日
層級: 初級
訪問情況 : 8431 次瀏覽
評論: 0 (查看 | 添加評論 - 登入)
平均分 (27個評分)
為本文評分
引言
Java 的出現給大家開發帶來的極大的方便。但是,如果我們有大量原有的經過廣泛測試的非 Java 代碼,將它們全部用 Java 來重寫,恐怕會帶來巨大的工作量和長期的測試;如果我們的應用中需要訪問到特定的裝置,甚至是僅符合公司內部資訊互動規範的裝置,或某個特定的作業系統才 有的特性,Java 就顯得有些力不從心了。面對這些問題,Sun 公司在 JDK1.0 中就定義了 JNI 規範,它規定了 Java 應用程式對本地方法的調用規則。
回頁首
實現步驟及相關函數使用
本文將一步步說明在 Linux 平台下如何?本地共用庫與 Java 協同工作。Hello World 程式是目前標準的入門第一步,那麼,我也以類似的應用最為範例。
第一步,定義一個 Java 類 -- Hello. 它提供 SayHello 方法:
此時應注意兩點:
1. 為要使用的每個本地方法編寫本地方法聲明,其聲明方式與普通 Java 方法介面沒什麼不同,只是必須指定 native 關鍵字,如下所示:
public native void SayHello(String strName);
在這個函數中,我們將根據傳進的人名,向某人問好。
2. 必須顯式地載入本地程式碼程式庫。我們需在類的一個靜態塊中載入這個庫:
static { System.loadLibrary("hello"); } |
再加上必要的異常處理就產生如下源檔案 Hello.java:
public class Hello { static { try { // 此處即為本地方法所在連結庫名 System.loadLibrary("hello"); } catch(UnsatisfiedLinkError e) { System.err.println( "Cannot load hello library:\n " + e.toString() ); } } public Hello() { } // 聲明的本地方法 public native void SayHello(String strName); } |
編譯後產生 Hello.class 檔案。
第二步,產生本地連結庫。具體過程如下:
1. 要為以上定義的類產生 Java 本地介面標頭檔,需使用 javah,Java 編譯器的 javah 功能將根據 Hello 類產生必要的聲明,此命令將產生 Hello.h 檔案,我們在共用庫的代碼中要包含它,javah 不使預設內部命令,需要指明路徑,它在 JDK 的 bin 目錄下,在我的 Linux 環境下命令如下:
/home/jbuilder/jdk1.3.1/bin/javah Hello
產生的 Hello.h 檔案 內容如下所示:
/* DO NOT EDIT THIS FILE - it is machine generated */ #include <jni.h> /* Header for class Hello */ #ifndef _Included_Hello #define _Included_Hello #ifdef __cplusplus extern "C" { #endif /* * Class: Hello * Method: SayHello * Signature: (Ljava/lang/String;)V */ JNIEXPORT void JNICALL Java_Hello_SayHello (JNIEnv *, jobject, jstring); #ifdef __cplusplus } #endif #endif |
2. 在與 Hello.h 相同的路徑下建立一個 CPP 檔案 Hello.cpp。內容如下:
#include "Hello.h" #include <stdio.h> // 與 Hello.h 中函式宣告相同 JNIEXPORT void JNICALL Java_Hello_SayHello (JNIEnv * env, jobject arg, jstring instring) { // 從 instring 字串取得指向字串 UTF 編碼的指標 const jbyte *str = (const jbyte *)env->GetStringUTFChars( instring, JNI_FALSE ); printf("Hello,%s\n",str); // 通知虛擬機器本地代碼不再需要通過 str 訪問 Java 字串。 env->ReleaseStringUTFChars( instring, (const char *)str ); return; } |
所有的 JNI 調用都使用了 JNIEnv * 類型的指標,習慣上在 CPP 檔案中將這個變數定義為 evn,它是任意一個本地方法的第一個參數。env 指標指向一個函數指標表,在 VC 中可以直接用"->"操作符訪問其中的函數。
jobject 指向在此 Java 代碼中執行個體化的 Java 對象 LocalFunction 的一個控制代碼,相當於 this 指標。
後續的參數就是本地調用中有 Java 程式傳進的參數,本例中只有一個 String 型參數。 對於字串型參數,因為在本地代碼中不能直接讀取 Java 字串,而必須將其轉換為 C /C++ 字串或 Unicode。以下是三個我們經常會用到的字串類型處理的函數:
const char* GetStringUTFChars(jstring string,jboolean* isCopy)
返回指向字串 UTF 編碼的指標,如果不能建立這個字元數組,返回 null。這個指標在調用 ReleaseStringUTFChar() 函數之前一直有效。
參數:string Java 字串對象 isCopy 如果進行拷貝,指向以 JNI_TRUE 填充的 jboolean, 否則指向以 JNI_FALSE 填充的 jboolean。 void ReleaseStringUTFChars(jstring str, const char* chars) 通知虛擬機器本地代碼不再需要通過 chars 訪問 Java 字串。
參數:string Java 字串對象 chars 由 GetStringChars 返回的指標 jstring NewStringUTF(const char *utf) 返回一個新的 Java 字串並將 utf 內容拷貝入新串,如果不能建立字串對象,返回 null。通常在反實值型別為 string 型時用到。
參數:utf UTF 編碼的字串指標對於數值型參數,在 C/C++ 中可直接使用,其位元組寬度如下所示:
Java |
C/C++ |
位元組數 |
boolean |
jboolean |
1 |
byte |
jbyte |
1 |
char |
jchar |
2 |
short |
jshort |
2 |
int |
jint |
4 |
long |
jlong |
8 |
float |
jfloat |
4 |
double |
jdouble |
8 |
對於數組型參數,
Java |
C/C++ |
boolean[ ] |
JbooleanArray |
byte[ ] |
JbyteArray |
char[ ] |
JcharArray |
short[ ] |
JshortArray |
int[ ] |
JintArray |
long[ ] |
JlongArray |
float[ ] |
JfloatArray |
double[ ] |
JdoubleArray |
對於上述類型數組,有一組函數與其對應。以下函數中 Xxx 為對應類型。
xxx * GetXxxArrayElements(xxxArray array, jboolean *isCopy)
產生一個指向 Java 數組元素的 C 指標。不再需要時,需將此指標傳給 ReleaseXxxArrayElemes。
參數:array 數組對象 isCopy 如果進行拷貝,指向以 JNI_TRUE 填充的 jboolean, 否則指向以 JNI_FALSE 填充的 jboolean。例如: jboolean * GetBooleanArrayElements(jbooleanArray array, jboolean *isCopy) void ReleaseXxxArrayElements(xxxArray array,xxx *elems, jint mode) 通知虛擬機器不再需要從 GetXxxArrayElements 得到的指標。
參數:array 數組對象 elems 不再需要的指向數組元素的指標 mode 0 =在更新數組元素後釋放 elems 緩衝器 JNI_COMMIT =在更新數組元素後不釋放 elems 緩衝器 JNI_ABORT =不更新數組元素釋放 elems 緩衝器例如:void ReleaseBooleanArrayElements(jbooleanArray array,jboolean *elems, jint mode) xxxArray NewXxxArray(jsize len) 產生一個新的數組,通常在反實值型別為數組型時用到
參數:len 數組中元素的個數。例如:jbooleanArray NewBooleanArray(jsize len)
3 .編譯產生共用庫。
使用 GCC 時 , 必須通知編譯器在何處尋找此 Java 本地方法的支援檔案,並且顯式通知編譯器產生位置無關的代碼,在我的環境中按如下過程編譯:
gcc -I/home/jbuilder/jdk1.3.1/include -I/home/jbuilder/jdk1.3.1/include/linux -fPIC -c Hello.c |
產生 Hello.o
gcc -shared -Wl,-soname,libhello.so.1 -o libhello.so.1.0 Hello.o |
產生 libhello.so.1.0
接下來將產生的共用庫拷貝為標準檔案名稱
cp libhello.so.1.0 libhello.so
最後通知動態連結程式此共用檔案的路徑。
export LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH
4 .編寫一個簡單的 Java 程式來測試我們的本地方法。
將如下源碼存為 ToSay.java:
import Hello; import java.util.*; public class ToSay { public static void main(String argv[]) { ToSay say = new ToSay(); } public ToSay() { Hello h = new Hello(); // 調用本地方法向 John 問好 h.SayHello("John"); } } |
用 javac 編譯 ToSay.java,產生 ToSay.class
向執行普通 Java 程式一樣使用 java ToSay,我們會看到在螢幕上出現 Hello,John。
到這裡我們就將整個的本地調用編寫過程大概瀏覽了一遍。
回頁首
應用中注意事項
1 . 如果可以通過 TCP/IP 實現 Java 代碼與本地 C/C++ 代碼的互動工作,那麼最好不使用以上提到的 JNI 的方式,因為一次 JNI 調用非常耗時,大概要花 0.5 ~ 1 個毫秒。
2 . 在一個 Applet 應用中,不要使用 JNI。因為在 applet 中可能引發安全異常。
3 . 將所有本地方法都封裝在單個類中,這個類調用單個 DLL。對於每種目標作業系統,都可以用特定於適當平台的版本替換這個 DLL。這樣就可以將本地代碼的影響減至最小,並有助於將以後所需的移植問題包含在內。
4 . 本地方法要簡單。盡量將產生的 DLL 對任何第三方運行時 DLL 的依賴減到最小。使本地方法盡量獨立,以將載入 DLL 和應用程式所需的開銷減到最小。如果必須要運行時 DLL,則應隨應用程式一起提供它們。
5 . 本地代碼運行時,沒有有效地防數組越界錯誤、錯誤指標引用帶來的間接錯誤等。所以必須保證保證本地代碼的穩定性,因為,絲毫的錯誤都可能導致 JAVA 虛擬機器崩潰。
回頁首
結束語
JNI 調用規範給我們複用原有其它語言的代碼提供了簡單易用的介面,可以節省大量的財力,使我們可以在享受 Java 帶來的開發速度的同時,不必放棄舊有資源。
參考資料
Cay S.Horstmnn,Gary Cornell,Core Java 2 Volume II:Advanced Fearutes,Prentice Hall,2000.
Rob Gordon and Alan,Essential JNI, Java Native Interface, Prentice Hall,1998
http://java.sun.com/products/jdk/1.1/docs/guide/jni/
關於作者
張翼翔 :擁有8年的軟體開發經驗。曾經領導瑞星殺毒軟體網路版和I'm上網管理系統的研發工作。現任北京華夏新視科技有限公司研發部經理
李慶明:從事軟體開發已經有5年。有豐富的嵌入式Linux和Java開發經驗。現任廣東捷遠資訊科技有限公司技術總監