Android深刻理解JNI（二）类型转换、方法签名和JNIEnv

相关文章
Android深刻理解JNI系列

前言

上一篇文章介绍了JNI的基本原理和注册，这一篇接着带领你们来学习JNI的数据类型转换、方法签名和JNIEnv。

1.数据类型的转换

首先给出上一篇文章中android_media_MediaRecorder.cpp中的android_media_MediaRecorder_start方法：
frameworks/base/media/jni/android_media_MediaRecorder.cpp

static void android_media_MediaRecorder_start(JNIEnv *env, jobject thiz) {
    ALOGV("start");
    sp<MediaRecorder> mr = getMediaRecorder(env, thiz);
    process_media_recorder_call(env, mr->start(), "java/lang/RuntimeException", "start failed.");
}复制代码

android_media_MediaRecorder_start方法有一个参数为jobject类型，它是JNI层的数据类型，Java的数据类型到了JNI层就须要转换为JNI层的数据类型。Java的数据类型分为基本数据类型和引用数据类型，JNI层对于这两种类型也作了区分，咱们先来查看基本数据类型的转换。

1.1 基本数据类型的转换

Java	Native	Signature
byte	jbyte	B
char	jchar	C
double	jdouble	D
float	jfloat	F
int	jint	I
short	jshort	S
long	jlong	J
boolean	jboolean	Z
void	void	V

从上表能够可看出，基本数据类型转换，除了void，其余的数据类型只须要在前面加上“j”就能够了。第三列的Signature 表明签名格式，后文会介绍它。接着来看引用数据类型的转换。

1.2 引用数据类型的转换

