JNI引用类型数组操作

上篇文章JNI基本类型数组操作讲述了如何在JNI层操作基本类型的数组，本片文章承继上篇文章来讲解如何在JNI层操作引用类型的数组。不过在阅读本篇文章前，你可能需要先理解JNI访问Java对象的成员和JNI访问Java类的静态成员这两篇文章所讲，否则你看本文会有点吃力。

准备工作

在讲解之前呢，需要做一些准备工作。

首先需要一个Java引用类型的类Person.java，这个类将被用作创建数组

package com.uni.ndkdemo;

public class Person {
    private String mName;

    public Person(String name) {
        mName = name;
    }

    public void sayHello() {
        System.out.println("Hello, " + mName + "!");
    }
}
复制代码

然后得准备一个native入口的类

package com.uni.ndkdemo;

public class ArrayTest {
    static {
        System.loadLibrary("array_jni");
    }
    
    public native void sayHello(Person[] persons);
    
    public static void main(String[] args) {
        ArrayTest arrayTest = new ArrayTest();
        Person persons[] = new Person[2];
        persons[0] = new Person("Jay Chow");
        persons[1] = new Person("Stephen Chow");
        arrayTest.sayHello(persons);
    }
}
复制代码

ArrayTest.java的main()方法中创建一个了Person数组，并给每个元素赋值，然后调用了sayHello()这个native方法把这Person数组传入JNI层。

最后，需要在JNI层实现对应的函数，假设这个函数如下

static void com_uni_ndkdemo_ArrayTest_sayHello(JNIEnv *env, jobject thiz, jobjectArray objectArray)
{
 
}
复制代码

我将在这个函数中来讲解JNI如何操作引用类型数组。

GetObjectArrayElement

jobject GetObjectArrayElement(JNIEnv *env, jobjectArray array, jsize index);
复制代码

GetObjectArrayElement 函数获取数组array在索引index下的元素。

注意，这个函数只能用于获取引用类型数组的元素，对于如何获取基本类型数组的元素，请参考JNI基本类型数组操作。

IsInstanceOf

jboolean IsInstanceOf(JNIEnv *env, jobject obj, jclass clazz);
复制代码

IsInstanceOf函数用于判断对象obj是否是clazz类的实例对象。

可以利用这个函数来判断数组元素的类型，这样就可以避免调用了错的方法。

扫描二维码关注公众号，回复： 6809542 查看本文章

实战

static void com_uni_ndkdemo_ArrayTest_sayHello(JNIEnv *env, jobject thiz, jobjectArray objectArray)
{
    // 1. 获取数组的长度
    jsize length = env->GetArrayLength(objectArray);
    
    // 2. 获取Person类的Class对象
    jclass clazz_Person = env->FindClass("com/uni/ndkdemo/Person");
    if (clazz_Person == NULL)
    {
        return;
    }
    
    // 3. 获取Person的sayHello方法字段
    jmethodID methodID_sayHello = env->GetMethodID(clazz_Person, "sayHello", "()V");
    if (methodID_sayHello == NULL)
    {
        return;
    }
    
    // 4. 循环调用每个Person对象的sayHello()方法
    for (int i = 0; i < length; i++)
    {
        // 获取引用类型数组的对象
        jobject element = env->GetObjectArrayElement(objectArray, i);
        // 判断数组元素是否是Person类对象
        if (env->IsInstanceOf(element, clazz_Person))
        {
            // 调用Person对象的sayHello()方法
            env->CallVoidMethod(element, methodID_sayHello);
        }
    }
}
复制代码

首先通过第二步和第三步来获取Person类的sayHello()方法的jmethodID，然后调用GetObjectArrayElement来获取数组的元素，最后通过IsInstanceOf判断数组元素是Person类对象后，就调用了它的sayHello方法。

NewObjectArray

前面所讲的都是处理从Java层传入JNI层的引用类型数组，当然，也可以在JNI层创建引用类型数组，并返回给Java层，这就要用到NewObjectArray函数

jobjectArray NewObjectArray(JNIEnv *env, jsize length,
                        jclass elementClass, jobject initialElement);
复制代码

NewObjectArray会根据参数elementClass的类型，创建一个长度为length的数组。

如果你指定了第四个参数initialElement，那么将会用第四个参数初始化数组的所有元素。如果指定initialElement为NULL，那么数组所有元素为NULL。

SetObjectArrayElement

