JNI 中的數(shù)組分為基本類型數(shù)組和對象數(shù)組，它們的處理方式是不一樣的碟狞，基本類型數(shù)組中的所有元素都是 JNI 的基本數(shù)據(jù)類型胳岂，可以直接訪問高帖。而對象數(shù)組中的所有元素是一個類的實例或其它數(shù)組的引用，和字符串操作一樣锦秒，不能直接訪問 Java 傳遞給 JNI 層的數(shù)組露泊，必須選擇合適的 JNI 函數(shù)來訪問和設(shè)置 Java 層的數(shù)組對象。閱讀此文假設(shè)你已經(jīng)了解了 JNI 與 Java 數(shù)據(jù)類型的映射關(guān)系旅择，如果還不了解的惭笑，請移步《JNI——JNI 數(shù)據(jù)類型與 Java 數(shù)據(jù)類型的映射關(guān)系》閱讀。下面以 int 類型為例說明基本數(shù)據(jù)類型數(shù)組的訪問方式生真，對象數(shù)組類型用一個創(chuàng)建二維數(shù)組的例子來演示如何訪問沉噩。
訪問基本類型數(shù)組
package com.study.jnilearn;
// 訪問基本類型數(shù)組
public class IntArray {
// 在本地代碼中求數(shù)組中所有元素的和
private native int sumArray(int[] arr);
public static void main(String[] args) {
IntArray p = new IntArray();
int[] arr = new int[10];
for (int i = 0; i < arr.length; i++) {
arr[i] = i;
}
int sum = p.sumArray(arr);
System.out.println("sum = " + sum);
}
static {
System.loadLibrary("IntArray");
}
}
本地代碼：
/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class com_study_jnilearn_IntArray */
#ifndef _Included_com_study_jnilearn_IntArray
#define _Included_com_study_jnilearn_IntArray
#ifdef __cplusplus
extern "C" {
#endif
/*
* Class: com_study_jnilearn_IntArray
* Method: sumArray
* Signature: ([I)I
*/
JNIEXPORT jint JNICALL Java_com_study_jnilearn_IntArray_sumArray
(JNIEnv *, jobject, jintArray);
#ifdef __cplusplus
}
#endif
#endif
// IntArray.c
#include "com_study_jnilearn_IntArray.h"
#include <string.h>
#include <stdlib.h>
/*
* Class: com_study_jnilearn_IntArray
* Method: sumArray
* Signature: ([I)I
*/
JNIEXPORT jint JNICALL Java_com_study_jnilearn_IntArray_sumArray
(JNIEnv *env, jobject obj, jintArray j_array)
{
jint i, sum = 0;
jint *c_array;
jint arr_len;
//1. 獲取數(shù)組長度
arr_len = (*env)->GetArrayLength(env,j_array);
//2. 根據(jù)數(shù)組長度和數(shù)組元素的數(shù)據(jù)類型申請存放java數(shù)組元素的緩沖區(qū)
c_array = (jint*)malloc(sizeof(jint) * arr_len);
//3. 初始化緩沖區(qū)
memset(c_array,0,sizeof(jint)*arr_len);
printf("arr_len = %d ", arr_len);
//4. 拷貝Java數(shù)組中的所有元素到緩沖區(qū)中
(*env)->GetIntArrayRegion(env,j_array,0,arr_len,c_array);
for (i = 0; i < arr_len; i++) {
sum += c_array[i]; //5. 累加數(shù)組元素的和
}
free(c_array); //6. 釋放存儲數(shù)組元素的緩沖區(qū)
return sum;
}
上例中，在 Java 中定義了一個 sumArray 的 native 方法柱蟀，參數(shù)類型是 int[]川蒙，對應(yīng) JNI 中 jintArray 類型。在本地代碼中长已，首先通過 JNI的GetArrayLength 函數(shù)獲取數(shù)組的長度畜眨，已知數(shù)組是 jintArray 類型，可以得出數(shù)組的元素類型是 jint术瓮，然后根據(jù)數(shù)組的長度和數(shù)組元素類型胶果，申請相應(yīng)大小的緩沖區(qū)。如果緩沖區(qū)不大的話斤斧，當然也可以直接在棧上申請內(nèi)存早抠，那樣效率更高，但是沒那么靈活撬讽，因為 Java 數(shù)組的大小變了蕊连，本地代碼也跟著修改悬垃。接著調(diào)用 GetIntArrayRegion 函數(shù)將 Java 數(shù)組中的所有元素拷貝到 C 緩沖區(qū)中，并累加數(shù)組中所有元素的和甘苍，最后釋放存儲 java 數(shù)組元素的 C 緩沖區(qū)尝蠕，并返回計算結(jié)果。GetIntArrayRegion 函數(shù)第 1 個參數(shù)是 JNIEnv 函數(shù)指針载庭，第 2 個參數(shù)是 Java 數(shù)組對象看彼，第 3 個參數(shù)是拷貝數(shù)組的開始索引，第 4 個參數(shù)是拷貝數(shù)組的長度囚聚，第 5 個參數(shù)是拷貝目的地靖榕。下圖是計算結(jié)果：
sun=45
arr_len=10
在前面的例子當中，我們通過調(diào)用 GetIntArrayRegion 函數(shù)顽铸，將 int 數(shù)組中的所有元素拷貝到 C 臨時緩沖區(qū)中茁计，然后在本地代碼中訪問緩沖區(qū)中的元素來實現(xiàn)求和的計算，JNI 還提供了一個和 GetIntArrayRegion 相對應(yīng)的函 SetIntArrayRegion谓松，本地代碼可以通過這個函數(shù)來修改所有基本數(shù)據(jù)類型數(shù)組的元素星压。另外 JNI 還提供一系列直接獲取數(shù)組元素指針的函數(shù) Get/ReleaseArrayElements，比如：GetIntArrayElements鬼譬、ReleaseArrayElements娜膘、GetFloatArrayElements、ReleaseFloatArrayElements 等优质。下面我們用這種方式重新實現(xiàn)計算數(shù)組元素的和：
JNIEXPORT jint JNICALL Java_com_study_jnilearn_IntArray_sumArray2
(JNIEnv *env, jobject obj, jintArray j_array)
{
jint i, sum = 0;
jint *c_array;
jint arr_len;
// 可能數(shù)組中的元素在內(nèi)存中是不連續(xù)的竣贪，JVM可能會復制所有原始數(shù)據(jù)到緩沖區(qū)，然后返回這個緩沖區(qū)的指針
c_array = (*env)->GetIntArrayElements(env,j_array,NULL);
if (c_array == NULL) {
return 0; // JVM復制原始數(shù)據(jù)到緩沖區(qū)失敗
}
arr_len = (*env)->GetArrayLength(env,j_array);
printf("arr_len = %d\n", arr_len);
for (i = 0; i < arr_len; i++) {
sum += c_array[i];
}
(*env)->ReleaseIntArrayElements(env,j_array, c_array, 0); // 釋放可能復制的緩沖區(qū)
return sum;
}
GetIntArrayElements 第三個參數(shù)表示返回的數(shù)組指針是原始數(shù)組盆赤，還是拷貝原始數(shù)據(jù)到臨時緩沖區(qū)的指針贾富，如果是 JNI_TRUE：表示臨時緩沖區(qū)數(shù)組指針，JNI_FALSE：表示臨時原始數(shù)組指針牺六。開發(fā)當中颤枪，我們并不關(guān)心它從哪里返回的數(shù)組指針，這個參數(shù)填 NULL 即可淑际，但在獲取到的指針必須做校驗畏纲，因為當原始數(shù)據(jù)在內(nèi)存當中不是連續(xù)存放的情況下，JVM 會復制所有原始數(shù)據(jù)到一個臨時緩沖區(qū)春缕，并返回這個臨時緩沖區(qū)的指針盗胀。有可能在申請開辟臨時緩沖區(qū)內(nèi)存空間時，會內(nèi)存不足導致申請失敗锄贼，這時會返回 NULL票灰。
寫過 Java 的程序員都知道，在 Java 中創(chuàng)建的對象全都由 GC（垃圾回收器）自動回收，不需要像 C/C++ 一樣需要程序員自己管理內(nèi)存屑迂。GC 會實時掃描所有創(chuàng)建的對象是否還有引用浸策，如果沒有引用則會立即清理掉。當我們創(chuàng)建一個像 int 數(shù)組對象的時候惹盼，當我們在本地代碼想去訪問時庸汗，發(fā)現(xiàn)這個對象正被 GC 線程占用了，這時本地代碼會一直處于阻塞狀態(tài)手报，直到等待 GC 釋放這個對象的鎖之后才能繼續(xù)訪問蚯舱。為了避免這種現(xiàn)象的發(fā)生，JNI 提供了 Get/ReleasePrimitiveArrayCritical 這對函數(shù)掩蛤，本地代碼在訪問數(shù)組對象時會暫停 GC 線程枉昏。不過使用這對函數(shù)也有個限制，在 Get/ReleasePrimitiveArrayCritical 這兩個函數(shù)期間不能調(diào)用任何會讓線程阻塞或等待 JVM 中其它線程的本地函數(shù)或JNI函數(shù)盏档，和處理字符串的 Get/ReleaseStringCritical 函數(shù)限制一樣凶掰。這對函數(shù)和 GetIntArrayElements 函數(shù)一樣燥爷，返回的是數(shù)組元素的指針蜈亩。下面用這種方式重新實現(xiàn)上例中的功能：
JNIEXPORT jint JNICALL Java_com_study_jnilearn_IntArray_sumArray
(JNIEnv *env, jobject obj, jintArray j_array)
{
jint i, sum = 0;
jint *c_array;
jint arr_len;
jboolean isCopy;
c_array = (*env)->GetPrimitiveArrayCritical(env,j_array,&isCopy);
printf("isCopy: %d \n", isCopy);
if (c_array == NULL) {
return 0;
}
arr_len = (*env)->GetArrayLength(env,j_array);
printf("arr_len = %d\n", arr_len);
for (i = 0; i < arr_len; i++) {
sum += c_array[i];
}
(*env)->ReleasePrimitiveArrayCritical(env, j_array, c_array, 0);
return sum;
}
小結(jié)
對于小量的、固定大小的數(shù)組前翎，應(yīng)該選擇 Get/SetArrayRegion 函數(shù)來操作數(shù)組元素是效率最高的稚配。因為這對函數(shù)要求提前分配一個 C 臨時緩沖區(qū)來存儲數(shù)組元素，你可以直接在 Stack（棧）上或用 malloc 在堆上來動態(tài)申請港华，當然在棧上申請是最快的道川。有童鞋可能會認為，訪問數(shù)組元素還需要將原始數(shù)據(jù)全部拷貝一份到臨時緩沖區(qū)才能訪問而覺得效率低立宜？我想告訴你的是冒萄，像這種復制少量數(shù)組元素的代價是很小的，幾乎可以忽略橙数。這對函數(shù)的另外一個優(yōu)點就是尊流，允許你傳入一個開始索引和長度來實現(xiàn)對子數(shù)組元素的訪問和操作（SetArrayRegion函數(shù)可以修改數(shù)組），不過傳入的索引和長度不要越界灯帮，函數(shù)會進行檢查崖技，如果越界了會拋出 ArrayIndexOutOfBoundsException 異常。
如果不想預先分配 C 緩沖區(qū)钟哥，并且原始數(shù)組長度也不確定迎献，而本地代碼又不想在獲取數(shù)組元素指針時被阻塞的話，使用 Get/ReleasePrimitiveArrayCritical 函數(shù)對腻贰，就像 Get/ReleaseStringCritical 函數(shù)對一樣吁恍，使用這對函數(shù)要非常小心，以免死鎖。
Get/ReleaseArrayElements 系列函數(shù)永遠是安全的冀瓦，JVM 會選擇性的返回一個指針鸦采，這個指針可能指向原始數(shù)據(jù)，也可能指向原始數(shù)據(jù)的復制咕幻。
訪問對象數(shù)組
JNI 提供了兩個函數(shù)來訪問對象數(shù)組渔伯，GetObjectArrayElement 返回數(shù)組中指定位置的元素，SetObjectArrayElement 修改數(shù)組中指定位置的元素肄程。與基本類型不同的是锣吼，我們不能一次得到數(shù)據(jù)中的所有對象元素或者一次復制多個對象元素到緩沖區(qū)。因為字符串和數(shù)組都是引用類型蓝厌，只能通過 Get/SetObjectArrayElement 這樣的 JNI 函數(shù)來訪問字符串數(shù)組或者數(shù)組中的數(shù)組元素玄叠。下面的例子通過調(diào)用一個本地方法來創(chuàng)建一個二維的 int 數(shù)組，然后打印這個二維數(shù)組的內(nèi)容：
package com.study.jnilearn;
public class ObjectArray {
private native int[][] initInt2DArray(int size);
public static void main(String[] args) {
ObjectArray obj = new ObjectArray();
int[][] arr = obj.initInt2DArray(3);
for (int i = 0; i < 3; i++) {
for (int j = 0; j < 3; j++) {
System.out.format("arr[%d][%d] = %d\n", i, j, arr[i][j]);
}
}
}
static {
System.loadLibrary("ObjectArray");
}
}
本地代碼：
/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class com_study_jnilearn_ObjectArray */
#ifndef _Included_com_study_jnilearn_ObjectArray
#define _Included_com_study_jnilearn_ObjectArray
#ifdef __cplusplus
extern "C" {
#endif
/*
* Class: com_study_jnilearn_ObjectArray
* Method: initInt2DArray
* Signature: (I)[[I
*/
JNIEXPORT jobjectArray JNICALL Java_com_study_jnilearn_ObjectArray_initInt2DArray
(JNIEnv *, jobject, jint);
#ifdef __cplusplus
}
#endif
#endif
// ObjectArray.c
#include "com_study_jnilearn_ObjectArray.h"
/*
* Class: com_study_jnilearn_ObjectArray
* Method: initInt2DArray
* Signature: (I)[[I
*/
JNIEXPORT jobjectArray JNICALL Java_com_study_jnilearn_ObjectArray_initInt2DArray
(JNIEnv *env, jobject obj, jint size)
{
jobjectArray result;
jclass clsIntArray;
jint i,j;
// 1.獲得一個int型二維數(shù)組類的引用
clsIntArray = (*env)->FindClass(env,"[I");
if (clsIntArray == NULL)
{
return NULL;
}
// 2.創(chuàng)建一個數(shù)組對象（里面每個元素用clsIntArray表示）
result = (*env)->NewObjectArray(env,size,clsIntArray,NULL);
if (result == NULL)
{
return NULL;
}
// 3.為數(shù)組元素賦值
for (i = 0; i < size; ++i)
{
jint buff[256];
jintArray intArr = (*env)->NewIntArray(env,size);
if (intArr == NULL)
{
return NULL;
}
for (j = 0; j < size; j++)
{
buff[j] = i + j;
}
(*env)->SetIntArrayRegion(env,intArr, 0,size,buff);
(*env)->SetObjectArrayElement(env,result, i, intArr);
(*env)->DeleteLocalRef(env,intArr);
}
return result;
}
結(jié)果：
arr[0][0]=0
arr[0][1]=1
arr[0][2]=2
arr[0][0]=1
arr[0][1]=2
arr[0][2]=3
arr[0][0]=2
arr[0][1]=3
arr[0][2]=4
本地函數(shù) initInt2DArray 首先調(diào)用 JNI 函數(shù) FindClass 獲得一個 int 型的二維數(shù)組類的引用拓提，傳遞給FindClass 的參數(shù)"[I"是 JNI class descript（JNI 類型描述符读恃，后面為詳細介紹），它對應(yīng)著 JVM 中的int[]類型代态。如果 int[]類加載失敗的話寺惫，F(xiàn)indClass 會返回 NULL，然后拋出一個java.lang.NoClassDefFoundError: [I異常蹦疑。
接下來西雀，NewObjectArray 創(chuàng)建一個新的數(shù)組，這個數(shù)組里面的元素類型用 intArrCls(int[])類型來表示歉摧。函數(shù)NewObjectArray 只能分配第一維艇肴，JVM 沒有與多維數(shù)組相對應(yīng)的數(shù)據(jù)結(jié)構(gòu)，JNI 也沒有提供類似的函數(shù)來創(chuàng)建二維數(shù)組叁温。由于 JNI 中的二維數(shù)組直接操作的是 JVM 中的數(shù)據(jù)結(jié)構(gòu)再悼，相比 JAVA 和 C/C++創(chuàng)建二維數(shù)組要復雜很多。給二維數(shù)組設(shè)置數(shù)據(jù)的方式也非常直接膝但，首先用 NewIntArray 創(chuàng)建一個 JNI 的 int 數(shù)組冲九，并為每個數(shù)組元素分配空間，然后用 SetIntArrayRegion 把 buff[]緩沖中的內(nèi)容復制到新分配的一維數(shù)組中去锰镀，最后在外層循環(huán)中依次將 int[]數(shù)組賦值到 jobjectArray 數(shù)組中娘侍，一維數(shù)組中套一維數(shù)組，就形成了一個所謂的二維數(shù)組泳炉。
另外憾筏，為了避免在循環(huán)內(nèi)創(chuàng)建大量的 JNI 局部引用，造成 JNI 引用表溢出花鹅，所以在外層循環(huán)中每次都要調(diào)用DeleteLocalRef 將新創(chuàng)建的 jintArray 引用從引用表中移除氧腰。在 JNI 中，只有 jobject 以及子類屬于引用變量，會占用引用表的空間古拴，jint箩帚，jfloat，jboolean 等都是基本類型變量黄痪，不會占用引用表空間紧帕，即不需要釋放。引用表最大空間為 512 個桅打，如果超出這個范圍是嗜，JVM 就會掛掉。
NdkDemo代碼已上傳至Github
