JNI/NDK開發指南（十）——JNI局部引用、全局引用和弱全局引用

轉自：http://blog.csdn.net/xyang81/article/details/44657385

 

  這篇文章比較偏理論，詳細介紹了在編寫本地代碼時三種引用的使用場景和注意事項。可能看起來有點枯燥，但引用是在JNI中最容易出錯的一個點，若是使用不當，容易使程序形成內存溢出，程序崩潰等現象。因此講得比較細，有些地方看起來可能比較囉嗦，還請輕啪！《Android JNI局部引用表溢出：local reference table overflow (max=512)》這篇文章是一個JNI引用使用不當形成引用表溢出，最終致使程序崩潰的例子。建議看完這篇文章以後，再去看。

    作Java的朋友都知道，在編碼的過程中，內存管理這一塊徹底是透明的。new一個類的實例時，只知道建立完這個類的實例以後，會返回這個實例的一個引用，而後就能夠拿着這個引用訪問它的全部數據成員了（屬性、方法）。徹底不用管JVM內部是怎麼實現的，如何爲新建立的對象來申請內存，也不用管對象使用完以後內存是怎麼釋放的，只需知道有一個垃圾回器在幫忙管理這些事情就OK的了。有經驗的朋友也許知道啓動一個Java程序，若是沒有手動建立其它線程，默認會有兩個線程在跑，一個是main線程，另外一個就是GC線程（負責將一些再也不使用的對象回收）。若是你曾經是作Java的而後轉去作C++，會感受很「蛋疼」，在C++中new一個對象，使用完了還要作一次delete操做，malloc一次一樣也要調用free來釋放相應的內存，不然你的程序就會有內存泄露了。並且在C/C++中內存還分棧空間和堆空間，其中局部變量、函數形參變量、for中定義的臨時變量所分配的內存空間都是存放在棧空間（並且還要注意大小的限制），用new和malloc申請的內存都存放在堆空間。。。但C/C++裏的內存管理還遠遠不止這些，這些只是最基礎的內存管理常識。作Java的童鞋聽到這些確定會偷樂了，咱寫Java的時候這些都不用管，全都交給GC就萬事無優了。手動管理內存雖然麻煩，並且須要特別細心，一不當心就有可能形成內存泄露和野指針訪問等程序致命的問題，但凡事都有利弊，手動申請和釋放內存對程序的掌握比較靈活，不會受到平臺的限制。好比咱們寫Android程序的時候，內存使用就受Dalivk虛擬機的限制，從最第一版本的16~24M，到後來的32M到64M，可能隨着之後移動設備物理內存的不大擴大，後面的android版本內存限制可能也會隨着提升。但在C/C++這層，就徹底不受虛擬機的限制了。好比要在Android中要存儲一張超高清的圖片，恰好這張圖片的大小超過了Dalivk虛擬機對每一個應用的內存大小限制，Java此時就顯得無能爲力了，但在C/C++看來就是小菜一碟了，malloc(1024*1024*50)，要多少內存，您說個數。。。C/C++程序員得意的說道～～Java不是說是一門純面象對象的語言嗎，因此除了基本數據類型外，其它任何類型所建立的對象，JVM所申請的內存都存在堆空間。上面提升到了GC，是負責回收再也不使用的對象，它的全稱是Garbage Collection，也就是所謂的垃圾回收。JVM會在適當的時機觸發GC操做，一旦進行GC操做，就會將一些再也不使用的對象進行回收。那麼哪些對象會被認爲是再也不使用，而且能夠被回收的呢？咱們來看下面二張圖：（注：圖摘自博主郭霖的《Android最佳性能實踐(二)——分析內存的使用狀況》） 
 
上圖當中，每一個藍色的圓圈就表明一個內存當中的對象，而圓圈之間的箭頭就是它們的引用關係。這些對象有些是處於活動狀態的，而有些就已經再也不被使用了。那麼GC操做會從一個叫做Roots的對象開始檢查，全部它能夠訪問到的對象就說明還在使用當中，應該進行保留，而其它的對象就表示已經再也不被使用了，以下圖所示： 
 
