JNI之数组与字符串的使用

字符串和数组是JNI中常见的引用数据类型，本文将介绍符串和数组在JNI中的常见处理方式。

JNI中字符串的处理

1、Java字符串与原生字符串转换

当从java层传递一个字符串过来之后，它的类型是jstring，同样如果需要返回一个字符串给java层，它的类型也是jstring。jstring代表着Java虚拟机中的一个字符串，并且不同于C++语言的string类型。

如果原生代码需要处理jstring，需要通过JNIEnv将其转换为原生字符串才可以使用。通过JNI函数GetStringUTFChars来读取这个字符串中的内容，GetStringUTFChars函数可以通过JNIEnv接口指针调用，它将一个代表着Java虚拟机中的字符串jstring引用，转换成为一个UTF-8形式的C字符串。

当原生代码使用完了通过GetStringUTFChars获取的原生字符串后应该使用ReleaseStringUTFChars释放它。调用ReleaseStringUTFChars标识着原生代码不再需要使用从GetStringUTFChars获取的UTF-8字符串了，这个UTF-8字符串所占用的空间就可以被释放了。
如果不调用ReleaseStringUTFChars释放原生字符串的话将会导致内存泄露。

我们看下函数GetStringUTFChars的原型是：

const char* GetStringUTFChars(jstring string, jboolean* isCopy)

在这里第三个参数表示如果返回的字符串是原来的java.lang.String的一份拷贝，则在函数GetStringUTFChars返回之后，isCopy指向的内存地址将会被设置为JNI_TRUE。而如果返回的字符串指针直接指向原来的java.lang.String对象，则该地址会被设置为JNI_FALSE.如果返回了JNI_FALSE, 则原生代码将不能改变返回的字符串，因为改变了这个字符串，原来的java字符串也会被修改，这违背了java.lang.String实例不可改变的原则。
通常你可以直接传递NULL给isCopy来告诉Java虚拟机你不在乎返回的字符串是否指向原来Java的String对象。

如果需要将C/C++的字符串返回给Java层，则需要通过函数NewStringUTF生成jstring返回。

例如下面的例子展示了在Native层获取java层字符串，并修改返回给java层的一个例子:

public class MainActivity extends AppCompatActivity {

    static {
        System.loadLibrary("jnitest");
    }
    private ActivityMainBinding binding;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        binding = ActivityMainBinding.inflate(getLayoutInflater());
        setContentView(binding.getRoot());
        TextView tv = binding.sampleText;
        try {
            // 尽量确保传递进去的是utf-8字符串
            tv.setText(sayHello(new String("James".getBytes(),"utf-8")));
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
    }
    public native String sayHello(String name);
}

extern "C"
JNIEXPORT jstring JNICALL
Java_com_fly_jnitest_MainActivity_sayHello(JNIEnv *env, jobject thiz, jstring name) {
    // 将java字符串转换成Native层字符串
    std::string str = "hello ";
    const char *cname = env->GetStringUTFChars(name, nullptr);
    str.append(cname);
    // 释放字符串
    env->ReleaseStringUTFChars(name,cname);
    return env->NewStringUTF(str.c_str());
}

除了上面介绍的GetStringUTFChars, ReleaseStringUTFChars以及NewStringUTF, JNI还提供了
GetStringChars和ReleaseStringChars等相关API处理Unicode格式的字符串。

下表是JNI中常用的一些操作字符串的相关API：

JNI	函数描述
Get/ReleaseStringChars	获取或者释放一个Unicode格式的字符串，可能返回原始字符串的拷贝
Get/ReleaseStringUTFChars	获取或者释放一个UTF-8格式的字符串，可能返回原始字符串的拷贝
GetStringLength	返回Unicode字符串的字符个数
GetStringUTFLength	返回用于表示某个UTF-8字符串所需要的字节个数（不包括结束的0）
NewString	创建一个java.lang.String对象，该对象与指定的Unicode字符串具有相同的字符序列
NewStringUTF	创建一个java.lang.String对象，该对象与指定的UTF-8字符串具有相同的字符序列
Get/ReleaseStringCritical	获取或者释放一个Unicode格式的字符串的内容，可能返回原始字符串的拷贝，在Get/ReleaseStringCritical之间的代码必须不能阻塞
Get/SetStringRegion	将一个字符串拷贝到预先开辟的空间，或者从一个预先开辟的空间复制字符串，字符使用Unicode编码
Get/SetStringUTFRegion	将一个字符串拷贝到预先开辟的空间，或者从一个预先开辟的空间复制字符串，字符使用UTF-8编码

