ANDROID JNI之JAVA域与c域的互操作

田海立@CSDN 2012-1-20

本文讲述AndroidJava域与C域互操作：Java域调用c域的函数；c域访问Java域的属性和方法；c域生成的对象的保存与使用。重点讲解c域如何访问Java域。

虽然AndroidJNI实现中，c实现与c++实现是有所区别的，但行文中并未区分c还是c++。

0. Android中的JNI

Android的APP开发一般是用Java，用到的系统服务和操作系统相关的东西是用c写的。Java到c的访问，通过JNI(Java Native Interface)，一般情况下的考虑是Java -> c，也有c -> Java的情形，这在Android中经常使用。

1. Java域调用c域的函数

通常JNI的使用：

1) Java中某个类的方法声明前加上native修饰；

2) 在c中实现该方法，并把实现该方法的c文件编译进动态库；

3) 在java中使用该方法前，用System.loadLibrary()装载。

4) 在步骤2中的c文件中定义JNI_OnLoad，并在其中通过JNIEnv:: RegisterNatives()把Java里声明的Java native方法与c中定义的实现函数关联起来。

其中的实现细节不是本文描述的重点，如有疑问可参阅其它文章。

C域中的实现函数的Signature中返回值应该与java中声明的原型一致；参数列表对比java中声明的原型前面多了两个参数：

JNIEnv *env 虚拟机运行的环境，通过它来使用JVM的各种方法。后面会经常用到；

jobject this 调用该函数的对象。

（当然这里所说的类型一致也是指的要对应，Java与c里的类型不是完全一致，在各自领域分别有其类型的表述，比如Java里的int类型，在JNI的c中就对应的是jint，诸如此类。详细对照表，Google之）

这样Java中native方法只是有声明并无实现，具体实现在c中进行，而Java中的该方法当然可以在Java中有访问权限的地方用到。

2. c域访问Java域

JNI一般的使用情形是Java -> c，也有c -> Java里的情形，在Android中还经常用到。

下面以Android中Camera的JNI实现讲解

android.hardware.Camera.java是Java类，其中包含了一些native方法；android_hardware_camera.cpp是JNI的cpp实现。

而图中，

fields_t是android_hardware_camera.cpp定义的一个结构体类型；

fields: fields_t是android_hardware_camera.cpp定义的一个fields_t型的变量；

android.hardware.Camera,Surface, Camera.CameraInfo都是Java中定义的类。

下面章节分别讲解，cpp（android_hardware_camera.cpp）中如何访问Java中的属性和方法。

2.1. c域访问Java域的属性

facing、orientation都是Camera.CameraInfo中的属性，类型是int型。

在注册native函数之前，c中就已经把Java域中的属性的jfieldID得到了。通过下列方法：

jclass clazz =env->FindClass("android/hardware/Camera$CameraInfo");
jfieldID field =env->GetFieldID(clazz, "facing", "I");

如果执行成功，把field保存到上面图中的fileds变量的facing: jfieldID中。

而用到时，看如何使用：

Java中调用android.hardware.Camera::getCameraInfo()会调到cpp中的android_hardware_Camera_getCameraInfo (JNIEnv *env, jobject thiz,jint cameraId, jobject info_obj)

参数中info_obj是Java中传进来的CameraInfo的对象。

Cpp函数实现中，

static voidandroid_hardware_Camera_getCameraInfo(JNIEnv *env, jobject thiz,
    jint cameraId, jobject info_obj)
{
    CameraInfo cameraInfo;
    status_t rc =Camera::getCameraInfo(cameraId, &cameraInfo);
    // …
    env->SetIntField(info_obj, fields.facing,cameraInfo.facing);
    // …
}

Cpp中得到CameraInfo，然后通过env->SetIntField()设置到Java对象的属性中。

总结一下，c中如何访问Java对象的属性：

1) 通过JNIEnv::FindClass()找到对应的jclass；

2) 通过JNIEnv::GetFieldID()找到类中属性的jfieldID；

3) 通过JNIEnv::GetXyzField()/SetXyzField()获取或设置Java对象的属性。Xyz是属性的类型，可以是Int/Void/Boolean/Byte/Char/Short/Long/Float/Double/Object。

2.2. c域访问Java域的方法

c域访问Java域的方法的实现与访问属性类似，看android.hardware.Camera中的postEventFromNative()如何被cpp中调用。

在注册native函数之前，c中就已经把Java域中的方法的jmethodID得到了。通过下列方法：

jclass clazz =env->FindClass("android/hardware/Camera");
fields.post_event =env->GetStaticMethodID(clazz, "postEventFromNative",
                                                  "(Ljava/lang/Object;IIILjava/lang/Object;)V");

fileds.post_event保存了Java中postEventFromNative()的jmethodID。

而用到时，看如何使用：

在底层需要通知上层信息的时候会通过android.hardware.Camera::postEventFromNative()。

android_hardware_camera.cpp中，

JNIEnv *env =AndroidRuntime::getJNIEnv();
env->CallStaticVoidMethod(mCameraJClass,fields.post_event,
            mCameraJObjectWeak, msgType, ext1,ext2, NULL);

