android JNI编程技巧

      本篇将介绍在JNI编程中如何传递参数和返回值。
      首先要强调的是，native方法不但可以传递Java的基本类型做参数，还可以传递更复杂的类型，比如String，数组，甚至自定义的类。这一切都可以在jni.h中找到答案。
      1. Java基本类型的传递
          用过Java的人都知道，Java中的基本类型包括boolean，byte，char，short，int，long，float，double 这样几种，如果你用这几种类型做native方法的参数，当你通过javah -jni生成.h文件的时候，只要看一下生成的.h文件，就会一清二楚，这些类型分别对应的类型是 jboolean，jbyte，jchar，jshort，jint，jlong，jfloat，jdouble 。这几种类型几乎都可以当成对应的C++类型来用，所以没什么好说的。

       2. String参数的传递

   Java的String和C++的string是不能对等起来的，所以处理起来比较麻烦。先看一个例子，

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");
	}
}

      在这个例子中，我们要实现一个native方法String getLine(String prompt);读入一个String参数，返回一个String值。通过执行javah -jni得到的头文件是这样的

#include
#ifndef _Included_Prompt
#define _Included_Prompt
#ifdef __cplusplus
extern "C" {
#endif
JNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject this, jstring prompt);
#ifdef __cplusplus
}
#endif
#endif

      jstring是JNI中对应于String的类型，但是和基本类型不同的是，jstring不能直接当作C++的string用。如果你用 cout << prompt << endl;编译器肯定会扔给你一个错误信息的。其实要处理jstring有很多种方式，这里只讲一种我认为最简单的方式，看下面这个例子：

#include "Prompt.h"
#include
JNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject obj, jstring prompt)
{
	const char* str;
	str = env->GetStringUTFChars(prompt, false);
	if(str == NULL) {
	return NULL; /* OutOfMemoryError already thrown */
}
std::cout << str << std::endl;
env->ReleaseStringUTFChars(prompt, str);
char* tmpstr = "return string succeeded";
jstring rtstr = env->NewStringUTF(tmpstr);
return rtstr;
}

        在上面的例子中，作为参数的prompt不能直接被C++程序使用，先做了如下转换str = env->GetStringUTFChars(prompt, false);将jstring类型变成一个char*类型。返回的时候，要生成一个jstring类型的对象，也必须通过如下命令，jstring rtstr = env->NewStringUTF(tmpstr);
这里用到的GetStringUTFChars和NewStringUTF都是JNI提供的处理String类型的函数，还有其他的函数这里就不一一列举了。
3. 数组类型的传递
     和String一样，JNI为Java基本类型的数组提供了j*Array类型，比如int[]对应的就是jintArray。来看一个传递int数组的例子，Java程序就不写了，

JNIEXPORT jint JNICALL Java_IntArray_sumArray(JNIEnv *env, jobject obj, jintArray arr)
{
	jint *carr;
	carr = env->GetIntArrayElements(arr, false);
	if(carr == NULL) {
	   return 0; /* exception occurred */
    }
	jint sum = 0;
	for(int i=0; i<10; i++) {
	sum += carr[i];
	}
	env->ReleaseIntArrayElements(arr, carr, 0);
	return sum;
}

4. 二维数组和String数组

在JNI中，二维数组和String数组都被视为object数组，因为数组和String被视为object。仍然用一个例子来说明，这次是一个二维int数组，作为返回值。

JNIEXPORT jobjectArray JNICALL Java_ObjectArrayTest_initInt2DArray(JNIEnv *env, jclass cls, int size)
{
	jobjectArray result;
	jclass intArrCls = env->FindClass("[I");
	result = env->NewObjectArray(size, intArrCls, NULL);
	for (int i = 0; i < size; i++) {
		jint tmp[256]; /* make sure it is large enough! */
		jintArray iarr = env->NewIntArray(size);
		for(int j = 0; j < size; j++) {
			tmp[j] = i + j;
		}
	env->SetIntArrayRegion(iarr, 0, size, tmp);
	env->SetObjectArrayElement(result, i, iarr);
	env->DeleteLocalRef(iarr);
	}
	return result;
}

上面代码中的第三行，jobjectArray result;因为要返回值，所以需要新建一个jobjectArray对象。jclass intArrCls = env->FindClass("[I");
是创建一个jclass的引用，因为result的元素是一维int数组的引用，所以intArrCls必须是一维int数组的引用，这一点是如何保证的呢？
注意FindClass的参数"[I"，JNI就是通过它来确定引用的类型的，I表示是int类型，[标识是数组。对于其他的类型，都有相应的表示方法。

Z boolean
B byte
C char
S short
I int
J long
F float
D double

String是通过“Ljava/lang/String;”表示的，那相应的，String数组就应该是“[Ljava/lang/String;”。
还是回到代码，result = env->NewObjectArray(size, intArrCls, NULL);的作用是为result分配空间。

jintArray iarr = env->NewIntArray(size);

是为一维int数组iarr分配空间。

env->SetIntArrayRegion(iarr, 0, size, tmp);
是为iarr赋值。

env->SetObjectArrayElement(result, i, iarr);
是为result的第i个元素赋值。

通过上面这些步骤，我们就创建了一个二维int数组，并赋值完毕，这样就可以做为参数返回了。
如果了解了上面介绍的这些内容，基本上大部分的任务都可以对付了。虽然在操作数组类型，尤其是二维数组和String数组的时候，比起在单独的语言中编程要麻烦，但既然我们享受了跨语言编程的好处，必然要付出一定的代价。
有一点要补充的是，本文所用到的函数调用方式都是针对C++的，如果要在C中使用，所有的env->都要被替换成(*env)->，而且后面的函数中需要增加一个参数env，具体请看一下jni.h的代码。另外还有些省略的内容，可以参考JNI的文档：Java Native Interface 6.0 Specification，在JDK的文档里就可以找到。如果要进行更深入的JNI编程，需要仔细阅读这个文档。接下来的高级篇，也会讨论更深入的话题。
关于JNI编程更深入的话题，包括：在native方法中访问Java类的域和方法，将Java中自定义的类作为参数和返回值传递等等。了解这些内容，将会对JNI编程有更深入的理解，写出的程序也更清晰，易用性更好。
1. 在一般的Java类中定义native方法
在前两篇的例子中，都是将native方法放在main方法的Java类中，实际上，完全可以在任何类中定义native方法。这样，对于外部来说，这个类和其他的Java类没有任何区别。
2. 访问Java类的域和方法
native方法虽然是native的，但毕竟是方法，那么就应该同其他方法一样，能够访问类的私有域和方法。实际上，JNI的确可以做到这一点，我们通过几个例子来说明。

public class ClassA {
	String str_ = "abcde";
	int number_;
	public native void nativeMethod();
	private void javaMethod() {
		System.out.println("call java method succeeded");
	}
	static {
		System.loadLibrary("ClassA");
	}
}

      在这个例子中，我们在一个没有main方法的Java类中定义了native方法。我们将演示如何在nativeMethod()中访问域str_，number_和方法javaMethod()，nativeMethod()的C++实现如下：

    

JNIEXPORT void JNICALL Java_testclass_ClassCallDLL_nativeMethod(JNIEnv *env, jobject obj) {
	// access field
	jclass cls = env->GetObjectClass(obj);
	jfieldID fid = env->GetFieldID(cls, "str_", "Ljava/lang/String;");
	jstring jstr = (jstring)env->GetObjectField(obj, fid);
	const char *str = env->GetStringUTFChars(jstr, false);
	if(std::string(str) == "abcde")
	std::cout << "access field succeeded" << std::endl;
	jint i = 2468;
	fid = env->GetFieldID(cls, "number_", "I");
	env->SetIntField(obj, fid, i);
	// access method
	jmethodID mid = env->GetMethodID(cls, "javaMethod", "()V");
	env->CallVoidMethod(obj, mid);
	}

上面的代码中，通过如下两行代码获得str_的值，jfieldID fid = env->GetFieldID(cls, "str_", "Ljava/lang/String;");
jstring jstr = (jstring)env->GetObjectField(obj, fid);
第一行代码获得str_的id，在GetFieldID函数的调用中需要指定str_的类型，第二行代码通过str_的id获得它的值，当然我们读到的是一个jstring类型，不能直接显示，需要转化为char*类型。
接下来我们看如何给Java类的域赋值，看下面两行代码:
fid = env->GetFieldID(cls, "number_", "I");
env->SetIntField(obj, fid, i);
第一行代码同前面一样，获得number_的id，第二行我们通过SetIntField函数将i的值赋给number_，其他类似的函数可以参考JDK的文档。
访问javaMethod()的过程同访问域类似，JNI 调用java类的方法与反射代码类似。
先得到object的类。-->jobject obj;
jclass cls = env->GetObjectClass(obj);
然后查找方法：
jmethodID mid = env->GetMethodID(cls, "javaMethod", "()V");
然后用这个方法id去执行obj的方法。
env->CallVoidMethod(obj, mid);
需要注意的是 GetMethodID方法的格式。
jmethodID GetMethodID(JNIEnv *env, jclass clazz,
const char *name, const char *sig);
JNIEnv这个参数C++中不需要。clazz就是前面得到的jclass.
name则是方法名称，sig是方法签名。
方法签名有特定的格式：(param-type)ret-type，括号内表示该方法传入参数类型，后面的是返回类型
其中param-type和ret-type都是由特定符号组成，各java primitive type都有各自对应符号如下表。
Table 3-2 Java VM Type Signatures
Type Signature Java Type
Z boolean
B byte
C char
S short
I int
J long
F float
D double
L fully-qualified-class ; fully-qualified-class
[ type type[]
( arg-types ) ret-type method type
比如long f (int n, String s, int[] arr);
的signature就是(ILjava/lang/String;[I)J
另外千万别忘记L fully-qualified-class ; 这个格式后面的那个;号。
jmethodID mid = env->GetMethodID(cls, "javaMethod", "()V");
env->CallVoidMethod(obj, mid);
需要强调的是，在GetMethodID中，我们需要指定javaMethod方法的类型，域的类型很容易理解，方法的类型如何定义呢，在上面的例子中，我们用的是()V，V表示返回值为空，()表示参数为空。如果是更复杂的函数类型如何表示？看一个例子，
long f (int n, String s, int[] arr);
这个函数的类型符号是(ILjava/lang/String;[I)J，I表示int类型，Ljava/lang/String;表示String类型，[I表示int数组，J表示long。这些都可以在文档中查到。