JNI中的陣列分為基本型別陣列和物件陣列,它們的處理方式是不一樣的,基本型別陣列中的所有元素都是JNI的基本資料型別,可以直接訪問。而物件陣列中的所有元素是一個類的例項或其它陣列的引用,和字串操作一樣,不能直接訪問Java傳遞給JNI層的陣列,必須選擇合適的JNI函式來訪問和設定Java層的陣列物件。閱讀此文假設你已經瞭解了JNI與Java資料型別的對映關係,如果還不瞭解的童鞋,請移步《JNI/NDK開發指南(三)——JNI資料型別及與Java資料型別的對映關係》閱讀。下面以int型別為例說明基本資料型別陣列的訪問方式,物件陣列型別用一個建立二維陣列的例子來演示如何訪問:
一、訪問基本型別陣列
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
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"); } } |
原生程式碼:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
/* 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個引數是拷貝目的地。下圖是計算結果:
在前面的例子當中,我們通過呼叫GetIntArrayRegion函式,將int陣列中的所有元素拷貝到C臨時緩衝區中,然後在原生程式碼中訪問緩衝區中的元素來實現求和的計算,JNI還提供了一個和GetIntArrayRegion相對應的函SetIntArrayRegion,原生程式碼可以通過這個函式來修改所有基本資料型別陣列的元素。另外JNI還提供一系列直接獲取陣列元素指標的函式Get/Release<Type>ArrayElements,比如:GetIntArrayElements、ReleaseArrayElements、GetFloatArrayElements、ReleaseFloatArrayElements等。下面我們用這種方式重新實現計算陣列元素的和:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
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函式一樣,返回的是陣列元素的指標。下面用這種方式重新實現上例中的功能:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
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; } |
小結:
1、對於小量的、固定大小的陣列,應該選擇Get/SetArrayRegion函式來運算元組元素是效率最高的。因為這對函式要求提前分配一個C臨時緩衝區來儲存陣列元素,你可以直接在Stack(棧)上或用malloc在堆上來動態申請,當然在棧上申請是最快的。有童鞋可能會認為,訪問陣列元素還需要將原始資料全部拷貝一份到臨時緩衝區才能訪問而覺得效率低?我想告訴你的是,像這種複製少量陣列元素的代價是很小的,幾乎可以忽略。這對函式的另外一個優點就是,允許你傳入一個開始索引和長度來實現對子陣列元素的訪問和操作(SetArrayRegion函式可以修改陣列),不過傳入的索引和長度不要越界,函式會進行檢查,如果越界了會丟擲ArrayIndexOutOfBoundsException異常。
2、如果不想預先分配C緩衝區,並且原始陣列長度也不確定,而原生程式碼又不想在獲取陣列元素指標時被阻塞的話,使用Get/ReleasePrimitiveArrayCritical函式對,就像Get/ReleaseStringCritical函式對一樣,使用這對函式要非常小心,以免死鎖。
3、Get/Release<type>ArrayElements系列函式永遠是安全的,JVM會選擇性的返回一個指標,這個指標可能指向原始資料,也可能指向原始資料的複製。
二、訪問物件陣列
JNI提供了兩個函式來訪問物件陣列,GetObjectArrayElement返回陣列中指定位置的元素,SetObjectArrayElement修改陣列中指定位置的元素。與基本型別不同的是,我們不能一次得到資料中的所有物件元素或者一次複製多個物件元素到緩衝區。因為字串和陣列都是引用型別,只能通過Get/SetObjectArrayElement這樣的JNI函式來訪問字串陣列或者陣列中的陣列元素。下面的例子通過呼叫一個本地方法來建立一個二維的int陣列,然後列印這個二維陣列的內容:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
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"); } } |
原生程式碼:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
/* 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; } |
結果:
本地函式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就會掛掉。
示例程式碼下載地址:https://code.csdn.net/xyang81/jnilearn