[声明]
======================================================
1 本博客jni系列的基本是我学习《The Java™ Native Interface Programmer’s Guide and Specification》的笔记,所以你会发现很多图片和内容来自这篇文章。
2 因为搜资料发现很多中文都是入门的很浅显的文章,没有深入的讲解的资料, 只有这个英文的文档讲的比较详细,故以它为学习对象。
3 因为有引用别人的,所以请不要用于商业用途,只用于学习研讨,对本系列文章我不承担任何直接或相关责任。
4 欢迎转载引用,但要注明出自 http://blog.csdn.net/cdjlove 和 《The Java™ Native Interface Programmer’s Guide and Specification》
5 欢迎讨论技术问题。但不能询问基本的可以网上搜到的问题。
本人保留本系列文章的所有权,随时可能会修改
======================================================
[前叙]
基本函数:
访问字符串
+-------------------------------------------------------------| GetStringChars ReleaseStringChars GetStringLength
| GetStringUTFChars ReleaseStringUTFChars GetStringUTFLength
| GetStringCritical ReleaseStringCritical
| GetStringRegion SetStringRegion
| GetStringUTFRegion SetStringURTRegion
| NewString NewStringUTF
+---------------------------------------------------
访问数组
+---------------------------------------------------
| Get<Type>ArrayElements Release<Type>ArrayElements
| GetPrimitiveArrayCritical ReleasePrimitiveArrayCritical
| Get<Type>ArrayRegion Set<Type>ArrayRegion
| New<Type>Array
| GetArrayLength
+---------------------------------------------------
具体图片见本文最后
[本文内容]
JNI开发面临的第一步就是数据类型转换问题,c和java中的数据类型相互转换。今天就讲这个,大致可以分为两大类,第一是基本数据类型,即原始数据类型,第二引用类型。
1 看一个简单的例子
class Prompt {
// native method that prints a prompt and reads a line
private native String getLine(String prompt);
public static void main(String args[]) {
Prompt p = new Prompt();
String input = p.getLine("Type a line: ");
System.out.println("User typed: " + input);
}
static {
System.loadLibrary("Prompt");
}
}
2 Prompt.main 调用本地方法getLine,本地方法在java的.java文件中如何写呢?只需要2步;
第一步:声明 private native String getLine(String prompt); 一般声明private, native 是必须要的,返回值String根据对应函数返回类型而不同,参数也同理。
第二步: 加载函数所在的库,static {System.loadLibrary("Prompt");} Prompt即为库名称,可以省去前后缀“lib”和“.so”。
3 根据《学习一》的步骤生成.h头文件,头文件中会含有
"JNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject this, jstring prompt);"
头文件生成的东西基本不要改动,然后编写对应的.c源文件了。JNIEXPORT和JNICALL是自动生成的我们不用管他们,函数名Java_Prompt_getLine生成机制是Java_+类名+函数名。 更多的关于c函数命名格式的以后会说明。
4 JNIENv *env 说明:指向一个包含函数指针的表。表(函数表)中每个条目都指向一个jni函数。本地方法总是通过这个指针去访问java虚拟机中的数据结构中的JNI函数中的一个。JNIEnv接口指针图示如下:Figure 3.1
第二个参数jobject this根据本地方法是静态的还是实例方法而不同。如果本地方法是实例方法,那么第二个参数则是本地方法被调用的对象的一个索引(就是指向对象的指针,这个对象是调用这个本地方法的对象),类似c++中的this指针。如果本地方法是静态的,那么第二个参数则是方法被定义的类的索引。我们例子中的本地方法是实例方法,因此jobject参数是指向object本身。
5 聊到重点了,类型转换。先聊第一种基本数据类型,简单啊,java定义了这些类型的直接映射类型,int:jint
全部类型:boolean:jboolean byte:jbyte char:jchar short:jshort int:jint long:jlong float:jfloat double:jdouble
6 再看第二种引用数据类型,什么字符串啊 数组 二维数组 对象数组都属于此类。这个比较复杂,先聊字符串的吧。
java字符串传到本地方法中的参数是jstring型的,如何访问里面的内容呢?不能像c那样直接使用,必须通过JNI提供的函数去访问的,因为java说处于安全考虑,把这些东西在底层做了处理,让程序员不可见,只能通过他们提供的方法去访问到。啥方法呢?
就是上面提供的函数,那些函数都是跟访问字符串有关的。记这么多东西,真是为难我老人家了。上面4不是讲到JNIENv *env嘛,指向一个包含函数指针的表,因此const jbyte* str = (*env)->GetStringUTFChars(env, prompt, NULL);具体函数用法可以去问google,说道谷歌,我对天朝有好多牢骚要发。
7 具体上面函数的使用不说了,大家可以google,讲几个重点:
一是java字符串内部编码是unicode的,如果我们需要UTF的就用UTF系列的函数,
二是记得需要释放资源的函数要调用对应的函数释放资源,否则内存泄露,内存用完就系统崩溃了,
三是有些函数记得检查返回值是否为NULL,因为有的函数内部需要申请内存,不一定能申请成功。有对应释放资源的函数的函数需要检查返回值。
8 Get/ReleaseStringCritical一对函数大家要注意,这个Get函数要工作在临界区,有人可能不懂这个概念,去google吧,基本意思就是调用他的后在未调用他的兄弟Release时,不允许干其他需要等待的事情,比如等待IO返回数据,等待其他线程返回数据等。否则会导致死锁。这个jNI资料讲了好多,好啰嗦的。说白了就是大家少用他。大家有兴趣可以跟我一起探讨,我理解是因为这些函数需要从内部返回指针,如果不是工作在临界区,那么java虚拟机会可能会进行垃圾收集,然后碰到内部返回到外部指针的内存,垃圾收集就会pin起来,这就可能导致死锁。
9 如何选择这些函数?[见图3.2]
class IntArray {
private native int sumArray(int[] arr);
public static void main(String[] args) {
IntArray p = new IntArray();
int arr[] = new int[10];
for (int i = 0; i < 10; i++) {
arr[i] = i;
}
int sum = p.sumArray(arr);
System.out.println("sum = " + sum);
}
static {
System.loadLibrary("IntArray");
}
}
数组被表示为jarray 索引类型,它的子类是jintArray。正如jstring不是c的字符串类型一样,jarray也不是c的数组类型。我们不能直接通过jarray索引来实现Java_IntArray_sumArray本地方法。我们必须使用恰当的JNI函数来访问原始的数据类型元素,如下所示
JNIEXPORT jint JNICALL Java_IntArray_sumArray(JNIEnv *env, jobject obj, jintArray arr)
{
jint buf[10];
jint i, sum = 0;
(*env)->GetIntArrayRegion(env, arr, 0, 10, buf);
for (i = 0; i < 10; i++) {
sum += buf[i];
}
return sum;
}
根据最开始写的几个函数,大家可以去了解那几个函数的使用,基本就知道了怎么去访问数组了。
11 如何选择函数[插图]
12 访问对象数组:JNI提供一对单独的函数来访问对象数组。GetObjectArrayElement返回给定的索引号的元素,因此SetObjectArrayElement更新给定索引号的元素。不像原始类型数组那种情形,我们不可以一次获取所有对象或拷贝多个对象。String和数组是引用类型。我们可以使用函数Get/SetObjectArrayElement来访问字符串或数组型数组。
class ObjectArrayTest {
private static native int[][] initInt2DArray(int size);
public static void main(String[] args) {
int[][] i2arr = initInt2DArray(3);
for (int i = 0; i < 3; i++) {
for (int j = 0; j < 3; j++) {
System.out.print(" " + i2arr[i][j]);
}
System.out.println();
}
}
static {
System.loadLibrary("ObjectArrayTest");
}
}
本地方法initInt2DArray 根据传入的个数创建一个2维数组,本地方法实现代码如下:
JNIEXPORT jobjectArray JNICALL Java_ObjectArrayTest_initInt2DArray(JNIEnv *env, jclass cls, int size)
{
jobjectArray result;
int i;
jclass intArrCls = (*env)->FindClass(env, "[I");//1 获取类
if (intArrCls == NULL) {
return NULL; /* exception thrown */
}
//2 用上面的intArrCls 创建一个包含数组的一维数组
result = (*env)->NewObjectArray(env, size, intArrCls,NULL);
if (result == NULL) {
return NULL; /* out of memory error thrown */
}
for (i = 0; i < size; i++) {
jint tmp[256]; /* make sure it is large enough! */
int j;
jintArray iarr = (*env)->NewIntArray(env, size);//3 新建一个int数组
if (iarr == NULL) {
return NULL; /* out of memory error thrown */
}
for (j = 0; j < size; j++) {
tmp[j] = i + j;
}
(*env)->SetIntArrayRegion(env, iarr, 0, size, tmp);//4 给新建的一维数组赋值
(*env)->SetObjectArrayElement(env, result, i, iarr);//5 给result 中的元素赋object值
(*env)->DeleteLocalRef(env, iarr);//6 释放iarr
}
return result;
}
分三步,一获取类对象描述,二用获取的类对象构建一个数组,三给数组的元素赋类对象值(其中包括新建子对象,赋值,填充到父对象,释放资源)。
这章结束,下一章说下类的字段和方法的操作
[附录]函数表格