void SetObjectArrayElement(JNIEnv *env, jobjectArray array, 
                        jsize index, jobject value);
复制代码

SetObjectArrayElement函数是为数组array，设置索引index下的元素的值value。

NewObjectArray可以在创建数组的时候，用参数jobject initialElement给数组每个元素赋初值。SetObjectArrayElement函数可以用参数jobject value给数组元素设置值。那么问题来了，这个用于赋值的对象如何创建呢？可以使用 NewObject 或 NewObjectA 或 NewObjectV。

NewObject & NewObjectA & NewObjectV

jobject NewObject(JNIEnv *env, jclass clazz,
                jmethodID methodID, ...);

jobject NewObjectA(JNIEnv *env, jclass clazz,
                jmethodID methodID, const jvalue *args);

jobject NewObjectV(JNIEnv *env, jclass clazz,
                jmethodID methodID, va_list args);
复制代码

这三个函数的区别在于传入参数的形式不一样而已。

参数clazz代表Java类的Class对象，可以通过FindClass函数来获取。

参数methodID代表Java类的构造函数，需要通过GetMethodID来获取，不过调用GetMethodID函数时，传入的函数名参数一定要为<init>，而且传入函数签名参数的返回值一定要为V。这个可能说的有点抽象，不过可以从后面的例子中看出如何使用。

例子

现在需要先准备一个Java的native方法，返回一个Person数组public class ArrayTest { static { System.loadLibrary("array_jni"); }

public native long native_sum(int[] a);

public native int[] getNativeArray();

public native void sayHello(Person[] persons);

public native void handleArray(int[] a);

public native void nativeSayHello(int length);

public native Person[] getNativePersons(int length);
复制代码

}

public class ArrayTest {
    static {
        System.loadLibrary("array_jni");
    }
    
    public native Person[] getNativePersons(int length);
    
    public static void main(String[] args) {
        for (int i = 0; i < nativePersons.length; i++) {
            nativePersons[i].sayHello();
        }
    }

}
复制代码

然后到JNI层去实现

static const int NAME_SIZE = 2;
static const char *names[NAME_SIZE] = {"周星驰", "周杰伦"};

static jobjectArray getPersons(JNIEnv *env, jobject thiz, jint length)
{
    // 1. 找到Person类的Class对象
    jclass clazz_Person = env->FindClass("com/uni/ndkdemo/Person");
    if (clazz_Person == NULL)
    {
        return NULL;
    }

    // 2. 找到Person类的构造函数的jmethodID
    // 注意，这里找的是带有String参数的构造函数
    jmethodID methodId_Person_constructor = env->GetMethodID(clazz_Person, "<init>", "(Ljava/lang/String;)V");
    if (methodId_Person_constructor == NULL)
    {
        return NULL;
    }

    // 3. 创建一个Person数组，每个元素为NULL
    jobjectArray array = env->NewObjectArray(length, clazz_Person, NULL);
    for (int i = 0; i < length; i++)
    {
        const char * name = names[i % NAME_SIZE];
        // 4. 创建Person对象
        jobject person = env->NewObject(clazz_Person, methodId_Person_constructor, env->NewStringUTF(name));
        // 5. 给数组元素设置值 
        env->SetObjectArrayElement(array, i, person);
    }
    return array;
}
复制代码

第一步，要找到Person类，因为要利用它来创建Person数组。

第二步，要找到Person类的Person(String name)构造函数。注意，调用GetMethodID是，构造函数名参数为<init>，构造函数签名参数为(Ljava/lang/String;)V。很明显获取的是带String参数的构造函数。

第三步，创建Person数组，由于调用NewObjectArray函数时第三个参数为NULL，那么数组中每个元素的值为NULL。

第四步，调用NewObject函数，使用Person(String name)构造函数来创建一个对象。

第五步，调用SetObjectArrayElement函数来给数组的元素赋值。

这五步看似简单，但是需要有相应的JNI功底，如果你看完了我前面所有文章，那么这里就非常简单了。

结束

JNI处理引用类型的数组要比处理基本类型数组要复杂得多，因为要涉及到很多的方方面面，但是这些方方面面都在前面的文章中讲过。所有，如果你看这篇文章有困惑，不妨去前面的文章中寻找答案。

Java的String类也是一个引用类型，但是这个引用类型是用数组实现的，因此比较特殊。在下一篇文章中，我将会来讲解JNI如何来操作字符串的。