JNI 訪問數(shù)組

JNI 中的數(shù)組分為基本類型數(shù)組和對(duì)象數(shù)組,它們的處理方式是不一樣的,基本類型數(shù)組中的所有元素都是 JNI 的基本數(shù)據(jù)類型,可以直接訪問。而對(duì)象數(shù)組中的所有元素是一個(gè)類的實(shí)例或其它數(shù)組的引用,和字符串操作一樣,不能直接訪問 Java 傳遞給 JNI 層的數(shù)組,必須選擇合適的 JNI 函數(shù)來訪問和設(shè)置 Java 層的數(shù)組對(duì)象。閱讀此文假設(shè)你已經(jīng)了解了 JNI 與 Java 數(shù)據(jù)類型的映射關(guān)系,如果還不了解的,請(qǐng)移步《JNI——JNI 數(shù)據(jù)類型與 Java 數(shù)據(jù)類型的映射關(guān)系》閱讀。下面以 int 類型為例說明基本數(shù)據(jù)類型數(shù)組的訪問方式,對(duì)象數(shù)組類型用一個(gè)創(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ù)組長(zhǎng)度  
    arr_len = (*env)->GetArrayLength(env,j_array);  
    //2. 根據(jù)數(shù)組長(zhǎng)度和數(shù)組元素的數(shù)據(jù)類型申請(qǐng)存放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. 釋放存儲(chǔ)數(shù)組元素的緩沖區(qū)  
    return sum;  
}  

上例中,在 Java 中定義了一個(gè) sumArray 的 native 方法,參數(shù)類型是 int[],對(duì)應(yīng) JNI 中 jintArray 類型。在本地代碼中,首先通過 JNI的GetArrayLength 函數(shù)獲取數(shù)組的長(zhǎng)度,已知數(shù)組是 jintArray 類型,可以得出數(shù)組的元素類型是 jint,然后根據(jù)數(shù)組的長(zhǎng)度和數(shù)組元素類型,申請(qǐng)相應(yīng)大小的緩沖區(qū)。如果緩沖區(qū)不大的話,當(dāng)然也可以直接在棧上申請(qǐng)內(nèi)存,那樣效率更高,但是沒那么靈活,因?yàn)?Java 數(shù)組的大小變了,本地代碼也跟著修改。接著調(diào)用 GetIntArrayRegion 函數(shù)將 Java 數(shù)組中的所有元素拷貝到 C 緩沖區(qū)中,并累加數(shù)組中所有元素的和,最后釋放存儲(chǔ) java 數(shù)組元素的 C 緩沖區(qū),并返回計(jì)算結(jié)果。GetIntArrayRegion 函數(shù)第 1 個(gè)參數(shù)是 JNIEnv 函數(shù)指針,第 2 個(gè)參數(shù)是 Java 數(shù)組對(duì)象,第 3 個(gè)參數(shù)是拷貝數(shù)組的開始索引,第 4 個(gè)參數(shù)是拷貝數(shù)組的長(zhǎng)度,第 5 個(gè)參數(shù)是拷貝目的地。下圖是計(jì)算結(jié)果:

sun=45

arr_len=10

