JNI参数传递.doc

2009-11-18
JNI 返回结构体参数
如何使用JNI的一些基本方法和过程在网上多如牛毛，如果你对Jni不甚了解，不知道Jni是做什么的，如何建立一个基本的jni程序，或许可以参考下面下面这些文章:
利用VC++6.0实现JNI的最简单的例子
JNI入门教程之HelloWorld篇
SUN JNI Tutorial

这些资料的例子中，大多数只是输入一些简单的参数，获取没有参数。而在实际的使用过程中，往往需要对参数进行处理转换。才可以被C/C++程序识别。比如我们在C++中有一个结构（Struct）DiskInfo ,需要传递一个类似于DiskInfo *pDiskInfo的参数，类似于在C++这样参数如何传递到Java中呢？下面我们就来讨论C++到Java中方法的一些常见参数的转换:
定义Native Java类：

如果你习惯了使用JNI，你就不会觉得它难了。既然本地方法是由其他语言实现的，它们在Java中没有函数体。但是，所有本地代码必须用本地关键词声明，成为Java类的成员。假设我们在C++中有这么一个结构，它用来描述硬盘信息：
Java代码
1. //硬盘信息   
2. struct {   
3.     char name[256];   
4.     int serial;   
5. }DiskInfo;  
Java代码
1. //硬盘信息   
2. struct {   
3.     char name[256];   
4.     int serial;   
5. }DiskInfo;  
//硬盘信息
struct {
char name[256];
int serial;
}DiskInfo;

那么我们需要在Java中定义一个类来与之匹配，声明可以写成这样：
Java代码
1. class DiskInfo {   
2.     //名字   
3.     public String name;   
4.   
5.     //序列号   
6.     public int serial;   
7. }  
Java代码
1. class DiskInfo {   
2.     //名字   
3.     public String name;   
4.   
5.     //序列号   
6.     public int serial;   
7. }  class DiskInfo {
//名字
public String name;

//序列号
public int serial;
}
在这个类中，申明一些Native的本地方法，来测试方法参数的传递，分别定义了一些函数，用来传递结构或者结构数组，具体定义如下面代码：
Java代码
1. /**//****************** 定义本地方法 ********************/  
2.     //输入常用的数值类型(Boolean,Byte,Char,Short,Int,Float,Double)   
3.     public native void displayParms(String showText, int i, boolean bl);   
4.   
5.     //调用一个静态方法   
6.     public native int add(int a, int b);   
7.   
8.     //输入一个数组   
9.     public native void setArray(boolean[] blList);   
10.   
11.     //返回一个字符串数组   
12.     public native String[] getStringArray();   
13.   
14.     //返回一个结构   
15.     public native DiskInfo getStruct();   
16.   
17.     //返回一个结构数组   
18.     public native DiskInfo[] getStructArray();  
Java代码
1. /**//****************** 定义本地方法 ********************/  
2.     //输入常用的数值类型(Boolean,Byte,Char,Short,Int,Float,Double)   
3.     public native void displayParms(String showText, int i, boolean bl);   
4.   
5.     //调用一个静态方法   
6.     public native int add(int a, int b);   
7.   
8.     //输入一个数组   
9.     public native void setArray(boolean[] blList);   
10.   
11.     //返回一个字符串数组   
12.     public native String[] getStringArray();   
13.   
14.     //返回一个结构   
15.     public native DiskInfo getStruct();   
16.   
17.     //返回一个结构数组   
18.     public native DiskInfo[] getStructArray();  
/**//****************** 定义本地方法 ********************/
//输入常用的数值类型(Boolean,Byte,Char,Short,Int,Float,Double)
public native void displayParms(String showText, int i, boolean bl);

//调用一个静态方法
public native int add(int a, int b);

//输入一个数组
public native void setArray(boolean[] blList);

//返回一个字符串数组
public native String[] getStringArray();

//返回一个结构
public native DiskInfo getStruct();

//返回一个结构数组
public native DiskInfo[] getStructArray();

编译生成C/C++头文件

