JNI 中的數組分為基本類型數組和對象數組，它們的處理方式是不一樣的，基本類型數組中的所有元素都是 JNI 的基本數據類型，可以直接訪問。而對象數組中的所有元素是一個類的實例或其它數組的引用，和字符串操作一樣，不能直接訪問 Java 傳遞給 JNI 層的數組，必須選擇合適的 JNI 函數來訪問和設置 Java 層的數組對象。閱讀此文假設你已經了解了 JNI 與 Java 數據類型的映射關系，如果還不了解的，請移步《JNI——JNI 數據類型與 Java 數據類型的映射關系》閱讀。下面以 int 類型為例說明基本數據類型數組的訪問方式，對象數組類型用一個創建二維數組的例子來演示如何訪問。
訪問基本類型數組
package com.study.jnilearn;
// 訪問基本類型數組
public class IntArray {
// 在本地代碼中求數組中所有元素的和
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. 獲取數組長度
arr_len = (*env)->GetArrayLength(env,j_array);
//2. 根據數組長度和數組元素的數據類型申請存放java數組元素的緩沖區
c_array = (jint*)malloc(sizeof(jint) * arr_len);
//3. 初始化緩沖區
memset(c_array,0,sizeof(jint)*arr_len);
printf("arr_len = %d ", arr_len);
//4. 拷貝Java數組中的所有元素到緩沖區中
(*env)->GetIntArrayRegion(env,j_array,0,arr_len,c_array);
for (i = 0; i < arr_len; i++) {
sum += c_array[i]; //5. 累加數組元素的和
}
free(c_array); //6. 釋放存儲數組元素的緩沖區
return sum;
}
上例中，在 Java 中定義了一個 sumArray 的 native 方法，參數類型是 int[]，對應 JNI 中 jintArray 類型。在本地代碼中，首先通過 JNI的GetArrayLength 函數獲取數組的長度，已知數組是 jintArray 類型，可以得出數組的元素類型是 jint，然后根據數組的長度和數組元素類型，申請相應大小的緩沖區。如果緩沖區不大的話，當然也可以直接在棧上申請內存，那樣效率更高，但是沒那么靈活，因為 Java 數組的大小變了，本地代碼也跟著修改。接著調用 GetIntArrayRegion 函數將 Java 數組中的所有元素拷貝到 C 緩沖區中，并累加數組中所有元素的和，最后釋放存儲 java 數組元素的 C 緩沖區，并返回計算結果。GetIntArrayRegion 函數第 1 個參數是 JNIEnv 函數指針，第 2 個參數是 Java 數組對象，第 3 個參數是拷貝數組的開始索引，第 4 個參數是拷貝數組的長度，第 5 個參數是拷貝目的地。下圖是計算結果：
sun=45
arr_len=10
在前面的例子當中，我們通過調用 GetIntArrayRegion 函數，將 int 數組中的所有元素拷貝到 C 臨時緩沖區中，然后在本地代碼中訪問緩沖區中的元素來實現求和的計算，JNI 還提供了一個和 GetIntArrayRegion 相對應的函 SetIntArrayRegion，本地代碼可以通過這個函數來修改所有基本數據類型數組的元素。另外 JNI 還提供一系列直接獲取數組元素指針的函數 Get/ReleaseArrayElements，比如：GetIntArrayElements、ReleaseArrayElements、GetFloatArrayElements、ReleaseFloatArrayElements 等。下面我們用這種方式重新實現計算數組元素的和：
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;
// 可能數組中的元素在內存中是不連續的，JVM可能會復制所有原始數據到緩沖區，然后返回這個緩沖區的指針
c_array = (*env)->GetIntArrayElements(env,j_array,NULL);
if (c_array == NULL) {
return 0; // JVM復制原始數據到緩沖區失敗
}
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); // 釋放可能復制的緩沖區
return sum;
}
GetIntArrayElements 第三個參數表示返回的數組指針是原始數組，還是拷貝原始數據到臨時緩沖區的指針，如果是 JNI_TRUE：表示臨時緩沖區數組指針，JNI_FALSE：表示臨時原始數組指針。開發當中，我們并不關心它從哪里返回的數組指針，這個參數填 NULL 即可，但在獲取到的指針必須做校驗，因為當原始數據在內存當中不是連續存放的情況下，JVM 會復制所有原始數據到一個臨時緩沖區，并返回這個臨時緩沖區的指針。有可能在申請開辟臨時緩沖區內存空間時，會內存不足導致申請失敗，這時會返回 NULL。
寫過 Java 的程序員都知道，在 Java 中創建的對象全都由 GC（垃圾回收器）自動回收，不需要像 C/C++ 一樣需要程序員自己管理內存。GC 會實時掃描所有創建的對象是否還有引用，如果沒有引用則會立即清理掉。當我們創建一個像 int 數組對象的時候，當我們在本地代碼想去訪問時，發現這個對象正被 GC 線程占用了，這時本地代碼會一直處于阻塞狀態，直到等待 GC 釋放這個對象的鎖之后才能繼續訪問。為了避免這種現象的發生，JNI 提供了 Get/ReleasePrimitiveArrayCritical 這對函數，本地代碼在訪問數組對象時會暫停 GC 線程。不過使用這對函數也有個限制，在 Get/ReleasePrimitiveArrayCritical 這兩個函數期間不能調用任何會讓線程阻塞或等待 JVM 中其它線程的本地函數或JNI函數，和處理字符串的 Get/ReleaseStringCritical 函數限制一樣。這對函數和 GetIntArrayElements 函數一樣，返回的是數組元素的指針。下面用這種方式重新實現上例中的功能：
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;
}
小結
對于小量的、固定大小的數組，應該選擇 Get/SetArrayRegion 函數來操作數組元素是效率最高的。因為這對函數要求提前分配一個 C 臨時緩沖區來存儲數組元素，你可以直接在 Stack（棧）上或用 malloc 在堆上來動態申請，當然在棧上申請是最快的。有童鞋可能會認為，訪問數組元素還需要將原始數據全部拷貝一份到臨時緩沖區才能訪問而覺得效率低？我想告訴你的是，像這種復制少量數組元素的代價是很小的，幾乎可以忽略。這對函數的另外一個優點就是，允許你傳入一個開始索引和長度來實現對子數組元素的訪問和操作（SetArrayRegion函數可以修改數組），不過傳入的索引和長度不要越界，函數會進行檢查，如果越界了會拋出 ArrayIndexOutOfBoundsException 異常。
如果不想預先分配 C 緩沖區，并且原始數組長度也不確定，而本地代碼又不想在獲取數組元素指針時被阻塞的話，使用 Get/ReleasePrimitiveArrayCritical 函數對，就像 Get/ReleaseStringCritical 函數對一樣，使用這對函數要非常小心，以免死鎖。
Get/ReleaseArrayElements 系列函數永遠是安全的，JVM 會選擇性的返回一個指針，這個指針可能指向原始數據，也可能指向原始數據的復制。
訪問對象數組
JNI 提供了兩個函數來訪問對象數組，GetObjectArrayElement 返回數組中指定位置的元素，SetObjectArrayElement 修改數組中指定位置的元素。與基本類型不同的是，我們不能一次得到數據中的所有對象元素或者一次復制多個對象元素到緩沖區。因為字符串和數組都是引用類型，只能通過 Get/SetObjectArrayElement 這樣的 JNI 函數來訪問字符串數組或者數組中的數組元素。下面的例子通過調用一個本地方法來創建一個二維的 int 數組，然后打印這個二維數組的內容：
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型二維數組類的引用
clsIntArray = (*env)->FindClass(env,"[I");
if (clsIntArray == NULL)
{
return NULL;
}
// 2.創建一個數組對象（里面每個元素用clsIntArray表示）
result = (*env)->NewObjectArray(env,size,clsIntArray,NULL);
if (result == NULL)
{
return NULL;
}
// 3.為數組元素賦值
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;
}
結果：
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
本地函數 initInt2DArray 首先調用 JNI 函數 FindClass 獲得一個 int 型的二維數組類的引用，傳遞給FindClass 的參數"[I"是 JNI class descript（JNI 類型描述符，后面為詳細介紹），它對應著 JVM 中的int[]類型。如果 int[]類加載失敗的話，FindClass 會返回 NULL，然后拋出一個java.lang.NoClassDefFoundError: [I異常。
接下來，NewObjectArray 創建一個新的數組，這個數組里面的元素類型用 intArrCls(int[])類型來表示。函數NewObjectArray 只能分配第一維，JVM 沒有與多維數組相對應的數據結構，JNI 也沒有提供類似的函數來創建二維數組。由于 JNI 中的二維數組直接操作的是 JVM 中的數據結構，相比 JAVA 和 C/C++創建二維數組要復雜很多。給二維數組設置數據的方式也非常直接，首先用 NewIntArray 創建一個 JNI 的 int 數組，并為每個數組元素分配空間，然后用 SetIntArrayRegion 把 buff[]緩沖中的內容復制到新分配的一維數組中去，最后在外層循環中依次將 int[]數組賦值到 jobjectArray 數組中，一維數組中套一維數組，就形成了一個所謂的二維數組。
另外，為了避免在循環內創建大量的 JNI 局部引用，造成 JNI 引用表溢出，所以在外層循環中每次都要調用DeleteLocalRef 將新創建的 jintArray 引用從引用表中移除。在 JNI 中，只有 jobject 以及子類屬于引用變量，會占用引用表的空間，jint，jfloat，jboolean 等都是基本類型變量，不會占用引用表空間，即不需要釋放。引用表最大空間為 512 個，如果超出這個范圍，JVM 就會掛掉。
NdkDemo代碼已上傳至Github
