JNI學習

最近在公司裡做了一個手機的專案，需要JAVA程式在傳送簡訊的時候和第三方的簡訊伺服器連線。簡訊介面是用C++寫的。琢磨了三天，大致搞懂了JNI的主體部分。先將心得整理，希望各位朋友少走彎路。

首先引用一篇文章，介紹一個簡單的JNI的呼叫的過程。

JAVA以其跨平臺的特性深受人們喜愛，而又正由於它的跨平臺的目的，使得它和本地機器的各種內部聯絡變得很少，約束了它的功能。解決JAVA對本地操作的一種方法就是JNI。

JAVA通過JNI呼叫本地方法，而本地方法是以庫檔案的形式存放的（在WINDOWS平臺上是DLL檔案形式，在UNIX機器上是SO檔案形式）。通過呼叫本地的庫檔案的內部方法，使JAVA可以實現和本地機器的緊密聯絡，呼叫系統級的各介面方法。

簡單介紹及應用如下： 

一、JAVA中所需要做的工作 

在JAVA程式中，首先需要在類中宣告所呼叫的庫名稱，如下： 

static { 
       System.loadLibrary(“goodluck”); 
}

在這裡，庫的副檔名字可以不用寫出來，究竟是DLL還是SO，由系統自己判斷。 

還需對將要呼叫的方法做本地宣告，關鍵字為native。且只需要宣告，而不需要具體實現。如下： 

public native static void set(int i); 
    public native static int get();

然後編譯該JAVA程式檔案，生成CLASS，再用JAVAH命令，JNI就會生成C/C++的標頭檔案。 

例如程式testdll.java，內容為： 

public class testdll 
{ 
static 
{ 
System.loadLibrary("goodluck"); 
} 
public native static int get(); 
public native static void set(int i); 
public static void main(String[] args) 
{ 
testdll test = new testdll(); 
test.set(10); 
System.out.println(test.get()); 
} 
}

用javac testdll.java編譯它，會生成testdll.class。 

再用javah testdll，則會在當前目錄下生成testdll.h檔案，這個檔案需要被C/C++程式呼叫來生成所需的庫檔案。 

二、C/C++中所需要做的工作 

對於已生成的.h標頭檔案，C/C++所需要做的，就是把它的各個方法具體的實現。然後編譯連線成庫檔案即可。再把庫檔案拷貝到JAVA程式的路徑下面，就可以用JAVA呼叫C/C++所實現的功能了。 

接上例子。我們先看一下testdll.h檔案的內容： 

/* DO NOT EDIT THIS FILE - it is machine generated */ 
#include 
/* Header for class testdll */ 
#ifndef _Included_testdll 
#define _Included_testdll 
#ifdef __cplusplus 
extern "C" { 
#endif 
/* 
* Class: testdll 
* Method: get 
* Signature: ()I 
*/ 
JNIEXPORT jint JNICALL Java_testdll_get (JNIEnv *, jclass); 
/* 
* Class: testdll 
* Method: set 
* Signature: (I)V 
*/ 
JNIEXPORT void JNICALL Java_testdll_set (JNIEnv *, jclass, jint); 
#ifdef __cplusplus 
} 
#endif 
#endif

在具體實現的時候，我們只關心兩個函式原型 

JNIEXPORT jint JNICALL Java_testdll_get (JNIEnv *, jclass); 和 

JNIEXPORT void JNICALL Java_testdll_set (JNIEnv *, jclass, jint);

這裡JNIEXPORT和JNICALL都是JNI的關鍵字，表示此函式是要被JNI呼叫的。而jint是以JNI為中介使JAVA的int型別與本地的int溝通的一種型別，我們可以視而不見，就當做int使用。函式的名稱是JAVA_再加上java程式的package路徑再加函式名組成的。引數中，我們也只需要關心在JAVA程式中存在的引數，至於JNIEnv*和jclass我們一般沒有必要去碰它。 

好，下面我們用testdll.cpp檔案具體實現這兩個函式： 

#include "testdll.h" 
int i = 0; 
JNIEXPORT jint JNICALL Java_testdll_get (JNIEnv *, jclass) 
{ 
return i; 
} 
JNIEXPORT void JNICALL Java_testdll_set (JNIEnv *, jclass, jint j) 
{ 
i = j; 
}

編譯連線成庫檔案，本例是在WINDOWS下做的，生成的是DLL檔案。並且名稱要與JAVA中需要呼叫的一致，這裡就是goodluck.dll 。把goodluck.dll拷貝到testdll.class的目錄下，java testdll執行它，就可以觀察到結果了。