能夠看到，目前全部黃色的對象都處於活動狀態，仍然會被系統繼續保留，而藍色的對象就會在GC操做當中被系統回收掉了，這就是JVM執行一次GC的簡單流程。

    上面說的廢話好像有點多哈，下面進入正題。經過上面的討論，你們都知道，若是一個Java對象沒有被其它成員變量或靜態變量所引用的話，就隨時有可能會被GC回收掉。因此咱們在編寫本地代碼時，要注意從JVM中獲取到的引用在使用時被GC回收的可能性。因爲本地代碼不能直接經過引用操做JVM內部的數據結構，要進行這些操做必須調用相應的JNI接口來間接操做所引用的數據結構。JNI提供了和Java相對應的引用類型，供本地代碼配合JNI接口間接操做JVM內部的數據內容使用。如：jobject、jstring、jclass、jarray、jintArray等。由於咱們只經過JNI接口操做JNI提供的引用類型數據結構，並且每一個JVM都實現了JNI規範相應的接口，因此咱們沒必要擔憂特定JVM中對象的存儲方式和內部數據結構等信息，咱們只須要學習JNI中三種不一樣的引用便可。

因爲Java程序運行在虛擬機中的這個特色，在Java中建立的對象、定義的變量和方法，內部對象的數據結構是怎麼定義的，只有JVM本身知道。若是咱們在C/C++中想要訪問Java中對象的屬性和方法時，是不可以直接操做JVM內部Java對象的數據結構的。想要在C/C++中正確的訪問Java的數據結構，JVM就必須有一套規則來約束C/C++與Java互相訪問的機制，因此纔有了JNI規範，JNI規範定義了一系列接口，任何實現了這套JNI接口的Java虛擬機，C/C++就能夠經過調用這一系列接口來間接的訪問Java中的數據結構。好比前面文章中學習到的經常使用JNI接口有：GetStringUTFChars（從Java虛擬機中獲取一個字符串）、ReleaseStringUTFChars（釋放從JVM中獲取字符串所分配的內存空間）、NewStringUTF、GetArrayLength、GetFieldID、GetMethodID、FindClass等。

三種引用簡介及區別

    在JNI規範中定義了三種引用：局部引用（Local Reference）、全局引用（Global Reference）、弱全局引用（Weak Global Reference）。區別以下： 
一、局部引用：經過NewLocalRef和各類JNI接口建立（FindClass、NewObject、GetObjectClass和NewCharArray等）。會阻止GC回收所引用的對象，不在本地函數中跨函數使用，不能跨線前使用。函數返回後局部引用所引用的對象會被JVM自動釋放，或調用DeleteLocalRef釋放。(*env)-

1 >DeleteLocalRef(env,local_ref)
2 
3 jclass cls_string = (*env)->FindClass(env, "java/lang/String");
4 jcharArray charArr = (*env)->NewCharArray(env, len);
5 jstring str_obj = (*env)->NewObject(env, cls_string, cid_string, elemArray);
6 jstring str_obj_local_ref = (*env)->NewLocalRef(env,str_obj);   // 經過NewLocalRef函數建立
7 ...

 

二、全局引用：調用NewGlobalRef基於局部引用建立，會阻GC回收所引用的對象。能夠跨方法、跨線程使用。JVM不會自動釋放，必須調用DeleteGlobalRef手動釋放(*env)->DeleteGlobalRef(env,g_cls_string);

static jclass g_cls_string; void TestFunc(JNIEnv* env, jobject obj) { jclass cls_string = (*env)->FindClass(env, "java/lang/String"); g_cls_string = (*env)->NewGlobalRef(env,cls_string); }

三、 弱全局引用：調用NewWeakGlobalRef基於局部引用或全局引用建立，不會阻止GC回收所引用的對象，能夠跨方法、跨線程使用。引用不會自動釋放，在JVM認爲應該回收它的時候（好比內存緊張的時候）進行回收而被釋放。或調用DeleteWeakGlobalRef手動釋放。(*env)->DeleteWeakGlobalRef(env,g_cls_string)

1 static jclass g_cls_string;
2 void TestFunc(JNIEnv* env, jobject obj) {
3     jclass cls_string = (*env)->FindClass(env, "java/lang/String");
4     g_cls_string = (*env)->NewWeakGlobalRef(env,cls_string);
5 }

 

局部引用

