JNI開發之局部引用、全局引用和弱全局引用，成功跳槽阿裡

Java_com_study_jnilearn_AccessCache_newString 下面簡稱newString

C.f方法傳回後，JVM會釋放在這個方法執行期間建立的所有局部引用，也包含對String的Class引用cls_string。當再次調用newString時，newString所指向引用的記憶體空間已經被釋放，成為了一個野指針，再通路這個指針的引用時，會導緻因非法的記憶體通路造成程式崩潰。
           

…

… = C.f(); // 第一次調是OK的

… = C.f(); // 第二次調用時，通路的是一個無效的引用.

…

## 釋放局部引用
釋放一個局部引用有兩種方式，一個是本地方法執行完畢後JVM自動釋放，另外一個是自己調用DeleteLocalRef手動釋放。既然JVM會在函數傳回後會自動釋放所有局部引用，為什麼還需要手動釋放呢？大部分情況下，我們在實作一個本地方法時不必擔心局部引用的釋放問題，函數被調用完成後，JVM 會自動釋放函數中建立的所有局部引用。盡管如此，以下幾種情況下，為了避免記憶體溢出，我們應該手動釋放局部引用： 
1、JNI會将建立的局部引用都存儲在一個局部引用表中，如果這個表超過了最大容量限制，就會造成局部引用表溢出，使程式崩潰。經測試，Android上的JNI局部引用表最大數量是512個。當我們在實作一個本地方法時，可能需要建立大量的局部引用，如果沒有及時釋放，就有可能導緻JNI局部引用表的溢出，是以，在不需要局部引用時就立即調用DeleteLocalRef手動删除。比如，在下面的代碼中，本地代碼周遊一個特别大的字元串數組，每周遊一個元素，都會建立一個局部引用，當對使用完這個元素的局部引用時，就應該馬上手動釋放它。
           

for (i = 0; i < len; i++) {

jstring jstr = (env)->GetObjectArrayElement(env, arr, i);

… / 使用jstr */

(*env)->DeleteLocalRef(env, jstr); // 使用完成之後馬上釋放

}

2、在編寫JNI工具函數時，工具函數在程式當中是公用的，被誰調用你是不知道的。上面newString這個函數示範了怎麼樣在工具函數中使用完局部引用後，調用DeleteLocalRef删除。不這樣做的話，每次調用newString之後，都會遺留兩個引用占用空間（elemArray和cls_string，cls_string不用static緩存的情況下）。 
3、如果你的本地函數不會傳回。比如一個接收消息的函數，裡面有一個死循環，用于等待别人發送消息過來while(true) { if (有新的消息) ｛ 處理之。。。。｝ else { 等待新的消息。。。}}。如果在消息循環當中建立的引用你不顯示删除，很快将會造成JVM局部引用表溢出。 
4、局部引用會阻止所引用的對象被GC回收。比如你寫的一個本地函數中剛開始需要通路一個大對象，是以一開始就建立了一個對這個對象的引用，但在函數傳回前會有一個大量的非常複雜的計算過程，而在這個計算過程當中是不需要前面建立的那個大對象的引用的。但是，在計算的過程當中，如果這個大對象的引用還沒有被釋放的話，會阻止GC回收這個對象，記憶體一直占用者，造成資源的浪費。是以這種情況下，在進行複雜計算之前就應該把引用給釋放了，以免不必要的資源浪費。
           

}

## 管理局部引用
JNI提供了一系列函數來管理局部引用的生命周期。這些函數包括：EnsureLocalCapacity、NewLocalRef、PushLocalFrame、PopLocalFrame、DeleteLocalRef。JNI規範指出，任何實作JNI規範的JVM，必須確定每個本地函數至少可以建立16個局部引用（可以了解為虛拟機預設支援建立16個局部引用）。實際經驗表明，這個數量已經滿足大多數不需要和JVM中内部對象有太多互動的本地方函數。如果需要建立更多的引用，可以通過調用EnsureLocalCapacity函數，確定在目前線程中建立指定數量的局部引用，如果建立成功則傳回0，否則建立失敗，并抛出OutOfMemoryError異常。EnsureLocalCapacity這個函數是1.2以上版本才提供的，為了向下相容，在編譯的時候，如果申請建立的局部引用超過了本地引用的最大容量，在運作時JVM會調用FatalError函數使程式強制退出。在開發過程當中，可以為JVM添加-verbose:jni參數，在編譯的時如果發現本地代碼在試圖申請過多的引用時，會列印警告資訊提示我們要注意。在下面的代碼中，周遊數組時會擷取每個元素的引用，使用完了之後不手動删除，不考慮記憶體因素的情況下，它可以為這種建立大量的局部引用提供足夠的空間。由于沒有及時删除局部引用，是以在函數執行期間，會消耗更多的記憶體。
           

/處理函數邏輯時，確定函數能建立len個局部引用/

if((*env)->EnsureLocalCapacity(env,len) != 0) {

… /申請len個局部引用的記憶體空間失敗 OutOfMemoryError/

return;

}