我的專案比較複雜，需要呼叫動態連結庫，這樣在JNI傳送引數到C程式時，需要對引數進行處理轉換。才可以被C程式識別。

大體程式如下：

public class SendSMS { 
static 
{ 
System.out.println(System.getProperty("java.library.path")); 
System.loadLibrary("sms"); 
} 
public native static int SmsInit(); 
public native static int SmsSend(byte[] mobileNo, byte[] smContent); 
}

在這裡要注意的是，path裡一定要包含類庫的路徑，否則在程式執行時會丟擲異常：

java.lang.UnsatisfiedLinkError: no sms in java.library.path
at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1491)
at java.lang.Runtime.loadLibrary0(Runtime.java:788)
at java.lang.System.loadLibrary(System.java:834)
at com.mobilesoft.sms.mobilesoftinfo.SendSMS.(SendSMS.java:14)
at com.mobilesoft.sms.mobilesoftinfo.test.main(test.java:18)
Exception in thread "main"

指引的路徑應該到.dll檔案的上一級，如果指到.dll，則會報：

java.lang.UnsatisfiedLinkError: C:sms.dll: Can`t find dependent libraries
at java.lang.ClassLoader$NativeLibrary.load(Native Method)
at java.lang.ClassLoader.loadLibrary0(ClassLoader.java:1560)
at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1485)
at java.lang.Runtime.loadLibrary0(Runtime.java:788)
at java.lang.System.loadLibrary(System.java:834)
at com.mobilesoft.sms.mobilesoftinfo.test.main(test.java:18)
Exception in thread "main"

通過編譯，生成com_mobilesoft_sms_mobilesoftinfo_SendSMS.h標頭檔案。（建議使用Jbuilder進行編譯，操作比較簡單！）這個標頭檔案就是Java和C之間的紐帶。要特別注意的是方法中傳遞的引數jbyteArray，這在接下來的過程中會重點介紹。

/* DO NOT EDIT THIS FILE - it is machine generated */ 
#include 
/* Header for class com_mobilesoft_sms_mobilesoftinfo_SendSMS */ 
#ifndef _Included_com_mobilesoft_sms_mobilesoftinfo_SendSMS 
#define _Included_com_mobilesoft_sms_mobilesoftinfo_SendSMS 
#ifdef __cplusplus 
extern "C" { 
#endif 
/* 
* Class: com_mobilesoft_sms_mobilesoftinfo_SendSMS 
* Method: SmsInit 
* Signature: ()I 
*/ 
JNIEXPORT jint JNICALL Java_com_mobilesoft_sms_mobilesoftinfo_SendSMS_SmsInit 
(JNIEnv *, jclass); 
/* 
* Class: com_mobilesoft_sms_mobilesoftinfo_SendSMS 
* Method: SmsSend 
* Signature: ([B[B)I 
*/ 
JNIEXPORT jint JNICALL Java_com_mobilesoft_sms_mobilesoftinfo_SendSMS_SmsSend 
(JNIEnv *, jclass, jbyteArray, jbyteArray); 
#ifdef __cplusplus 
} 
#endif 
#endif

對於我要呼叫的C程式的動態連結庫，C程式也要提供一個標頭檔案，sms.h。這個檔案將要呼叫的方法羅列了出來。

/* 
* SMS API 
* Author: yippit 
* Date: 2004.6.8 
*/ 
#ifndef MCS_SMS_H 
#define MCS_SMS_H 
#define DLLEXPORT __declspec(dllexport) 
/*sms storage*/ 
#define SMS_SIM 0 
#define SMS_MT 1 
/*sms states*/ 
#define SMS_UNREAD 0 
#define SMS_READ 1 
/*sms type*/ 
#define SMS_NOPARSE -1 
#define SMS_NORMAL 0 
#define SMS_FLASH 1 
#define SMS_MMSNOTI 2 
typedef struct tagSmsEntry { 
int index; /*index, start from 1*/ 
int status; /*read, unread*/ 
int type; /*-1-can`t parser 0-normal, 1-flash, 2-mms*/ 
int storage; /*SMS_SIM, SMS_MT*/ 
char date[24]; 
char number[32]; 
char text[144]; 
} SmsEntry; 
DLLEXPORT int SmsInit(void); 
DLLEXPORT int SmsSend(char *phonenum, char *content); 
DLLEXPORT int SmsSetSCA(char *sca); 
DLLEXPORT int SmsGetSCA(char *sca); 
DLLEXPORT int SmsSetInd(int ind); 
DLLEXPORT int SmsGetInd(void); 
DLLEXPORT int SmsGetInfo(int storage, int *max, int *used); 
DLLEXPORT int SmsSaveFlash(int flag); 
DLLEXPORT int SmsRead(SmsEntry *entry, int storage, int index); 
DLLEXPORT int SmsDelete(int storage, int index); 
DLLEXPORT int SmsModifyStatus(int storage, int index); /*unread -> read*/ 
#endif