JNI中数组的处理

在JNI中使用jarray以及像jintArray等子类表示数组。正如jstring不是一个C/C++的字符串类型，jarray也不是C/C++的数组类型。如果需要在native处理数组，同样需要通过JNIEnv接口将jarray转换。

例如下面是一个展示了计算一个java数组之和的例子:

extern "C"
JNIEXPORT jint JNICALL
Java_com_fly_jnitest_MainActivity_sum(JNIEnv *env, jobject thiz, jintArray array) {
    jint length = env->GetArrayLength(array);
    jint c_array[length];
    env->GetIntArrayRegion(array,0,length,c_array);
    int sum = 0;
    for (int i = 0; i < length; ++i) {
        sum+= c_array[i];
    }
    return sum;
}

对于上述累计数组和的例子，使用函数GetIntArrayElements获取数组元素实现也是可以的，但是需要注意的是GetIntArrayElements要和ReleaseIntArrayElements配对使用，以免造成内存泄漏。

以下这个例子展示了在JNI函数中排序数组，然后将排序好的数组同步到java层的功能：

extern "C"
JNIEXPORT void JNICALL
Java_com_fly_jnitest_MainActivity_changeArray(JNIEnv *env, jobject thiz, jintArray array) {
    // 方法一
//    jint length = env->GetArrayLength(array);
//    jint c_array[length];
//    env->GetIntArrayRegion(array,0,length,c_array);
//    std::sort(c_array,c_array + length);
//    env->SetIntArrayRegion(array,0,length,c_array); // 数组同步，不然java层的数组不会改变

    // 方法二
    jint length = env->GetArrayLength(array);
    jint *c_array = env->GetIntArrayElements(array, nullptr);
    std::sort(c_array,c_array + length);
    env->SetIntArrayRegion(array,0,length,c_array); // 同步
    env->ReleaseIntArrayElements(array,c_array,0); // 释放
}

在上面的例子中GetIntArrayRegion和GetIntArrayElements都可以获取到数组相关元素，那么他们有什么区别呢？

对于小量的、固定大小的数组，应该选择Get/SetArrayRegion系列函数来操作数组元素是效率最高的。因为这对函数要求提前分配一个C/C++临时缓冲区来存储数组元素，开发者可以直接在栈上或在堆上来动态申请，当然在栈上申请是最快的。有童鞋可能会认为，访问数组元素还需要将原始数据全部拷贝一份到临时缓冲区才能访问而觉得效率低？其实这种复制少量数组元素的代价是很小的，几乎可以忽略。这对函数的另外一个优点就是，允许你传入一个开始索引和长度来实现对子数组元素的访问和操作（SetArrayRegion函数可以修改数组），不过传入的索引和长度不要越界，函数会进行检查，如果越界了会抛出 ArrayIndexOutOfBoundsException 异常。
而Get/ReleaseArrayElements系列函数永远是安全的，JVM会选择性的返回一个指针，这个指针可能指向原始数据，也可能指向原始数据的复制，更加适用于数据量比较大的数组。

下表是JNI中常用的一些操作数组的相关API：

JNI函数	功能描述
Get/SetArrayRegion	复制基础类型数组的内容到C缓冲区或者将C缓冲区的内容设置到基础类型数组中去
Get/ReleaseArrayElements	获取/释放指向基础类型数组内容的指针，可能返回原始数组内容的拷贝
GetArrayLength	返回数组中元素的个数
NewArray	创建指定长度的数组

JNI为访问对象数组单独提供了一组单独的函数GetObjectArrayElement返回指定下表的元素， 而SetObjectArrayElement则修改指定索引上的元素。对于引用类型数组与基础类型数组不同的是，你不能一次获取或者拷贝对象数组中的所有元素，需要使用Get/SetObjectArrayElement来访问引用类型的数组。

推荐阅读

JNI基础简介

关注我，一起进步，人生不止coding！！！