for(i=0; i < len; i++) {

jstring jstr = (*env)->GetObjectArrayElement(env, arr, i);

// … 使用jstr字元串

/這裡沒有删除在for中臨時建立的局部引用/

}

另外，除了EnsureLocalCapacity函數可以擴充指定容量的局部引用數量外，我們也可以利用Push/PopLocalFrame函數對建立作用範圍層層嵌套的局部引用。例如，我們把上面那段處理字元串數組的代碼用Push/PopLocalFrame函數對重寫：
           

#define N_REFS … /最大局部引用數量/

for (i = 0; i < len; i++) {

if ((*env)->PushLocalFrame(env, N_REFS) != 0) {

… /記憶體溢出/

}

jstring jstr = (env)->GetObjectArrayElement(env, arr, i);

… / 使用jstr */

(*env)->PopLocalFrame(env, NULL);

}

PushLocalFrame為目前函數中需要用到的局部引用建立了一個引用堆棧，（如果之前調用PushLocalFrame已經建立了Frame，在目前的本地引用棧中仍然是有效的)每周遊一次調用(*env)->GetObjectArrayElement(env, arr, i);傳回一個局部引用時，JVM會自動将該引用壓入目前局部引用棧中。而PopLocalFrame負責銷毀棧中所有的引用。這樣一來，Push/PopLocalFrame函數對提供了對局部引用生命周期更友善的管理，而不需要時刻關注擷取一個引用後，再調用DeleteLocalRef來釋放引用。在上面的例子中，如果在處理jstr的過程當中又建立了局部引用，則PopLocalFrame執行時，這些局部引用将全都會被銷毀。在調用PopLocalFrame銷毀目前frame中的所有引用前，如果第二個參數result不為空，會由result生成一個新的局部引用，再把這個新生成的局部引用存儲在上一個frame中。請看下面的示例：
           

// 函數原型

jobject (JNICALL *PopLocalFrame)(JNIEnv *env, jobject result);

jstring other_jstr;

for (i = 0; i < len; i++) {

if ((*env)->PushLocalFrame(env, N_REFS) != 0) {

… /記憶體溢出/

}

jstring jstr = (env)->GetObjectArrayElement(env, arr, i);

… / 使用jstr */

if (i == 2) {

other_jstr = jstr;

}

other_jstr = (*env)->PopLocalFrame(env, other_jstr); // 銷毀局部引用棧前傳回指定的引用

}

還要注意的一個問題是，局部引用不能跨線程使用，隻在建立它的線程有效。不要試圖在一個線程中建立局部引用并存儲到全局引用中，然後在另外一個線程中使用。

## 全局引用
全局引用可以跨方法、跨線程使用，直到它被手動釋放才會失效。同局部引用一樣，也會阻止它所引用的對象被GC回收。與局部引用建立方式不同的是，隻能通過NewGlobalRef函數建立。下面這個版本的newString示範怎麼樣使用一個全局引用：
           

JNIEXPORT jstring JNICALL Java_com_study_jnilearn_AccessCache_newString

(JNIEnv *env, jobject obj, jcharArray j_char_arr, jint len)

{

// …

jstring jstr = NULL;

static jclass cls_string = NULL;

if (cls_string == NULL) {

jclass local_cls_string = (*env)->FindClass(env, “java/lang/String”);

if (cls_string == NULL) {

return NULL;

}

// 将java.lang.String類的Class引用緩存到全局引用當中
    cls_string = (*env)->NewGlobalRef(env, local_cls_string);

    // 删除局部引用
    (*env)->DeleteLocalRef(env, local_cls_string);

    // 再次驗證全局引用是否建立成功
    if (cls_string == NULL) {
        return NULL;
    }
}

// ....
return jstr;
           

}

## 弱全局引用
弱全局引用使用NewGlobalWeakRef建立，使用DeleteGlobalWeakRef釋放。下面簡稱弱引用。與全局引用類似，弱引用可以跨方法、線程使用。但與全局引用很重要不同的一點是，弱引用不會阻止GC回收它引用的對象。在newString這個函數中，我們也可以使用弱引用來存儲String的Class引用，因為java.lang.String這個類是系統類，永遠不會被GC回收。當本地代碼中緩存的引用不一定要阻止GC回收它所指向的對象時，弱引用就是一個最好的選擇。假設，一個本地方法mypkg.MyCls.f需要緩存一個指向類mypkg.MyCls2的引用，如果在弱引用中緩存的話，仍然允許mypkg.MyCls2這個類被unload，因為弱引用不會阻止GC回收所引用的對象。請看下面的代碼段：
           

JNIEXPORT void JNICALL

Java_mypkg_MyCls_f(JNIEnv *env, jobject self)

{

static jclass myCls2 = NULL;

if (myCls2 == NULL)

{

jclass myCls2Local = (env)->FindClass(env, “mypkg/MyCls2”);

if (myCls2Local == NULL)

{

return; / 沒有找到mypkg/MyCls2這個類 /

}

myCls2 = NewWeakGlobalRef(env, myCls2Local);

if (myCls2 == NULL)

{

return; / 記憶體溢出 /

}

}

… / 使用myCls2的引用 */

}