在有了這兩個標頭檔案之後，就可以進行C程式的編寫了。也就是實現對JNI呼叫的兩個方法。在網上的資料中，由於呼叫的方法實現的都比較簡單，（大多是列印字串等）所以避開了JNI中最麻煩的部分，也是最關鍵的部分，引數的傳遞。由於Java和C的編碼是不同的，所以傳遞的引數是要進行再處理，否則C程式是會對引數在編譯過程中提出警告，例如；warning C4024: `SmsSend` : different types for formal and actual parameter 2等。

Sms.c的程式如下：

#include "sms.h" 
#include "com_mobilesoft_sms_mobilesoftinfo_SendSMS.h" 
JNIEXPORT jint JNICALL Java_com_mobilesoft_sms_mobilesoftinfo_SendSMS_SmsInit(JNIEnv * env, jclass jobject) 
{ 
return SmsInit(); 
} 
JNIEXPORT jint JNICALL Java_com_mobilesoft_sms_mobilesoftinfo_SendSMS_SmsSend(JNIEnv * env, jclass jobject, jbyteArray mobileno, jbyteArray smscontent) 
{ 
char * pSmscontent ; 
//jsize theArrayLengthJ = (*env)->GetArrayLength(env,mobileno); 
jbyte * arrayBody = (*env)->GetByteArrayElements(env,mobileno,0); 
char * pMobileNo = (char *)arrayBody; 
printf("[%s]
 ", pMobileNo); 
//jsize size = (*env)->GetArrayLength(env,smscontent); 
arrayBody = (*env)->GetByteArrayElements(env,smscontent,0); 
pSmscontent = (char *)arrayBody; 
printf("<%s>
", pSmscontent); 
return SmsSend(pMobileNo,pSmscontent); 
}

對於C或C++，在程式上是會有稍微的不同，這可以由讀者對其進行適當的修改。這裡要注意的是GetArrayLength，GetByteArrayElements等這些JNI中已經包含的方法，這些方法是專門對轉換引數型別而提供的。具體的方法有很多，在下一篇中會做專門的介紹。

在完成了上述的檔案後，可以對sms.c進行編譯，生成.dll檔案（建議在release中編譯，這樣動態連結庫的容積會比較小！）

完成.dll檔案的編譯後，就可以在Java中呼叫C程式中的方法了。例如檔案test.java

public class test { 
public test() { 
} 
public static void main(String[] args) { 
byte[] mobileno = { 
0x31, 0x33, 0x36, 0x36, 0x31, 0x36, 0x33, 0x30, 0x36, 0x36, 0x37, 0x00}; 
String smscontentemp = "早上好"; 
byte[] temp = {0}; 
try { 
byte[] smscontentdb = smscontentemp.getBytes("gbk"); 
byte[] smscontent = new byte[smscontentdb.length + temp.length]; 
System.arraycopy(smscontentdb, 0, smscontent, 0, smscontentdb.length); 
System.arraycopy(temp, 0, smscontent, smscontentdb.length, temp.length); 
SendSMS sendSMS = new SendSMS(); 
sendSMS.SmsInit(); 
if (sendSMS.SmsSend(mobileno, smscontent) >= 0) { 
System.out.println("chenggong !"); 
} 
else { 
System.out.println("shibai !"); 
} 
}catch (Exception ex) {} 
} 
}

在這個檔案中要注意的有一點，就是在傳遞位元組陣列到C程式中時，最後的結尾一定要以0結束。這是一個偷懶的做法，不過是個有效的做法。因為大多數情況下，介面是由第三方提供的。所以我們一般是不知道在C的方法裡，具體是怎麼處理引數的。而C又是要求陣列是有長度。所以，在Java中，如果你不想寫程式傳陣列的長度，那麼在陣列中以0結尾就是最方便的方法了。當然，如果有更好的方法也希望大家提出。

到這裡，一個完整的Java通過JNI呼叫動態連結庫的程式就完成了。實際上也不是很複雜。只要多注意一下細節，是很容易得出來的。