乐趣区

关于android: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 还提供了
GetStringCharsReleaseStringChars等相干 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); // 开释
}

在下面的例子中 GetIntArrayRegionGetIntArrayElements都能够获取到数组相干元素,那么他们有什么区别呢?

对于小量的、固定大小的数组,应该抉择 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!!!

退出移动版