Java	Native	Signature
全部对象	jobject	L+classname +;
Class	jclass	Ljava/lang/Class;
String	jstring	Ljava/lang/String;
Throwable	jthrowable	Ljava/lang/Throwable;
Object[]	jobjectArray	[L+classname +;
byte[]	jbyteArray	[B
char[]	jcharArray	[C
double[]	jdoubleArray	[D
float[]	jfloatArray	[F
int[]	jintArray	[I
short[]	jshortArray	[S
long[]	jlongArray	[J
boolean[]	jbooleanArray	[Z

从上表可一看出，数组的JNI层数据类型须要以“Array”结尾，签名格式的开头都会有“[”。除了数组之外，其余的引用数据类型的签名格式都会以“;”结尾。
另外，引用数据类型还具备继承关系，以下所示：

1337955954_3405.jpg

再来列举MediaRecorder框架的Java方法：
frameworks/base/media/java/android/media/MediaRecorder.java

private native void _setOutputFile(FileDescriptor fd, long offset, long length) throws IllegalStateException, IOException复制代码

_setOutputFile方法对应的JNI层的方法为：
frameworks/base/media/jni/android_media_MediaRecorder.cpp

static void android_media_MediaRecorder_setOutputFileFD(JNIEnv *env, jobject thiz, jobject fileDescriptor, jlong offset, jlong length) {
  ...
}复制代码

对比这两个方法能够看到，FileDescriptor类型转换为了jobject类型 ，long类型转换为了jlong类型。

2.方法签名

前面表格已经列举了数据类型的签名格式，方法签名就由签名格式组成，那么，方法签名有什么做用呢？咱们看下面的代码。
frameworks/base/media/jni/android_media_MediaRecorder.cpp

static const JNINativeMethod gMethods[] = {
  ...
    {"native_init",       "()V",        (void *)android_media_MediaRecorder_native_init},
    {"native_setup",      "(Ljava/lang/Object;Ljava/lang/String;Ljava/lang/String;)V",
    (void *)android_media_MediaRecorder_native_setup},
   ...
};复制代码

gMethods数组中存储的是MediaRecorder的Native方法与JNI层方法的对应关系，
其中"()V"和 "(Ljava/lang/Object;Ljava/lang/String;Ljava/lang/String;)V"就是方法签名。咱们知道Java是有重载方法的，能够定义方法名相同，但参数不一样的方法，正由于如此，在JNI中仅仅经过方法名是没法找到 Java中的具体方法的，JNI为了解决这一问题就将参数类型和返回值类型组合在一块儿做为方法签名。经过方法签名和方法名就能够找到对应的Java方法。
JNI的方法签名的格式为：

(参数签名格式...)返回值签名格式复制代码

拿上面gMethods数组的native_setup方法举例，他在Java中是以下定义的：

private native final void native_setup(Object mediarecorder_this, String clientName, String opPackageName) throws IllegalStateException;复制代码

它在JNI中的方法签名为：

(Ljava/lang/Object;Ljava/lang/String;Ljava/lang/String;)V"复制代码

参照本文第一节给出的类型转换表格，native_setup方法的第一个参数的签名为“Ljava/lang/Object;”，后两个参数的签名为“Ljava/lang/String;”，返回值类型void 的签名为“V”，组合起来就是上面的方法签名。

若是咱们每次编写JNI时都要写方法签名，也会是一件比较头疼的事，幸亏Java提供了javap命令来自动生成方法签名。咱们先写一个简单的MediaRecorder.java包含上面的native_setup方法：

public class MediaRecorder {
    static {
        System.loadLibrary("media_jni");
        native_init();
    }
    private static native final void native_init();
    private native final void native_setup(Object mediarecorder_this, String clientName, String opPackageName) throws IllegalStateException;
}复制代码

这个文件的在个人本地地址为D:/Android/MediaRecorder.java，接着执行以下命令：

javac D:/Android/MediaRecorder.java复制代码

执行命令后会生成MediaRecorder.class文件，最后使用javap命令：

javap -s -p D:/Android/MediaRecorder.class复制代码

其中s 表示输出内部类型签名，p表示打印出全部的方法和成员（默认打印public成员），最终会在cmd中的打印结果以下：

能够很清晰的看到输出的native_setup方法的签名和此前给出的一致。

3.JNIEnv

JNIEnv 是一个指向所有JNI方法的指针，该指针只在建立它的线程有效，不能跨线程传递，所以，不一样线程的JNIEnv是彼此独立的，JNIEnv的主要做用有两点：
1.调用Java的方法。
2.操做Java（获取Java中的变量和对象等等）。

先来看JNIEnv的定义，以下所示。
libnativehelper/include/nativehelper/jni.h

#if defined(__cplusplus)
typedef _JNIEnv JNIEnv;//C++中JNIEnv的类型 
typedef _JavaVM JavaVM; 
#else
typedef const struct JNINativeInterface* JNIEnv;//C中JNIEnv的类型 
typedef const struct JNIInvokeInterface* JavaVM;
#endif复制代码

这里使用预约义宏__cplusplus来区分C和C++两种代码，若是定义了__cplusplus，则是C++代码中的定义，不然就是C代码中的定义。
在这里咱们也看到了JavaVM，它是虚拟机在JNI层的表明，在一个虚拟机进程中只有一个JavaVM，所以，该进程的全部线程均可以使用这个JavaVM。经过JavaVM的AttachCurrentThread函数能够获取这个线程的JNIEnv，这样就能够在不一样的线程中调用Java方法了。还要记得在使用AttachCurrentThread函数的线程退出前，务必要调用DetachCurrentThread函数来释放资源。

jfieldID和jmethodID

在JNI中用jfieldID和jmethodID来表明Java类中的成员变量和方法，能够经过JNIEnv的下面两个方法来分别获得：

jfieldID GetFieldID(jclass clazz,const char *name,const char *sig);
jmethodID GetFieldID(jclass clazz,const char *name,const char *sig);复制代码

其中，jclass表明Java类，name表明成员方法或者成员变量的名字，sig为这个方法和变量的签名。
咱们来查看MediaRecorder框架的JNI层是如何使用上述的两个方法的，以下所示。
frameworks/base/media/jni/android_media_MediaRecorder.cpp

static void android_media_MediaRecorder_native_init(JNIEnv *env) {
    jclass clazz;
    clazz = env->FindClass("android/media/MediaRecorder");//1
    if (clazz == NULL) {
        return;
    }
    fields.context = env->GetFieldID(clazz, "mNativeContext", "J");//2
    if (fields.context == NULL) {
        return;
    }
    fields.surface = env->GetFieldID(clazz, "mSurface", "Landroid/view/Surface;");//3
    if (fields.surface == NULL) {
        return;
    }
    jclass surface = env->FindClass("android/view/Surface");
    if (surface == NULL) {
        return;
    }
    fields.post_event = env->GetStaticMethodID(clazz, "postEventFromNative",
                                               "(Ljava/lang/Object;IIILjava/lang/Object;)V");//4
    if (fields.post_event == NULL) {
        return;
    }
}复制代码

注释1处，经过FindClass来找到Java层的MediaRecorder的Class对象，并赋值给jclass类型的变量clazz，所以，clazz就是Java层的MediaRecorder在JNI层的表明。注释2和注释3处的代码用来找到Java层的MediaRecorder中名为mNativeContext和mSurface的成员变量，并分别赋值给context和surface。注释4出获取Java层的MediaRecorder中名为postEventFromNative的静态方法，并赋值给post_event。其中fields的定义为：

struct fields_t {
    jfieldID    context;
    jfieldID    surface;
    jmethodID   post_event;
};
static fields_t fields;复制代码

将这些成员变量和方法赋值给jfieldID和jmethodID类型的变量主要是为了效率考虑，若是每次调用相关方法时都要进行查询方法和变量，显然会效率很低，所以在MediaRecorder框架JNI层的初始化方法android_media_MediaRecorder_native_init中将这些jfieldID和jmethodID类型的变量保存起来，以供后续使用。

使用jfieldID和jmethodID

咱们保存了jfieldID和jmethodID类型的变量，接着怎么使用它们呢，以下所示。
frameworks/base/media/jni/android_media_MediaRecorder.cpp

void JNIMediaRecorderListener::notify(int msg, int ext1, int ext2)
{
    ALOGV("JNIMediaRecorderListener::notify");

    JNIEnv *env = AndroidRuntime::getJNIEnv();
    env->CallStaticVoidMethod(mClass, fields.post_event, mObject, msg, ext1, ext2, NULL);//1
}复制代码

在注释1处调用了JNIEnv的CallStaticVoidMethod函数，其中就传入了fields.post_event，从上面咱们得知，它实际上是保存了Java层MediaRecorder的静态方法postEventFromNative：
frameworks/base/media/java/android/media/MediaRecorder.java

private static void postEventFromNative(Object mediarecorder_ref, int what, int arg1, int arg2, Object obj) {
    MediaRecorder mr = (MediaRecorder)((WeakReference)mediarecorder_ref).get();
    if (mr == null) {
        return;
    }
    if (mr.mEventHandler != null) {
        Message m = mr.mEventHandler.obtainMessage(what, arg1, arg2, obj);
        mr.mEventHandler.sendMessage(m);
    }
}复制代码

这样咱们就能在JNI层中访问Java的静态方法了。同理，若是想要访问Java的方法则可使用JNIEnv的CallVoidMethod函数。
上面的例子是使用了jmethodID，接着来查看jfieldID：
frameworks/base/media/jni/android_media_MediaRecorder.cpp

static void android_media_MediaRecorder_prepare(JNIEnv *env, jobject thiz) {
    ALOGV("prepare");
    sp<MediaRecorder> mr = getMediaRecorder(env, thiz);
    jobject surface = env->GetObjectField(thiz, fields.surface);//1
    if (surface != NULL) {
        const sp<Surface> native_surface = get_surface(env, surface);
       ...
    }
    process_media_recorder_call(env, mr->prepare(), "java/io/IOException", "prepare failed.");复制代码

在注释1处调用了JNIEnv的GetObjectField函数，参数中的fields.surface用来保存Java层MediaRecorde中的成员变量mSurface，mSurface的类型为Surface，这样经过GetObjectField函数就获得了mSurface在JNI层中对应的jobject类型变量surface 。

参考资料
《深刻理解Android卷一》
Android JNI原理分析
JNI总管：JNIEnv
Android Framework层JNI的使用浅析
JNI学习积累之二 ---- 数据类型映射、域描述符说明
JNI Tips

---

欢迎关注个人微信公众号，第一时间得到博客更新提醒，以及更多成体系的Android相关原创技术干货。
扫一扫下方二维码或者长按识别二维码，便可关注。