我們假設MyCls和MyCls2有相同的生命周期（例如，他們可能被相同的類加載器加載），因為弱引用的存在，我們不必擔心MyCls和它所在的本地代碼在被使用時，MyCls2這個類出現先被unload，後來又會preload的情況。當然，如果真的發生這種情況時（MyCls和MyCls2此時的生命周期不同），我們在使用弱引用時，必須先檢查緩存過的弱引用是指向活動的類對象，還是指向一個已經被GC給unload的類對象。下面馬上告訴你怎樣檢查弱引用是否活動，即引用的比較。

## 引用比較
給定兩個引用（不管是全局、局部還是弱全局引用），我們隻需要調用IsSameObject來判斷它們兩個是否指向相同的對象。例如：（*env)->IsSameObject(env, obj1, obj2)，如果obj1和obj2指向相同的對象，則傳回JNI_TRUE（或者1），否則傳回JNI_FALSE（或者0）。有一個特殊的引用需要注意：NULL，JNI中的NULL引用指向JVM中的null對象。如果obj是一個局部或全局引用，使用(*env)->IsSameObject(env, obj, NULL) 或者 obj == NULL 來判斷obj是否指向一個null對象即可。但需要注意的是，IsSameObject用于弱全局引用與NULL比較時，傳回值的意義是不同于局部引用和全局引用的：
           

jobject local_obj_ref = (*env)->NewObject(env, xxx_cls,xxx_mid);

jobject g_obj_ref = (*env)->NewWeakGlobalRef(env, local_ref);

// … 業務邏輯處理

jboolean isEqual = (*env)->IsSameObject(env, g_obj_ref, NULL);

在上面的IsSameObject調用中，如果g_obj_ref指向的引用已經被回收，會傳回JNI_TRUE，如果wobj仍然指向一個活動對象，會傳回JNI_FALSE。

## 釋放全局引用
每一個JNI引用被建立時，除了它所指向的JVM中對象的引用需要占用一定的記憶體空間外，引用本身也會消耗掉一個數量的記憶體空間。作為一個優秀的程式員，我們應該對程式在一個給定的時間段内使用的引用數量要十分小心。短時間内建立大量而沒有被立即回收的引用很可能就會導緻記憶體溢出。

當我們的本地代碼不再需要一個全局引用時，應該馬上調用DeleteGlobalRef來釋放它。如果不手動調用這個函數，即使這個對象已經沒用了，JVM也不會回收這個全局引用所指向的對象。 
同樣，當我們的本地代碼不再需要一個弱全局引用時，也應該調用DeleteWeakGlobalRef來釋放它，如果不手動調用這個函數來釋放所指向的對象，JVM仍會回收弱引用所指向的對象，但弱引用本身在引用表中所占的記憶體永遠也不會被回收。

## 管理引用的規則
前面對三種引用已做了一個全面的介紹，下面來總結一下引用的管理規則和使用時的一些注意事項，使用好引用的目的就是為了減少記憶體使用和對象被引用保持而不能釋放，造成記憶體浪費。是以在開發當中要特别小心！ 
通常情況下，有兩種本地代碼使用引用時要注意： 
1、 直接實作Java層聲明的native函數的本地代碼 
當編寫這類本地代碼時，要當心不要造成全局引用和弱引用的累加，因為本地方法執行完畢後，這兩種引用不會被自動釋放。 
2、被用在任何環境下的工具函數。例如：方法調用、屬性通路和異常處理的工具函數等。 
編寫工具函數的本地代碼時，要當心不要在函數的調用軌迹上遺漏任何的局部引用，因為工具函數被調用的場合和次數是不确定的，一量被大量調用，就很有可能造成記憶體溢出。是以在編寫工具函數時，請遵守下面的規則： 
1> 一個傳回值為基本類型的工具函數被調用時，它決不能造成局部、全局、弱全局引用被回收的累加 
2> 當一個傳回值為引用類型的工具函數被調用時，它除了傳回的引用以外，它決不能造成其它局部、全局、弱引用的累加 
對于工具函數來說，為了使用緩存技術而建立一些全局引用或者弱全局引用是正常的。如果一個工具函數傳回的是一個引用，我們應該寫好注釋詳細說明傳回引用的類型，以便于使用者更好的管理它們。下面的代碼中，頻繁地調用工具函數GetInfoString，我們需要知道GetInfoString傳回引用的類型是什麼，以便于每次使用完成後調用相應的JNI函數來釋放掉它。
           

while (JNI_TRUE) {

jstring infoString = GetInfoString(info);

…

}

函數NewLocalRef有時被用來確定一個工具函數傳回一個局部引用。我們改造一下newString這個函數，示範一下這個函數的用法。下面的newString是把一個被頻繁調用的字元串“CommonString”緩存在了全局引用裡：
           

JNIEXPORT jstring JNICALL Java_com_study_jnilearn_AccessCache_newString

{

static jstring result;

cachedString = (*env)->NewGlobalRef(env, cachedStringLocal);