Cpp中通过env->CallStaticVoidMethod()调用Java对象的方法。

总结一下，c中如何访问Java对象的属性：

1) 通过JNIEnv::FindClass()找到对应的jclass；

2) 通过JNIEnv::GetMethodID()/GetStaticMethodID()找到类中属性的jfieldID；

3) 通过JNIEnv::CallAbcMethod()/CallStaticAbcMethod()调用Java对象的方法。Abc是返回值类型，可以是Int/Void/Boolean/Byte/Char/Short/Long/Float/Double/Object，如果确有返回值，在参数中返回。

2.3. c域中创建Java域里的对象

c域中创建Java域里的对象是上节c域访问Java域的方法的特例，创建Java域的对象就是创建Java类的实例，再调用Java类的构造方法。

以Bitmap的构建为例，《Android图像处理之Bitmap类》中提到，Bitmap中并没有Java另外外部能访问的构造方法，所以它的实例化必然是在JNI的c中实现的。

BitmapFactory.java中提供了得到Bitmap的方法，时序简化为：

BitmapFactory.java ->BitmapFactory.cpp -> GraphicsJNI::createBitmap() [graphics.cpp]

GraphicsJNI::createBitmap()[graphics.cpp]的实现：

jobjectGraphicsJNI::createBitmap(JNIEnv* env, SkBitmap* bitmap, bool isMutable,
                                  jbyteArray ninepatch, intdensity)
{
    SkASSERT(bitmap != NULL);
    SkASSERT(NULL != bitmap->pixelRef());

    jobject obj =env->AllocObject(gBitmap_class);
    if (obj) {
        env->CallVoidMethod(obj,gBitmap_constructorMethodID,
                            (jint)bitmap,isMutable, ninepatch, density);
        if (hasException(env)) {
            obj = NULL;
        }
    }
    return obj;
}

而gBitmap_class的得到是通过：

jclass c =env->FindClass("android/graphics/Bitmap");
gBitmap_class =(jclass)env->NewGlobalRef(c);

gBitmap_constructorMethodID是Bitmap的构造方法（方法名用”<init>”）的jmethodID:

gBitmap_constructorMethodID= env->GetMethodID(gBitmap_class, "<init>",
                                           "(IZ[BI)V");

总结一下，c中如何访问Java对象的属性：

1)通过JNIEnv::FindClass()找到对应的jclass；

2)通过JNIEnv::GetMethodID()找到类的构造方法的jfieldID；

3)通过JNIEnv::AllocObject创建该类的对象；

4)通过JNIEnv::CallVoidMethod()调用Java对象的构造方法。

3. c域生成的对象的保存与使用

c域中某次被调用生成的对象，在其他函数调用时是不可见的，虽然可以设置全局变量但那不是好的解决方式，Android中通常是在Java域中定义一个int型的变量，在c域生成对象的地方，与这个Java域的变量关联，在别的使用到的地方，在从这个变量中取值。

以JNICameraContext为例来说明：

JNICameraContext是android_hardware_camera.cpp中定义的类型，并会在cpp中生成对象，与Java中android.hardware.Camera的mNativeContext关联。

在注册native函数之前，c中就已经把Java域中的属性的jfieldID得到了。通过下列方法：

jclass clazz = env->FindClass("android/hardware/Camera ");
jfieldID field = env->GetFieldID(clazz, " mNativeContext","I");

如果执行成功，把field保存到上面图中的fileds变量的context:jfieldID中。

生成cpp对象时，通过JNIEnv::SetIntField()设置为Java对象的属性

static void android_hardware_Camera_native_setup(JNIEnv *env, jobjectthiz,
    jobject weak_this, jintcameraId)
{
    // …

    // We use a weak reference sothe Camera object can be garbage collected.
    // The reference is only used asa proxy for callbacks.
    sp<JNICameraContext>context = new JNICameraContext(env, weak_this, clazz, camera);
    // …
    env->SetIntField(thiz,fields.context, (int)context.get());
}

而要使用时，又通过JNIEnv::GetIntField()获取Java对象的属性，并转化为JNICameraContext类型：

    JNICameraContext* context =reinterpret_cast<JNICameraContext*>(env->GetIntField(thiz, fields.context));
    if (context != NULL) {
        // …
    }

总结一下，c++中生成的对象如何保存和使用：

1) 通过JNIEnv::FindClass()找到对应的jclass；

2) 通过JNIEnv::GetFieldID()找到类中属性的jfieldID；

3) 某个调用过程中，生成cpp对象时，通过JNIEnv::SetIntField()设置为Java对象的属性；

4) 另外的调用过程中，通过JNIEnv::GetIntField()获取Java对象的属性，再转化为真实的对象类型。

4. 总结

本文重点介绍了Android JNI中Java域与c++域之间如何相互操作。Java中调用c++的函数是常见的使用方式，在很多通常的文章中都有介绍，本文并未再详细讲解，而是针对c++域如何访问Java域的情形，结合Camera和Bitmap的实例，进行了详细的阐述。

文中如有错误或疏漏之处，欢迎批评指正！