定义好了Java类之后，接下来就要写本地代码。本地方法符号提供一个满足约定的头文件，使用Java工具Javah可以很容易地创建它而不用手动去创建。你对Java的class文件使用javah命令，就会为你生成一个对应的C/C++头文件。
1、在控制台下进入工作路径，本工程路径为：E:\work\java\workspace\JavaJni。
2、运行javah 命令：javah -classpath E:\work\java\workspace\JavaJni com.sundy.jnidemo ChangeMethodFromJni
本文生成的C/C++头文件名为: com_sundy_jnidemo_ChangeMethodFromJni.h

在C/C++中实现本地方法

生成C/C++头文件之后，你就需要写头文件对应的本地方法。注意：所有的本地方法的第一个参数都是指向JNIEnv结构的。这个结构是用来调用JNI函数的。第二个参数jclass的意义，要看方法是不是静态的（static）或者实例（Instance）的。前者，jclass代表一个类对象的引用，而后者是被调用的方法所属对象的引用。

返回值和参数类型根据等价约定映射到本地C/C++类型，如表JNI类型映射所示。有些类型，在本地代码中可直接使用，而其他类型只有通过JNI调用操作。

表A
Java类型     本地类型     描述
boolean     jboolean     C/C++8位整型
byte     jbyte     C/C++带符号的8位整型
char     jchar     C/C++无符号的16位整型
short     jshort     C/C++带符号的16位整型
int     jint     C/C++带符号的32位整型
long     jlong     C/C++带符号的64位整型e
float     jfloat     C/C++32位浮点型
double     jdouble     C/C++64位浮点型
Object     jobject     任何Java对象，或者没有对应java类型的对象
Class     jclass     Class对象
String     jstring     字符串对象
Object[]     jobjectArray     任何对象的数组
boolean[]     jbooleanArray     布尔型数组
byte[]     jbyteArray     比特型数组
char[]     jcharArray     字符型数组
short[]     jshortArray     短整型数组
int[]     jintArray     整型数组
long[]     jlongArray     长整型数组
float[]     jfloatArray     浮点型数组
double[]     jdoubleArray     双浮点型数组

※     JNI类型映射
使用数组：

JNI通过JNIEnv提供的操作Java数组的功能。它提供了两个函数：一个是操作java的简单型数组的，另一个是操作对象类型数组的。

因为速度的原因，简单类型的数组作为指向本地类型的指针暴露给本地代码。因此，它们能作为常规的数组存取。这个指针是指向实际的Java数组或者Java数组的拷贝的指针。另外，数组的布置保证匹配本地类型。

为了存取Java简单类型的数组，你就要要使用GetXXXArrayElements函数（见表B），XXX代表了数组的类型。这个函数把Java数组看成参数，返回一个指向对应的本地类型的数组的指针。

表B
函数     Java数组类型     本地类型
GetBooleanArrayElements     jbooleanArray     jboolean
GetByteArrayElements     jbyteArray     jbyte
GetCharArrayElements     jcharArray     jchar
GetShortArrayElements     jshortArray     jshort
GetIntArrayElements     jintArray     jint
GetLongArrayElements     jlongArray     jlong
GetFloatArrayElements     jfloatArray     jfloat
GetDoubleArrayElements     jdoubleArray     jdouble

JNI数组存取函数

当你对数组的存取完成后，要确保调用相应的ReleaseXXXArrayElements函数，参数是对应Java数组和 GetXXXArrayElements返回的指针。如果必要的话，这个释放函数会复制你做的任何变化（这样它们就反射到java数组），然后释放所有相关的资源。

为了使用java对象的数组，你必须使用GetObjectArrayElement函数和SetObjectArrayElement函数，分别去get，set数组的元素。GetArrayLength函数会返回数组的长度。
使用对象

JNI提供的另外一个功能是在本地代码中使用Java对象。通过使用合适的JNI函数，你可以创建 Java对象，get、set 静态(static)和实例（instance）的域，调用静态(static)和实例（instance）函数。JNI通过ID识别域和方法，一个域或方法的ID是任何处理域和方法的函数的必须参数。