局部引用也稱本地引用，一般是在函數中建立並使用。會阻止GC回收所引用的對象。好比，調用NewObject接口建立一個新的對象實例並返回一個對這個對象的局部引用。局部引用只有在建立它的本地方法返回前有效，本地方法返回到Java層以後，若是Java層沒有對返回的局部引用使用的話，局部引用就會被JVM自動釋放。你可能會爲了提升程序的性能，在函數中將局部引用存儲在靜態變量中緩存起來，供下次調用時使用。這種方式是錯誤的，由於函數返回後局部引極可能立刻就會被釋放掉，靜態變量中存儲的就是一個被釋放後的內存地址，成了一個野針對，下次再使用的時候就會形成非法地址的訪問，使程序崩潰。請看下面一個例子，錯誤的緩存了String的Class引用：

 1 /*錯誤的局部引用*/
 2 JNIEXPORT jstring JNICALL Java_com_study_jnilearn_AccessCache_newString
 3 (JNIEnv *env, jobject obj, jcharArray j_char_arr, jint len)
 4 {
 5     jcharArray elemArray;
 6     jchar *chars = NULL;
 7     jstring j_str = NULL;
 8     static jclass cls_string = NULL;
 9     static jmethodID cid_string = NULL;
10     // 注意：錯誤的引用緩存
11     if (cls_string == NULL) {
12         cls_string = (*env)->FindClass(env, "java/lang/String");
13         if (cls_string == NULL) {
14             return NULL;
15         }
16     }
17     // 緩存String的構造方法ID
18     if (cid_string == NULL) {
19         cid_string = (*env)->GetMethodID(env, cls_string, "<init>", "([C)V");
20         if (cid_string == NULL) {
21             return NULL;
22         }
23     }
24 
25    //省略額外的代碼.......
26     elemArray = (*env)->NewCharArray(env, len);
27     // ....
28     j_str = (*env)->NewObject(env, cls_string, cid_string, elemArray);
29     // 釋放局部引用
30     (*env)->DeleteLocalRef(env, elemArray);
31     return j_str;
32 }

 

上面代碼中，咱們省略了和咱們討論無關的代碼。由於FindClass返回一個對java.lang.String對象的局部引用，上面代碼中緩存cls_string作法是錯誤的。假設一個本地方法C.f調用了newString：

1 JNIEXPORT jstring JNICALL
2  Java_C_f(JNIEnv *env, jobject this)
3  {
4      char *c_str = ...;
5      ...
6      return newString(c_str);
7 }

 

Java_com_study_jnilearn_AccessCache_newString 下面簡稱newString

C.f方法返回後，JVM會釋放在這個方法執行期間建立的全部局部引用，也包含對String的Class引用cls_string。當再次調用newString時，newString所指向引用的內存空間已經被釋放，成爲了一個野指針，再訪問這個指針的引用時，會致使因非法的內存訪問形成程序崩潰。

1 ...
2 ... = C.f(); // 第一次調是OK的
3 ... = C.f(); // 第二次調用時，訪問的是一個無效的引用.
4 ...

 

釋放局部引用

釋放一個局部引用有兩種方式，一個是本地方法執行完畢後JVM自動釋放，另一個是本身調用DeleteLocalRef手動釋放。既然JVM會在函數返回後會自動釋放全部局部引用，爲何還須要手動釋放呢？大部分狀況下，咱們在實現一個本地方法時沒必要擔憂局部引用的釋放問題，函數被調用完成後，JVM 會自動釋放函數中建立的全部局部引用。儘管如此，如下幾種狀況下，爲了不內存溢出，咱們應該手動釋放局部引用： 
一、JNI會將建立的局部引用都存儲在一個局部引用表中，若是這個表超過了最大容量限制，就會形成局部引用表溢出，使程序崩潰。經測試，Android上的JNI局部引用表最大數量是512個。當咱們在實現一個本地方法時，可能須要建立大量的局部引用，若是沒有及時釋放，就有可能致使JNI局部引用表的溢出，因此，在不須要局部引用時就當即調用DeleteLocalRef手動刪除。好比，在下面的代碼中，本地代碼遍歷一個特別大的字符串數組，每遍歷一個元素，都會建立一個局部引用，當對使用完這個元素的局部引用時，就應該立刻手動釋放它。

1 for (i = 0; i < len; i++) {
2      jstring jstr = (*env)->GetObjectArrayElement(env, arr, i);
3      ... /* 使用jstr */
4      (*env)->DeleteLocalRef(env, jstr); // 使用完成以後立刻釋放
5 }

 

二、在編寫JNI工具函數時，工具函數在程序當中是公用的，被誰調用你是不知道的。上面newString這個函數演示了怎麼樣在工具函數中使用完局部引用後，調用DeleteLocalRef刪除。不這樣作的話，每次調用newString以後，都會遺留兩個引用佔用空間（elemArray和cls_string，cls_string不用static緩存的狀況下）。 
三、若是你的本地函數不會返回。好比一個接收消息的函數，裏面有一個死循環，用於等待別人發送消息過來while(true) { if (有新的消息) ｛ 處理之。。。。｝ else { 等待新的消息。。。}}。若是在消息循環當中建立的引用你不顯示刪除，很快將會形成JVM局部引用表溢出。 
四、局部引用會阻止所引用的對象被GC回收。好比你寫的一個本地函數中剛開始須要訪問一個大對象，所以一開始就建立了一個對這個對象的引用，但在函數返回前會有一個大量的很是複雜的計算過程，而在這個計算過程中是不須要前面建立的那個大對象的引用的。可是，在計算的過程中，若是這個大對象的引用尚未被釋放的話，會阻止GC回收這個對象，內存一直佔用者，形成資源的浪費。因此這種狀況下，在進行復雜計算以前就應該把引用給釋放了，以避免沒必要要的資源浪費。

1 /* 假如這是一個本地方法實現 */
2 JNIEXPORT void JNICALL Java_pkg_Cls_func(JNIEnv *env, jobject this)
3 {
4    lref = ...              /* lref引用的是一個大的Java對象 */
5    ...                     /* 在這裏已經處理完業務邏輯後，這個對象已經使用完了 */
6    (*env)->DeleteLocalRef(env, lref); /* 及時刪除這個對這個大對象的引用，GC就能夠對它回收，並釋放相應的資源*/
7    lengthyComputation();   /* 在裏有個比較耗時的計算過程 */
8    return;                 /* 計算完成以後，函數返回以前全部引用都已經釋放 */
9 }

 

管理局部引用

JNI提供了一系列函數來管理局部引用的生命週期。這些函數包括：EnsureLocalCapacity、NewLocalRef、PushLocalFrame、PopLocalFrame、DeleteLocalRef。JNI規範指出，任何實現JNI規範的JVM，必須確保每一個本地函數至少能夠建立16個局部引用（能夠理解爲虛擬機默認支持建立16個局部引用）。實際經驗代表，這個數量已經知足大多數不須要和JVM中內部對象有太多交互的本地方函數。若是須要建立更多的引用，能夠經過調用EnsureLocalCapacity函數，確保在當前線程中建立指定數量的局部引用，若是建立成功則返回0，不然建立失敗，並拋出OutOfMemoryError異常。EnsureLocalCapacity這個函數是1.2以上版本才提供的，爲了向下兼容，在編譯的時候，若是申請建立的局部引用超過了本地引用的最大容量，在運行時JVM會調用FatalError函數使程序強制退出。在開發過程中，能夠爲JVM添加-verbose:jni參數，在編譯的時若是發現本地代碼在試圖申請過多的引用時，會打印警告信息提示咱們要注意。在下面的代碼中，遍歷數組時會獲取每一個元素的引用，使用完了以後不手動刪除，不考慮內存因素的狀況下，它能夠爲這種建立大量的局部引用提供足夠的空間。因爲沒有及時刪除局部引用，所以在函數執行期間，會消耗更多的內存。

 1 /*處理函數邏輯時，確保函數能建立len個局部引用*/
 2 if((*env)->EnsureLocalCapacity(env,len) != 0) {
 3     ... /*申請len個局部引用的內存空間失敗 OutOfMemoryError*/
 4     return;
 5 }
 6 for(i=0; i < len; i++) {
 7     jstring jstr = (*env)->GetObjectArrayElement(env, arr, i);
 8     // ... 使用jstr字符串
 9     /*這裏沒有刪除在for中臨時建立的局部引用*/
10 }

 

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