在前面的例子當(dāng)中,我們通過調(diào)用 GetIntArrayRegion 函數(shù),將 int 數(shù)組中的所有元素拷貝到 C 臨時(shí)緩沖區(qū)中,然后在本地代碼中訪問緩沖區(qū)中的元素來實(shí)現(xiàn)求和的計(jì)算,JNI 還提供了一個(gè)和 GetIntArrayRegion 相對(duì)應(yīng)的函 SetIntArrayRegion,本地代碼可以通過這個(gè)函數(shù)來修改所有基本數(shù)據(jù)類型數(shù)組的元素。另外 JNI 還提供一系列直接獲取數(shù)組元素指針的函數(shù) Get/ReleaseArrayElements,比如:GetIntArrayElements、ReleaseArrayElements、GetFloatArrayElements、ReleaseFloatArrayElements 等。下面我們用這種方式重新實(shí)現(xiàn)計(jì)算數(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可能會(huì)復(fù)制所有原始數(shù)據(jù)到緩沖區(qū),然后返回這個(gè)緩沖區(qū)的指針  
    c_array = (*env)->GetIntArrayElements(env,j_array,NULL);  
    if (c_array == NULL) {  
        return 0;   // JVM復(fù)制原始數(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); // 釋放可能復(fù)制的緩沖區(qū)  
    return sum;  
} 

GetIntArrayElements 第三個(gè)參數(shù)表示返回的數(shù)組指針是原始數(shù)組,還是拷貝原始數(shù)據(jù)到臨時(shí)緩沖區(qū)的指針,如果是 JNI_TRUE:表示臨時(shí)緩沖區(qū)數(shù)組指針,JNI_FALSE:表示臨時(shí)原始數(shù)組指針。開發(fā)當(dāng)中,我們并不關(guān)心它從哪里返回的數(shù)組指針,這個(gè)參數(shù)填 NULL 即可,但在獲取到的指針必須做校驗(yàn),因?yàn)楫?dāng)原始數(shù)據(jù)在內(nèi)存當(dāng)中不是連續(xù)存放的情況下,JVM 會(huì)復(fù)制所有原始數(shù)據(jù)到一個(gè)臨時(shí)緩沖區(qū),并返回這個(gè)臨時(shí)緩沖區(qū)的指針。有可能在申請(qǐng)開辟臨時(shí)緩沖區(qū)內(nèi)存空間時(shí),會(huì)內(nèi)存不足導(dǎo)致申請(qǐng)失敗,這時(shí)會(huì)返回 NULL。

寫過 Java 的程序員都知道,在 Java 中創(chuàng)建的對(duì)象全都由 GC(垃圾回收器)自動(dòng)回收,不需要像 C/C++ 一樣需要程序員自己管理內(nèi)存。GC 會(huì)實(shí)時(shí)掃描所有創(chuàng)建的對(duì)象是否還有引用,如果沒有引用則會(huì)立即清理掉。當(dāng)我們創(chuàng)建一個(gè)像 int 數(shù)組對(duì)象的時(shí)候,當(dāng)我們?cè)诒镜卮a想去訪問時(shí),發(fā)現(xiàn)這個(gè)對(duì)象正被 GC 線程占用了,這時(shí)本地代碼會(huì)一直處于阻塞狀態(tài),直到等待 GC 釋放這個(gè)對(duì)象的鎖之后才能繼續(xù)訪問。為了避免這種現(xiàn)象的發(fā)生,JNI 提供了 Get/ReleasePrimitiveArrayCritical 這對(duì)函數(shù),本地代碼在訪問數(shù)組對(duì)象時(shí)會(huì)暫停 GC 線程。不過使用這對(duì)函數(shù)也有個(gè)限制,在 Get/ReleasePrimitiveArrayCritical 這兩個(gè)函數(shù)期間不能調(diào)用任何會(huì)讓線程阻塞或等待 JVM 中其它線程的本地函數(shù)或JNI函數(shù),和處理字符串的 Get/ReleaseStringCritical 函數(shù)限制一樣。這對(duì)函數(shù)和 GetIntArrayElements 函數(shù)一樣,返回的是數(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é)