表C列出了用以得到静态(static)和实例（instance）的域与方法的JNI函数。每个函数接受（作为参数）域或方法的类，它们的名称，符号和它们对应返回的jfieldID或jmethodID。

表C
函数     描述
GetFieldID     得到一个实例的域的ID
GetStaticFieldID     得到一个静态的域的ID
GetMethodID     得到一个实例的方法的ID
GetStaticMethodID     得到一个静态方法的ID

※域和方法的函数

如果你有了一个类的实例，它就可以通过方法GetObjectClass得到，或者如果你没有这个类的实例，可以通过FindClass得到。符号是从域的类型或者方法的参数，返回值得到字符串，如表D所示。

表D
Java 类型     符号
boolean     Z
byte     B
char     C
short     S
int     I
long     L
float     F
double     D
void     V
objects对象     Lfully-qualified-class-name;L类名
Arrays数组     [array-type [数组类型
methods方法     (argument-types)return-type(参数类型)返回类型

※确定域和方法的符号

下面我们来看看，如果通过使用数组和对象，从C++中的获取到Java中的DiskInfo 类对象，并返回一个DiskInfo数组:
Java代码
1. //返回一个结构数组，返回一个硬盘信息的结构数组   
2. JNIEXPORT jobjectArray JNICALL Java_com_sundy_jnidemo_ChangeMethodFromJni_getStructArray   
3. (JNIEnv *env, jobject _obj)   
4. {   
5.     //申明一个object数组   
6.     jobjectArray args = 0;   
7.       
8.     //数组大小   
9.     jsize        len = 5;   
10.   
11.     //获取object所属类,一般为ava/lang/Object就可以了   
12.     jclass objClass = (env)->FindClass("java/lang/Object");   
13.   
14.     //新建object数组   
15.     args = (env)->NewObjectArray(len, objClass, 0);   
16.   
17.     /**//* 下面为获取到Java中对应的实例类中的变量*/  
18.   
19.     //获取Java中的实例类   
20.     jclass objectClass = (env)->FindClass("com/sundy/jnidemo/DiskInfo");   
21.       
22.     //获取类中每一个变量的定义   
23.     //名字   
24.     jfieldID str = (env)->GetFieldID(objectClass,"name","Ljava/lang/String;");   
25.     //序列号   
26.     jfieldID ival = (env)->GetFieldID(objectClass,"serial","I");   
27.   
28.     //给每一个实例的变量付值，并且将实例作为一个object，添加到objcet数组中   
29.     for(int i=0; i < len; i++ )   
30.     {   
31.         //给每一个实例的变量付值   
32.         jstring jstr = WindowsTojstring(env,"我的磁盘名字是 D:");   
33.         //(env)->SetObjectField(_obj,str,(env)->NewStringUTF("my name is D:"));   
34.         (env)->SetObjectField(_obj,str,jstr);   
35.         (env)->SetShortField(_obj,ival,10);   
36.   
37.         //添加到objcet数组中   
38.         (env)->SetObjectArrayElement(args, i, _obj);   
39.     }   
40.     //返回object数组   
41.     return args;   
42.   
43. }   
44.   
45. 全部的C/C++方法实现代码如下:   
46. /**//*  
47. *  
48. * 一缕阳光(sundy)版权所有，保留所有权利。  
49. */  
50. /**//**  
51. *  
52. * TODO Jni 中一个从Java到C/C++参数传递测试类  
53. *  
54. * @author 刘正伟(sundy)  
55. * @see   
56. * @see mailto:sundy26@  
57. * @version 1.0  
58. * @since 2005-4-30  
59. *  
60. * 修改记录：  
61. *  
62. * 日期              修改人                 描述  
63. * ----------------------------------------------------------------------------------------------  
64. *  
65. */  
66. // JniManage.cpp : 定义 DLL 应用程序的入口点。   
67. //   
68. package com.sundy.jnidemo;   
69. #include "stdafx.h"  
70.   
71. #include <stdio.h>   
72. #include <math.h>   
73. #include "jni.h"  
74. #include "jni_md.h"  
75.   
76. #include "./head/Base.h"  
77. #include "head/wmi.h"  
78. #include "head/com_sundy_jnidemo_ChangeMethodFromJni.h" //通过javah –jni javactransfer 生成   
79. #include <stdio.h>   
80. #include "stdlib.h"  
81. #include "string.h"  
82.   
83. #pragma comment (lib,"BaseInfo.lib")   
84. #pragma comment (lib,"jvm.lib")   
85. //硬盘信息   
86. struct {   
87.     char name[256];   
88.     int serial;   
89. }DiskInfo;   
90. /**//*BOOL APIENTRY DllMain( HANDLE hModule,  
91.                        DWORD ul_reason_for_call,  
92.                        LPVOID lpReserved  
93.                      )  
94. {  
95.     LPTSTR strName = new CHAR[256] ;  
96.     (*GetHostName)(strName);  
97.     printf("%s\n",strName);  
98.     delete [] strName;  
99.  
100.     return TRUE;  
101. }*/  
102. //将jstring类型转换成windows类型   
103. char* jstringToWindows( JNIEnv *env, jstring jstr );   
104. //将windows类型转换成jstring类型   
105. jstring WindowsTojstring( JNIEnv* env, char* str );   
106.   
107. //主函数   
108. BOOL WINAPI DllMain(HANDLE hHandle, DWORD dwReason, LPVOID lpReserved)   
109. {   
110.     return TRUE;   
111. }   
112. //输入常用的数值类型 Boolean,Byte,Char,Short,Int,Float,Double   
113. JNIEXPORT void JNICALL Java_com_sundy_jnidemo_ChangeMethodFromJni_displayParms   
114. (JNIEnv *env, jobject obj, jstring s, jint i, jboolean b)   
115. {   
116.     const char* szStr = (env)->GetStringUTFChars(s, 0 );   
117.     printf( "String = [%s]\n", szStr );   
118.     printf( "int = %d\n", i );   
119.     printf( "boolean = %s\n", (b==JNI_TRUE ? "true" : "false") );   
120.     (env)->ReleaseStringUTFChars(s, szStr );   
121. }   
122.   
123. //调用一个静态方法,只有一个简单类型输出   
124. JNIEXPORT jint JNICALL Java_com_sundy_jnidemo_ChangeMethodFromJni_add   
125. (JNIEnv *env, jobject, jint a, jint b)   
126. {   
127.     int rtn = (int)(a + b);   
128.     return (jint)rtn;   
129. }   
130.   
131. /**/////输入一个数组,这里输入的是一个Boolean类型的数组   
132. JNIEXPORT void JNICALL Java_com_sundy_jnidemo_ChangeMethodFromJni_setArray   
133. (JNIEnv *env, jobject, jbooleanArray ba)   
134. {   
135.     jboolean* pba = (env)->GetBooleanArrayElements(ba, 0 );   
136.     jsize len = (env)->GetArrayLength(ba);   
137.     int i=0;   
138.     // change even array elements   
139.     for( i=0; i < len; i+=2 )   
140.     {   
141.         pba[i] = JNI_FALSE;   
142.         printf( "boolean = %s\n", (pba[i]==JNI_TRUE ? "true" : "false") );   
143.     }   
144.     (env)->ReleaseBooleanArrayElements(ba, pba, 0 );   
145. }   
146.   
147. /**/////返回一个字符串数组   
148. JNIEXPORT jobjectArray JNICALL Java_com_sundy_jnidemo_ChangeMethodFromJni_getStringArray   
149. (JNIEnv *env, jobject)   
150. {   
151.     jstring      str;   
152.     jobjectArray args = 0;   
153.     jsize        len = 5;   
154.     char*        sa[] = { "Hello,", "world!", "JNI", "is", "fun" };   
155.     int          i=0;   
156.     args = (env)->NewObjectArray(len,(env)->FindClass("java/lang/String"),0);   
157.     for( i=0; i < len; i++ )   
158.     {   
159.         str = (env)->NewStringUTF(sa[i] );   
160.         (env)->SetObjectArrayElement(args, i, str);   
161.     }   
162.     return args;   
163. }   
164.   
165. //返回一个结构,这里返回一个硬盘信息的简单结构类型   
166. JNIEXPORT jobject JNICALL Java_com_sundy_jnidemo_ChangeMethodFromJni_getStruct   
167. (JNIEnv *env, jobject obj)   
168. {   
169.     /**//* 下面为获取到Java中对应的实例类中的变量*/  
170.   
171.     //获取Java中的实例类   
172.     jclass objectClass = (env)->FindClass("com/sundy/jnidemo/DiskInfo");   
173.   
174.     //获取类中每一个变量的定义   
175.     //名字   
176.     jfieldID str = (env)->GetFieldID(objectClass,"name","Ljava/lang/String;");   
177.     //序列号   
178.     jfieldID ival = (env)->GetFieldID(objectClass,"serial","I");   
179.   
180.   
181.     //给每一个实例的变量付值   
182.     (env)->SetObjectField(obj,str,(env)->NewStringUTF("my name is D:"));   
183.     (env)->SetShortField(obj,ival,10);   
184.       
185.     return obj;   
186. }   
187.   
188. //返回一个结构数组，返回一个硬盘信息的结构数组   
189. JNIEXPORT jobjectArray JNICALL Java_com_sundy_jnidemo_ChangeMethodFromJni_getStructArray   
190. (JNIEnv *env, jobject _obj)   
191. {   
192.     //申明一个object数组   
193.     jobjectArray args = 0;   
194.       
195.     //数组大小   
196.     jsize        len = 5;   
197.   
198.     //获取object所属类,一般为ava/lang/Object就可以了   
199.     jclass objClass = (env)->FindClass("java/lang/Object");   
200.   
201.     //新建object数组   
202.     args = (env)->NewObjectArray(len, objClass, 0);   
203.   
204.     /**//* 下面为获取到Java中对应的实例类中的变量*/  
205.   
206.     //获取Java中的实例类   
207.     jclass objectClass = (env)->FindClass("com/sundy/jnidemo/DiskInfo");   
208.       
209.     //获取类中每一个变量的定义   
210.     //名字   
211.     jfieldID str = (env)->GetFieldID(objectClass,"name","Ljava/lang/String;");   
212.     //序列号   
213.     jfieldID ival = (env)->GetFieldID(objectClass,"serial","I");   
214.   
215.     //给每一个实例的变量付值，并且将实例作为一个object，添加到objcet数组中   
216.     for(int i=0; i < len; i++ )   
217.     {   
218.         //给每一个实例的变量付值   
219.         jstring jstr = WindowsTojstring(env,"我的磁盘名字是 D:");   
220.         //(env)->SetObjectField(_obj,str,(env)->NewStringUTF("my name is D:"));   
221.         (env)->SetObjectField(_obj,str,jstr);   
222.         (env)->SetShortField(_obj,ival,10);   
223.   
224.         //添加到objcet数组中   
225.         (env)->SetObjectArrayElement(args, i, _obj);   
226.     }   
227.     //返回object数组   
228.     return args;   
229.   
230. }   
231.   
232. //将jstring类型转换成windows类型   
233. char* jstringToWindows( JNIEnv *env, jstring jstr )   
234. {   
235.     int length = (env)->GetStringLength(jstr );   
236.     const jchar* jcstr = (env)->GetStringChars(jstr, 0 );   
237.     char* rtn = (char*)malloc( length*2+1 );   
238.     int size = 0;   
239.     size = WideCharToMultiByte( CP_ACP, 0, (LPCWSTR)jcstr, length, rtn,(length*2+1), NULL, NULL );   
240.     if( size <= 0 )   
241.         return NULL;   
242.     (env)->ReleaseStri