1 #define N_REFS ... /*最大局部引用數量*/
2 for (i = 0; i < len; i++) {
3     if ((*env)->PushLocalFrame(env, N_REFS) != 0) {
4         ... /*內存溢出*/
5     }
6      jstring jstr = (*env)->GetObjectArrayElement(env, arr, i);
7      ... /* 使用jstr */
8      (*env)->PopLocalFrame(env, NULL);
9 }

 

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

 1 // 函數原型
 2 jobject (JNICALL *PopLocalFrame)(JNIEnv *env, jobject result);
 3 
 4 jstring other_jstr;
 5 for (i = 0; i < len; i++) {
 6     if ((*env)->PushLocalFrame(env, N_REFS) != 0) {
 7         ... /*內存溢出*/
 8     }
 9      jstring jstr = (*env)->GetObjectArrayElement(env, arr, i);
10      ... /* 使用jstr */
11      if (i == 2) {
12         other_jstr = jstr;
13      }
14     other_jstr = (*env)->PopLocalFrame(env, other_jstr);  // 銷燬局部引用棧前返回指定的引用
15 }

 

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

全局引用

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

 1 JNIEXPORT jstring JNICALL Java_com_study_jnilearn_AccessCache_newString
 2 (JNIEnv *env, jobject obj, jcharArray j_char_arr, jint len)
 3 {
 4     // ...
 5     jstring jstr = NULL;
 6     static jclass cls_string = NULL;
 7     if (cls_string == NULL) {
 8         jclass local_cls_string = (*env)->FindClass(env, "java/lang/String");
 9         if (cls_string == NULL) {
10             return NULL;
11         }
12 
13         // 將java.lang.String類的Class引用緩存到全局引用當中
14         cls_string = (*env)->NewGlobalRef(env, local_cls_string);
15 
16         // 刪除局部引用
17         (*env)->DeleteLocalRef(env, local_cls_string);
18 
19         // 再次驗證全局引用是否建立成功
20         if (cls_string == NULL) {
21             return NULL;
22         }
23     }
24 
25     // ....
26     return jstr;
27 }

 

弱全局引用

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

 1 JNIEXPORT void JNICALL
 2 Java_mypkg_MyCls_f(JNIEnv *env, jobject self)
 3 {
 4     static jclass myCls2 = NULL;
 5     if (myCls2 == NULL)
 6     {
 7         jclass myCls2Local = (*env)->FindClass(env, "mypkg/MyCls2");
 8         if (myCls2Local == NULL)
 9         {
10             return; /* 沒有找到mypkg/MyCls2這個類 */
11         }
12         myCls2 = NewWeakGlobalRef(env, myCls2Local);
13         if (myCls2 == NULL)
14         {
15             return; /* 內存溢出 */
16         }
17     }
18     ... /* 使用myCls2的引用 */
19 }

 

咱們假設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比較時，返回值的意義是不一樣於局部引用和全局引用的：

1 jobject local_obj_ref = (*env)->NewObject(env, xxx_cls,xxx_mid);
2 jobject g_obj_ref = (*env)->NewWeakGlobalRef(env, local_ref);
3 // ... 業務邏輯處理
4 jboolean isEqual = (*env)->IsSameObject(env, g_obj_ref, NULL);

 

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

釋放全局引用

每個JNI引用被創建時，除了它所指向的JVM中對象的引用須要佔用必定的內存空間外，引用自己也會消耗掉一個數量的內存空間。做爲一個優秀的程序員，咱們應該對程序在一個給定的時間段內使用的引用數量要十分當心。短期內建立大量而沒有被當即回收的引用極可能就會致使內存溢出。

    當咱們的本地代碼再也不須要一個全局引用時，應該立刻調用DeleteGlobalRef來釋放它。若是不手動調用這個函數，即便這個對象已經沒用了，JVM也不會回收這個全局引用所指向的對象。 
    一樣，當咱們的本地代碼再也不須要一個弱全局引用時，也應該調用DeleteWeakGlobalRef來釋放它，若是不手動調用這個函數來釋放所指向的對象，JVM仍會回收弱引用所指向的對象，但弱引用自己在引用表中所佔的內存永遠也不會被回收。

管理引用的規則

