JNI 調用規范


引言

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 環境下命令如下:

     

      這里所謂的bin目錄要特別注意,是指workspace中 編譯 ******.java 所生產 ****.class 所在的bin目錄

      如上圖所示  bin目錄

 

/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 虛擬機崩潰。

javah生成.h文件時提示“找不到類”的解決方法  

當用javah為.clsaa文件生成.h文件的時候提示錯誤: 

 

 

 

 

 

 

 

 

解決方法:

      進入bin目錄執行:   javah -classpath . -jni   package_name. class_name

 

 

 



免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM