本文主要參考http://tech.ccidnet.com/art/1081/20050413/237901_1.html 上的文章。
C++調用JAVA主要用到了SUN公司的JNI技術, JNI是Java Native Interface的 縮寫。從Java 1.1開始,Java Native Interface (JNI)標準成爲java平臺的一部分,它允許Java代碼和其他語言寫的代碼進行交互。相關資料見http://java.sun.com/j2se/1.5.0/docs/guide/jni/spec/jniTOC.html
開發環境安裝及配置
1.1 安裝JDK
到SUN公司網站可以下載到最新版的JDK。下載下來後開始安裝,一路選擇默認配置即可,本文檔中假定安裝的是JDK1.4,安裝目錄爲C:\j2sdk1.4.2_15。
1.2 配置VC6.0
通過Visual C++ 6的菜單Tools→Options打開選項對話框。在Directories標籤頁下添加JDK的相關目錄到Include和目錄下。
開發測試用到的JAVA類
2.1 開發JAVA類
在硬盤的任意地方新建一個名叫test的文件夾,本文檔示例中將test文件夾建立在C盤根目錄,然後在裏面新建一個名稱叫Demo.java的JAVA文件,將下面測試用的代碼粘貼到該文件中。
- package test;
- /**
- * 該類是爲了演示JNI如何訪問各種對象屬性等
- */
- public class Demo
- {
- //用於演示如何訪問靜態的基本類型屬性
- public static int COUNT = 8;
- //演示對象型屬性
- private String msg;
- private int[] counts;
- public Demo()
- {
- this("缺省構造函數");
- }
- /**
- * 演示如何訪問構造器
- */
- public Demo(String msg)
- {
- this.msg = msg;
- this.counts = null;
- }
- public String getMessage()
- {
- return msg;
- }
- /**
- * 該方法演示如何訪問一個靜態方法
- */
- public static String getHelloWorld()
- {
- return "Hello world!";
- }
- /**
- * 該方法演示參數的傳入傳出及中文字符的處理
- */
- public String append(String str, int i)
- {
- return str + i;
- }
- /**
- * 演示數組對象的訪問
- */
- public int[] getCounts()
- {
- return counts;
- }
- /**
- * 演示如何構造一個數組對象
- */
- public void setCounts(int[] counts)
- {
- this.counts = counts;
- }
- /**
- * 演示異常的捕捉
- */
- public void throwExcp()throws IllegalAccessException
- {
- throw new IllegalAccessException("exception occur.");
- }
- }
package test;
/**
* 該類是爲了演示JNI如何訪問各種對象屬性等
*/
public class Demo
{
//用於演示如何訪問靜態的基本類型屬性
public static int COUNT = 8;
//演示對象型屬性
private String msg;
private int[] counts;
public Demo()
{
this("缺省構造函數");
}
/**
* 演示如何訪問構造器
*/
public Demo(String msg)
{
this.msg = msg;
this.counts = null;
}
public String getMessage()
{
return msg;
}
/**
* 該方法演示如何訪問一個靜態方法
*/
public static String getHelloWorld()
{
return "Hello world!";
}
/**
* 該方法演示參數的傳入傳出及中文字符的處理
*/
public String append(String str, int i)
{
return str + i;
}
/**
* 演示數組對象的訪問
*/
public int[] getCounts()
{
return counts;
}
/**
* 演示如何構造一個數組對象
*/
public void setCounts(int[] counts)
{
this.counts = counts;
}
/**
* 演示異常的捕捉
*/
public void throwExcp()throws IllegalAccessException
{
throw new IllegalAccessException("exception occur.");
}
}
2.2 編譯JAVA類
運行CMD控制檯程序進入命令行模式,輸入命令javac -classpath c:\ c:\test\Demo.java,-classpath參數指定classpath的路徑,這裏就是test目錄所在的路徑。(注意:如果你沒有將JDK的環境變量設置好,就需要先進入JDK的bin目錄下,如下圖所示。)
2.3 查看方法的簽名
我們知道Java中允許方法的多態,僅僅是通過方法名並沒有辦法定位到一個具體的方法,因此需要一個字符串來唯一表示一個方法。但是怎麼利用一個字 符串來表示方法的具體定義呢?JDK中已經準備好一個反編譯工具javap,通過這個工具就可以得到類中每個屬性、方法的簽名。在CMD下運行javap -s -p -classpath c:\ test.Demo即可看到屬性和方法的簽名。如下圖紅色矩形框起來的字符串爲方法String append(String str, int i)的簽名。
在VC中調用JAVA類
3.1 快速調用JAVA中的函
在VC中新建一個控制檯程序,然後新建一個CPP文件,將下面的代碼添加到該文件中。運行該文件,即可得到Demo類中String append(String str, int i)函數返回的字符串。
- #include "windows.h"
- #include "jni.h"
- #include <string>
- #include <iostream>
- using namespace std;
- jstring NewJString(JNIEnv *env, LPCTSTR str);
- string JStringToCString (JNIEnv *env, jstring str);
- int main()
- {
- //定義一個函數指針,下面用來指向JVM中的JNI_CreateJavaVM函數
- typedef jint (WINAPI *PFunCreateJavaVM)(JavaVM **, void **, void *);
- int res;
- JavaVMInitArgs vm_args;
- JavaVMOption options[3];
- JavaVM *jvm;
- JNIEnv *env;
- /*設置初始化參數*/
- //disable JIT,這是JNI文檔中的解釋,具體意義不是很清楚 ,能取哪些值也不清楚。
- //從JNI文檔裏給的示例代碼中搬過來的
- options[0].optionString = "-Djava.compiler=NONE";
- //設置classpath,如果程序用到了第三方的JAR包,也可以在這裏麪包含進來
- options[1].optionString = "-Djava.class.path=.;c:\\";
- //設置顯示消息的類型,取值有gc、class和jni,如果一次取多個的話值之間用逗號格開,如-verbose:gc,class
- //該參數可以用來觀察C++調用JAVA的過程,設置該參數後,程序會在標準輸出設備上打印調用的相關信息
- options[2].optionString = "-verbose:NONE";
- //設置版本號,版本號有JNI_VERSION_1_1,JNI_VERSION_1_2和JNI_VERSION_1_4
- //選擇一個根你安裝的JRE版本最近的版本號即可,不過你的JRE版本一定要等於或者高於指定的版本號
- vm_args.version = JNI_VERSION_1_4;
- vm_args.nOptions = 3;
- vm_args.options = options;
- //該參數指定是否忽略非標準的參數,如果填JNI_FLASE,當遇到非標準參數時,JNI_CreateJavaVM會返回JNI_ERR
- vm_args.ignoreUnrecognized = JNI_TRUE;
- //加載JVM.DLL動態庫
- HINSTANCE hInstance = ::LoadLibrary("C:\\j2sdk1.4.2_15\\jre\\bin\\client\\jvm.dll");
- if (hInstance == NULL)
- {
- return false;
- }
- //取得裏面的JNI_CreateJavaVM函數指針
- PFunCreateJavaVM funCreateJavaVM = (PFunCreateJavaVM)::GetProcAddress(hInstance, "JNI_CreateJavaVM");
- //調用JNI_CreateJavaVM創建虛擬機
- res = (*funCreateJavaVM)(&jvm, (void**)&env, &vm_args);
- if (res < 0)
- {
- return -1;
- }
- //查找test.Demo類,返回JAVA類的CLASS對象
- jclass cls = env->FindClass("test/Demo");
- //根據類的CLASS對象獲取該類的實例
- jobject obj = env->AllocObject(cls);
- //獲取類中的方法,最後一個參數是方法的簽名,通過javap -s -p 文件名可以獲得
- jmethodID mid = env->GetMethodID(cls, "append","(Ljava/lang/String;I)Ljava/lang/String;");
- //構造參數並調用對象的方法
- const char szTest[] = "電信";
- jstring arg = NewJString(env, szTest);
- jstring msg = (jstring) env->CallObjectMethod(obj, mid, arg, 12);
- cout<<JStringToCString(env, msg);
- //銷燬虛擬機並釋放動態庫
- jvm->DestroyJavaVM();
- ::FreeLibrary(hInstance);
- return 0;
- }
- string JStringToCString (JNIEnv *env, jstring str)// (jstring str, LPTSTR desc, int desc_len)
- {
- if(str==NULL)
- {
- return "";
- }
- //在VC中wchar_t是用來存儲寬字節字符(UNICODE)的數據類型
- int len = env->GetStringLength(str);
- wchar_t *w_buffer = new wchar_t[len+1];
- char *c_buffer = new char[2*len+1];
- ZeroMemory(w_buffer,(len+1)*sizeof(wchar_t));
- //使用GetStringChars而不是GetStringUTFChars
- const jchar * jcharString = env->GetStringChars(str, 0);
- wcscpy(w_buffer,jcharString);
- env->ReleaseStringChars(str,jcharString);
- ZeroMemory(c_buffer,(2*len+1)*sizeof(char));
- /調用字符編碼轉換函數(Win32 API)將UNICODE轉爲ASCII編碼格式字符串
- len = WideCharToMultiByte(CP_ACP,0,w_buffer,len,c_buffer,2*len,NULL,NULL);
- string cstr = c_buffer;
- delete[] w_buffer;
- delete[] c_buffer;
- return cstr;
- }
- jstring NewJString(JNIEnv *env, LPCTSTR str)
- {
- if(!env || !str)
- {
- return 0;
- }
- int slen = strlen(str);
- jchar* buffer = new jchar[slen];
- int len = MultiByteToWideChar(CP_ACP,0,str,strlen(str),buffer,slen);
- if(len>0 && len < slen)
- {
- buffer[len]=0;
- }
- jstring js = env->NewString(buffer,len);
- delete [] buffer;
- return js;
- }
#include "windows.h"
#include "jni.h"
#include <string>
#include <iostream>
using namespace std;
jstring NewJString(JNIEnv *env, LPCTSTR str);
string JStringToCString (JNIEnv *env, jstring str);
int main()
{
//定義一個函數指針,下面用來指向JVM中的JNI_CreateJavaVM函數
typedef jint (WINAPI *PFunCreateJavaVM)(JavaVM **, void **, void *);
int res;
JavaVMInitArgs vm_args;
JavaVMOption options[3];
JavaVM *jvm;
JNIEnv *env;
/*設置初始化參數*/
//disable JIT,這是JNI文檔中的解釋,具體意義不是很清楚 ,能取哪些值也不清楚。
//從JNI文檔裏給的示例代碼中搬過來的
options[0].optionString = "-Djava.compiler=NONE";
//設置classpath,如果程序用到了第三方的JAR包,也可以在這裏麪包含進來
options[1].optionString = "-Djava.class.path=.;c:\\";
//設置顯示消息的類型,取值有gc、class和jni,如果一次取多個的話值之間用逗號格開,如-verbose:gc,class
//該參數可以用來觀察C++調用JAVA的過程,設置該參數後,程序會在標準輸出設備上打印調用的相關信息
options[2].optionString = "-verbose:NONE";
//設置版本號,版本號有JNI_VERSION_1_1,JNI_VERSION_1_2和JNI_VERSION_1_4
//選擇一個根你安裝的JRE版本最近的版本號即可,不過你的JRE版本一定要等於或者高於指定的版本號
vm_args.version = JNI_VERSION_1_4;
vm_args.nOptions = 3;
vm_args.options = options;
//該參數指定是否忽略非標準的參數,如果填JNI_FLASE,當遇到非標準參數時,JNI_CreateJavaVM會返回JNI_ERR
vm_args.ignoreUnrecognized = JNI_TRUE;
//加載JVM.DLL動態庫
HINSTANCE hInstance = ::LoadLibrary("C:\\j2sdk1.4.2_15\\jre\\bin\\client\\jvm.dll");
if (hInstance == NULL)
{
return false;
}
//取得裏面的JNI_CreateJavaVM函數指針
PFunCreateJavaVM funCreateJavaVM = (PFunCreateJavaVM)::GetProcAddress(hInstance, "JNI_CreateJavaVM");
//調用JNI_CreateJavaVM創建虛擬機
res = (*funCreateJavaVM)(&jvm, (void**)&env, &vm_args);
if (res < 0)
{
return -1;
}
//查找test.Demo類,返回JAVA類的CLASS對象
jclass cls = env->FindClass("test/Demo");
//根據類的CLASS對象獲取該類的實例
jobject obj = env->AllocObject(cls);
//獲取類中的方法,最後一個參數是方法的簽名,通過javap -s -p 文件名可以獲得
jmethodID mid = env->GetMethodID(cls, "append","(Ljava/lang/String;I)Ljava/lang/String;");
//構造參數並調用對象的方法
const char szTest[] = "電信";
jstring arg = NewJString(env, szTest);
jstring msg = (jstring) env->CallObjectMethod(obj, mid, arg, 12);
cout<<JStringToCString(env, msg);
//銷燬虛擬機並釋放動態庫
jvm->DestroyJavaVM();
::FreeLibrary(hInstance);
return 0;
}
string JStringToCString (JNIEnv *env, jstring str)// (jstring str, LPTSTR desc, int desc_len)
{
if(str==NULL)
{
return "";
}
//在VC中wchar_t是用來存儲寬字節字符(UNICODE)的數據類型
int len = env->GetStringLength(str);
wchar_t *w_buffer = new wchar_t[len+1];
char *c_buffer = new char[2*len+1];
ZeroMemory(w_buffer,(len+1)*sizeof(wchar_t));
//使用GetStringChars而不是GetStringUTFChars
const jchar * jcharString = env->GetStringChars(str, 0);
wcscpy(w_buffer,jcharString);
env->ReleaseStringChars(str,jcharString);
ZeroMemory(c_buffer,(2*len+1)*sizeof(char));
/調用字符編碼轉換函數(Win32 API)將UNICODE轉爲ASCII編碼格式字符串
len = WideCharToMultiByte(CP_ACP,0,w_buffer,len,c_buffer,2*len,NULL,NULL);
string cstr = c_buffer;
delete[] w_buffer;
delete[] c_buffer;
return cstr;
}
jstring NewJString(JNIEnv *env, LPCTSTR str)
{
if(!env || !str)
{
return 0;
}
int slen = strlen(str);
jchar* buffer = new jchar[slen];
int len = MultiByteToWideChar(CP_ACP,0,str,strlen(str),buffer,slen);
if(len>0 && len < slen)
{
buffer[len]=0;
}
jstring js = env->NewString(buffer,len);
delete [] buffer;
return js;
}
3.2 調用步驟分析及注意事項
a、加載jvm.dll動態庫,然後獲取裏面的JNI_CreateJavaVM函數。這個步驟也可以通過在VC工程的LINK標籤頁裏添加對jvm.lib的連接,然後在環境變量裏把jvm.dll所在的路徑加上去來實現。但後面這種方法在部署的時候會比前一個方法麻煩。
b、利用構造好的參數,調用JNI_CreateJavaVM函數創建JVM。JNI_CreateJavaVM函數內部會自動根據jvm.dll的路徑來獲取JRE的環境,所以千萬不要把jvm.dll文件拷貝到別的地方,然後再通過LoadLibrary函數導入。
c、JVM創建成功後,JNI_CreateJavaVM函數會傳出一個JNI上下文環境對象(JNIEnv),利用該對象的相關函數就可以調用JAVA類的屬性和方法了。
d、以上面的代碼爲例:先調用JNIEnv的FindClass方法,該函數傳入一個參數,該參數就是java類的全局帶包名的名稱,如上面示例中的test/Demo表示test包中的Demo類。這個方法會在你創建JVM時設置的classpath路徑下找相應的類,找到後就會返回該類的class對象。 Class是JAVA中的一個類,每個JAVA類都有唯一的一個靜態的Class對象,Class對象包含類的相關信息。爲了使FindClass方法能找到你的類,請確保創建JVM時-Djava.class.path=參數設置正確。注意:系統環境變量中的CLASSPATH對這裏創建JVM沒有影響,所以不要以爲系統CLASSPATH設置好了相關路徑後這裏就不用設置了。
e、利用FindClass返回的class對象,調用GetMethodID函數可以獲得裏面方法的ID,在這裏GetMethodID函數傳入了三個參數:第一個參數是class對象,因爲方法屬於某個具體的類;第二個參數是方法的名稱;第三個參數是方法的簽名,這個簽名可以在前面3.3中介紹的方法獲得。
f、利用class對象,可以通過調用AllocObject函數獲得該class對象對應類的一個實例,即Demo類的對象。
g、利用上面獲取的函數ID和Demo類的對象,就可以通過CallObjectMethod函數調用相應的方法,該函數的參數跟printf函數的參數一樣,個數是不定的。第一個參數是類的對象;第二個參數是要調用的方法的ID;後面的參數就是需要傳給調用的JAVA類方法的參數,如果調用的JAVA類方法沒有參數,則調用CallObjectMethod時傳前兩個參數就可以了。
h、從上面的示例中可以看到,在調用JAVA的方法前,構造傳入的字符串時,用到了NewJString函數;在調用該方法後,對傳出的字符串調用了JstringToCString函數。這是由於Java中所有的字符都是Unicode編碼,但是在本地方法中,例如用VC編寫的程序,如果沒有特殊的定義一般都沒有使用Unicode的編碼方式。爲了讓本地方法能夠訪問Java中定義的中文字符及Java訪問本地方法產生的中文字符串,定義了兩個方法用來做相互轉換。
i、避免在被調用的JAVA類中使用靜態final成員變量,因爲在C++中生成一個JAVA類的對象時,靜態final成員變量不會像JAVA中new對象時那樣先賦值。如果出現這種情況,在C++中調用該對象的方法時會發現該對象的靜態final成員變量值全爲0或者null(根據成員變量的類型而定)。
3.3 調用JAVA中的靜態方法
- //調用靜態方法
- jclass cls = env->FindClass("test/Demo");
- jmethodID mid = env->GetStaticMethodID(cls, "getHelloWorld","()Ljava/lang/String;");
- jstring msg = (jstring)env->CallStaticObjectMethod(cls, mid);
- cout<<JStringToCString(env, msg);
//調用靜態方法
jclass cls = env->FindClass("test/Demo");
jmethodID mid = env->GetStaticMethodID(cls, "getHelloWorld","()Ljava/lang/String;");
jstring msg = (jstring)env->CallStaticObjectMethod(cls, mid);
cout<<JStringToCString(env, msg);
3.4 調用JAVA中的靜態屬性
- //調用靜態方法
- jclass cls = env->FindClass("test/Demo");
- jfieldID fid = env->GetStaticFieldID(cls, "COUNT","I");
- int count = (int)env->GetStaticIntField(cls, fid);
- cout<<count<<endl;
3.5 調用JAVA中的帶參數構造函數
- //調用構造函數
- jclass cls = env->FindClass("test/Demo");
- jmethodID mid = env->GetMethodID(cls,"<init>","(Ljava/lang/String;)V");
- const char szTest[] = "電信";
- jstring arg = NewJString(env, szTest);
- jobject demo = env->NewObject(cls,mid,arg);
- //驗證是否構造成功
- mid = env->GetMethodID(cls, "getMessage","()Ljava/lang/String;");
- jstring msg = (jstring)env->CallObjectMethod(demo, mid);
- cout<<JStringToCString(env, msg);
//調用構造函數
jclass cls = env->FindClass("test/Demo");
jmethodID mid = env->GetMethodID(cls,"<init>","(Ljava/lang/String;)V");
const char szTest[] = "電信";
jstring arg = NewJString(env, szTest);
jobject demo = env->NewObject(cls,mid,arg);
//驗證是否構造成功
mid = env->GetMethodID(cls, "getMessage","()Ljava/lang/String;");
jstring msg = (jstring)env->CallObjectMethod(demo, mid);
cout<<JStringToCString(env, msg);
3.6 傳入傳出數組
- //傳入傳出數組
- //構造數組
- long arrayCpp[] = {1,3,5,7,9};
- jintArray array = env->NewIntArray(5);
- env->SetIntArrayRegion(array, 0, 5, arrayCpp);
- //傳入數組
- jclass cls = env->FindClass("test/Demo");
- jobject obj = env->AllocObject(cls);
- jmethodID mid = env->GetMethodID(cls,"setCounts","([I)V");
- env->CallVoidMethod(obj, mid, array);
- //獲取數組
- mid = env->GetMethodID(cls,"getCounts","()[I");
- jintArray msg = (jintArray)env->CallObjectMethod(obj, mid, array);
- int len =env->GetArrayLength(msg);
- jint* elems =env-> GetIntArrayElements(msg, 0);
- for(int i=0; i< len; i++)
- {
- cout<<"ELEMENT "<<i<<" IS "<<elems[i]<<endl;
- }
- env->ReleaseIntArrayElements(msg, elems, 0);
//傳入傳出數組
//構造數組
long arrayCpp[] = {1,3,5,7,9};
jintArray array = env->NewIntArray(5);
env->SetIntArrayRegion(array, 0, 5, arrayCpp);
//傳入數組
jclass cls = env->FindClass("test/Demo");
jobject obj = env->AllocObject(cls);
jmethodID mid = env->GetMethodID(cls,"setCounts","([I)V");
env->CallVoidMethod(obj, mid, array);
//獲取數組
mid = env->GetMethodID(cls,"getCounts","()[I");
jintArray msg = (jintArray)env->CallObjectMethod(obj, mid, array);
int len =env->GetArrayLength(msg);
jint* elems =env-> GetIntArrayElements(msg, 0);
for(int i=0; i< len; i++)
{
cout<<"ELEMENT "<<i<<" IS "<<elems[i]<<endl;
}
env->ReleaseIntArrayElements(msg, elems, 0);
3.7 異常處理
由於調用了Java的方法,因此難免產生操作的異常信息,如JAVA函數返回的異常,或者調用JNI方法(如GetMethodID)時拋出的異常。這些異常沒有辦法通過C++本身的異常處理機制來捕捉到,但JNI可以通過一些函數來獲取Java中拋出的異常信息。
- //異常處理
- jclass cls = env->FindClass("test/Demo");
- jobject obj = env->AllocObject(cls);
- jmethodID mid = env->GetMethodID(cls,"throwExcp","()V");
- env->CallVoidMethod(obj, mid);
- //獲取異常信息
- string exceptionInfo = "";
- jthrowable excp = 0;
- excp = env->ExceptionOccurred();
- if(excp)
- {
- jclass cls = env->GetObjectClass(excp);
- env->ExceptionClear();
- jmethodID mid = env->GetMethodID(cls, "toString","()Ljava/lang/String;");
- jstring msg = (jstring) env->CallObjectMethod(excp, mid);
- out<<JStringToCString(env, msg)<<endl;
- env->ExceptionClear();
- }
//異常處理
jclass cls = env->FindClass("test/Demo");
jobject obj = env->AllocObject(cls);
jmethodID mid = env->GetMethodID(cls,"throwExcp","()V");
env->CallVoidMethod(obj, mid);
//獲取異常信息
string exceptionInfo = "";
jthrowable excp = 0;
excp = env->ExceptionOccurred();
if(excp)
{
jclass cls = env->GetObjectClass(excp);
env->ExceptionClear();
jmethodID mid = env->GetMethodID(cls, "toString","()Ljava/lang/String;");
jstring msg = (jstring) env->CallObjectMethod(excp, mid);
out<<JStringToCString(env, msg)<<endl;
env->ExceptionClear();
}
多線程
4.1 多線程中注意事項
JNIEnv和jobject對象都不能跨線程使用
對於jobject,解決辦法是
a、m_obj = m_env->NewGlobalRef(obj);//創建一個全局變量
b、jobject obj = m_env->AllocObject(m_cls);//在每個線程中都生成一個對象
對於JNIEnv,解決辦法是在每個線程中都重新生成一個env
JNIEnv *env;
m_jvm->AttachCurrentThread((void **)&env, NULL);