前面對三種引用已作了一個全面的介紹，下面來總結一下引用的管理規則和使用時的一些注意事項，使用好引用的目的就是爲了減小內存使用和對象被引用保持而不能釋放，形成內存浪費。因此在開發當中要特別當心！ 
一般狀況下，有兩種本地代碼使用引用時要注意： 
一、 直接實現Java層聲明的native函數的本地代碼 
當編寫這類本地代碼時，要小心不要形成全局引用和弱引用的累加，由於本地方法執行完畢後，這兩種引用不會被自動釋放。 
二、被用在任何環境下的工具函數。例如：方法調用、屬性訪問和異常處理的工具函數等。 
編寫工具函數的本地代碼時，要小心不要在函數的調用軌跡上遺漏任何的局部引用，由於工具函數被調用的場合和次數是不肯定的，一量被大量調用，就頗有可能形成內存溢出。因此在編寫工具函數時，請遵照下面的規則： 
1> 一個返回值爲基本類型的工具函數被調用時，它決不能形成局部、全局、弱全局引用被回收的累加 
2> 當一個返回值爲引用類型的工具函數被調用時，它除了返回的引用之外，它決不能形成其它局部、全局、弱引用的累加 
對於工具函數來講，爲了使用緩存技術而建立一些全局引用或者弱全局引用是正常的。若是一個工具函數返回的是一個引用，咱們應該寫好註釋詳細說明返回引用的類型，以便於使用者更好的管理它們。下面的代碼中，頻繁地調用工具函數GetInfoString，咱們須要知道GetInfoString返回引用的類型是什麼，以便於每次使用完成後調用相應的JNI函數來釋放掉它。

1 while (JNI_TRUE) {
2      jstring infoString = GetInfoString(info);
3      ... /* 處理infoString */
4      ??? /* 使用完成以後，調用DeleteLocalRef、DeleteGlobalRef、DeleteWeakGlobalRef哪個函數來釋放這個引用呢？*/
5 }

 

函數NewLocalRef有時被用來確保一個工具函數返回一個局部引用。咱們改造一下newString這個函數，演示一下這個函數的用法。下面的newString是把一個被頻繁調用的字符串「CommonString」緩存在了全局引用裏：

 1 JNIEXPORT jstring JNICALL Java_com_study_jnilearn_AccessCache_newString
 2 {
 3     static jstring result;
 4     /* 使用wstrncmp函數比較兩個Unicode字符串 */
 5     if (wstrncmp("CommonString", chars, len) == 0)
 6     {
 7         /* 將"CommonString"這個字符串緩存到全局引用中 */
 8         static jstring cachedString = NULL;
 9         if (cachedString == NULL)
10         {
11             /* 先建立"CommonString"這個字符串 */
12             jstring cachedStringLocal = ...;
13             /* 而後將這個字符串緩存到全局引用中 */
14             cachedString = (*env)->NewGlobalRef(env, cachedStringLocal);
15         }
16         // 基於全局引用建立一個局引用返回，也一樣會阻止GC回收所引用的這個對象，由於它們指向的是同一個對象
17         return (*env)->NewLocalRef(env, cachedString);  
18     }
19     ... 
20     return result;
21 }

 

在管理局部引用的生命週期中，Push/PopLocalFrame是很是方便且安全的。咱們能夠在本地函數的入口處調用PushLocalFrame，而後在出口處調用PopLocalFrame，這樣的話，在函數內任何位置建立的局部引用都會被釋放。並且，這兩個函數是很是高效的，強烈建議使用它們。須要注意的是，若是在函數的入口處調用了PushLocalFrame，記住要在函數全部出口（有return語句出現的地方）都要調用PopLocalFrame。在下面的代碼中，對PushLocalFrame的調用只有一次，但調用PopLocalFrame確有屢次，固然你也可使用goto語句來統一處理。

 1 jobject f(JNIEnv *env, ...)
 2 {
 3     jobject result;
 4     if ((*env)->PushLocalFrame(env, 10) < 0)
 5     {
 6         /* 調用PushLocalFrame獲取10個局部引用失敗，不須要調用PopLocalFrame */
 7         return NULL;
 8     }
 9     ...
10     result = ...; // 建立局部引用result
11     if (...)
12     {
13         /* 返回前先彈出棧頂的frame */
14         result = (*env)->PopLocalFrame(env, result);
15         return result;
16     }
17     ...
18     result = (*env)->PopLocalFrame(env, result);
19     /* 正常返回 */
20     return result;
21 }

 

上面的代碼一樣演示了函數PopLocalFrame的第二個參數的用法，局部引用result一開始在PushLocalFrame建立在當前frame裏面，而把result傳入PopLocalFrame中時，PopLocalFrame在彈出當前的frame前，會由result生成一個新的局部引用，再將這個新生成的局部引用存儲在上一個frame當中。