對(duì)于小量的、固定大小的數(shù)組,應(yīng)該選擇 Get/SetArrayRegion 函數(shù)來操作數(shù)組元素是效率最高的。因?yàn)檫@對(duì)函數(shù)要求提前分配一個(gè) C 臨時(shí)緩沖區(qū)來存儲(chǔ)數(shù)組元素,你可以直接在 Stack(棧)上或用 malloc 在堆上來動(dòng)態(tài)申請(qǐng),當(dāng)然在棧上申請(qǐng)是最快的。有童鞋可能會(huì)認(rèn)為,訪問數(shù)組元素還需要將原始數(shù)據(jù)全部拷貝一份到臨時(shí)緩沖區(qū)才能訪問而覺得效率低?我想告訴你的是,像這種復(fù)制少量數(shù)組元素的代價(jià)是很小的,幾乎可以忽略。這對(duì)函數(shù)的另外一個(gè)優(yōu)點(diǎn)就是,允許你傳入一個(gè)開始索引和長(zhǎng)度來實(shí)現(xiàn)對(duì)子數(shù)組元素的訪問和操作(SetArrayRegion函數(shù)可以修改數(shù)組),不過傳入的索引和長(zhǎng)度不要越界,函數(shù)會(huì)進(jìn)行檢查,如果越界了會(huì)拋出 ArrayIndexOutOfBoundsException 異常。
如果不想預(yù)先分配 C 緩沖區(qū),并且原始數(shù)組長(zhǎng)度也不確定,而本地代碼又不想在獲取數(shù)組元素指針時(shí)被阻塞的話,使用 Get/ReleasePrimitiveArrayCritical 函數(shù)對(duì),就像 Get/ReleaseStringCritical 函數(shù)對(duì)一樣,使用這對(duì)函數(shù)要非常小心,以免死鎖。
Get/ReleaseArrayElements 系列函數(shù)永遠(yuǎn)是安全的,JVM 會(huì)選擇性的返回一個(gè)指針,這個(gè)指針可能指向原始數(shù)據(jù),也可能指向原始數(shù)據(jù)的復(fù)制。
訪問對(duì)象數(shù)組
JNI 提供了兩個(gè)函數(shù)來訪問對(duì)象數(shù)組,GetObjectArrayElement 返回?cái)?shù)組中指定位置的元素,SetObjectArrayElement 修改數(shù)組中指定位置的元素。與基本類型不同的是,我們不能一次得到數(shù)據(jù)中的所有對(duì)象元素或者一次復(fù)制多個(gè)對(duì)象元素到緩沖區(qū)。因?yàn)樽址蛿?shù)組都是引用類型,只能通過 Get/SetObjectArrayElement 這樣的 JNI 函數(shù)來訪問字符串?dāng)?shù)組或者數(shù)組中的數(shù)組元素。下面的例子通過調(diào)用一個(gè)本地方法來創(chuàng)建一個(gè)二維的 int 數(shù)組,然后打印這個(gè)二維數(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.獲得一個(gè)int型二維數(shù)組類的引用  
    clsIntArray = (*env)->FindClass(env,"[I");  
    if (clsIntArray == NULL)  
    {  
        return NULL;  
    }  
    // 2.創(chuàng)建一個(gè)數(shù)組對(duì)象(里面每個(gè)元素用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 獲得一個(gè) int 型的二維數(shù)組類的引用,傳遞給FindClass 的參數(shù)"[I"是 JNI class descript(JNI 類型描述符,后面為詳細(xì)介紹),它對(duì)應(yīng)著 JVM 中的int[]類型。如果 int[]類加載失敗的話,F(xiàn)indClass 會(huì)返回 NULL,然后拋出一個(gè)java.lang.NoClassDefFoundError: [I異常。

接下來,NewObjectArray 創(chuàng)建一個(gè)新的數(shù)組,這個(gè)數(shù)組里面的元素類型用 intArrCls(int[])類型來表示。函數(shù)NewObjectArray 只能分配第一維,JVM 沒有與多維數(shù)組相對(duì)應(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ù)組要復(fù)雜很多。給二維數(shù)組設(shè)置數(shù)據(jù)的方式也非常直接,首先用 NewIntArray 創(chuàng)建一個(gè) JNI 的 int 數(shù)組,并為每個(gè)數(shù)組元素分配空間,然后用 SetIntArrayRegion 把 buff[]緩沖中的內(nèi)容復(fù)制到新分配的一維數(shù)組中去,最后在外層循環(huán)中依次將 int[]數(shù)組賦值到 jobjectArray 數(shù)組中,一維數(shù)組中套一維數(shù)組,就形成了一個(gè)所謂的二維數(shù)組。

另外,為了避免在循環(huán)內(nèi)創(chuàng)建大量的 JNI 局部引用,造成 JNI 引用表溢出,所以在外層循環(huán)中每次都要調(diào)用DeleteLocalRef 將新創(chuàng)建的 jintArray 引用從引用表中移除。在 JNI 中,只有 jobject 以及子類屬于引用變量,會(huì)占用引用表的空間,jint,jfloat,jboolean 等都是基本類型變量,不會(huì)占用引用表空間,即不需要釋放。引用表最大空間為 512 個(gè),如果超出這個(gè)范圍,JVM 就會(huì)掛掉。

NdkDemo代碼已上傳至Github

如有不正支出,歡迎留言交流!
我的GitHub
我的CSDN
我的簡(jiǎn)書
開發(fā)筆記

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容