JNI 局部引用、全局引用和弱全局引用

在JNI规范中定义了三种引用：局部引用（Local Reference）、全局引用（Global Reference）、弱全局引用（Weak Global Reference）。区别如下：

• 局部引用 通过NewLocalRef和各种JNI接口创建（FindClass、NewObject、GetObjectClass和NewCharArray等）。会阻止GC回收所引用的对象，不在本地函数中跨函数使用，不能跨线前使用。函数返回后局部引用所引用的对象会被JVM自动释放，或调用DeleteLocalRef释放。(*env)->DeleteLocalRef(env,local_ref)

  jclass str = (*env)->FindClass(env, "java/lang/String");
  jcharArray charArray = (*env)->NewCharArray(env, len);
  jstring str_obj = (*env)->NewObject(env, cls_string, cid_string, elemArray);
  jstring str_obj_local_ref = (*env)->NewLocalRef(env,str_obj);   // 通过NewLocalRef函数创建
  ...
  

• 全局引用

  调用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)。

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

局部引用

• 创建局部引用

  在函数中创建。会阻止GC回收所引用的对象。比如我调用一个NewObject接口创建一个新的对象实例并返回一个对这个对象的局部引用。局部引用只有在创建它的本地方法返回前有效，本地方法返回到Java之后，如果Java层没有对返回的局部引用使用的话，局部引用就会被JVM释放掉。我们可能在函数中将局部引用存储在静态变量中缓存起来，供下次调用时使用。这种方式是不可取的，因为函数返回后局部引用很有可能会马上释放掉，静态变量中存储了就是一个被释放后的内存地址，成为野指针，这种是不能通过判NULL来检测的。附代码：

  #include <jni.h>
  
  /*错误的局部引用*/
  JNIEXPORT jstring JNICALL Java_org_professor_jni_bean_Person_newString
          (JNIEnv *env, jobject obj, jcharArray j_char_arr, jint len) {
      jcharArray elemArray;
      jchar *chars = NULL;
      jstring j_str = NULL;
      static jclass cls_string = NULL;
      static jmethodID cid_string = NULL;
      // 注意：错误的引用缓存
      if (NULL == cls_string) {
          cls_string = (*env)->FindClass(env, "java/lang/String");
          if (NULL == cls_string) {
              return NULL;
          }
      }
      // 缓存String的构造方法ID
      if (NULL == cid_string) {
          cid_string = (*env)->GetMethodID(env, cls_string, "<init>", "([C)V");
          if (NULL == cid_string) {
              return NULL;
          }
      }
  
      //省略额外的代码.......
      elemArray = (*env)->NewCharArray(env, len);
      // ....
      j_str = (*env)->NewObject(env, cls_string, cid_string, elemArray);
      // 释放局部引用
      (*env)->DeleteLocalRef(env, elemArray);
      return j_str;
  }
  

  • 分析

    上面代码中，略去了无关代码，假设当我们调用了该方法

    JNIEXPORT jstring JNICALL
    JAVA org_professor_jni_MainActivity_callNewString(JNIEnv *env, jobject obj){
        char *c_str = ...;
        jcharArray char_arr = ...;
    
        //...
        return Java_org_professor_jni_bean_Person_newString(env,obj,char_arr,c_str);  
    }
    
    

    该方法返回后，JVM会释放在这个方法执行期间创建的所有局部引用，也包含对String的Class引用cls_string。当再次调用Java_org_professor_jni_bean_Person_newString时候，Java_org_professor_jni_bean_Person_newString所指向的内存空间已经被释放，成为了一个野指针，会因非法内存访问造成Crash。

• 释放局部引用

  释放一个局部引用有两种方式，

  • 本地方法执行完自动释放
  • 手动调用DeleteLocalRef释放

  理所当然，JVM会在函数返回后会被自动释放，为啥还要手动去释放？大部分情况下我们实现一个Native方法时不必担心局部引用的释放问题，函数在被调用完成后，JVM会自动释放函数中所创建的所有局部引用。尽管如此，为避免内存泄漏，某些情况下，我们应该手动释放局部引用。

  • JNI会将创建的局部引用都存储在一个局部引用表中，如果这个表超过了最大容量限制，就会造成局部引用表溢出，使程序崩溃。经测试，Android上的JNI局部引用表最大数量是512个。当我们在实现一个本地方法时，可能需要创建大量的局部引用，如果没有及时释放，就有可能导致JNI局部引用表的溢出，所以，在不需要局部引用时就立即调用DeleteLocalRef手动删除。比如，在下面的代码中，本地代码遍历一个特别大的字符串数组，每遍历一个元素，都会创建一个局部引用，当对使用完这个元素的局部引用时，就应该马上手动释放它。

    for (i = 0; i < len; i++) {
        jstring jstr = (*env)->GetObjectArrayElement(env, arr, i);
        ... /* 使用jstr */
         (*env)->DeleteLocalRef(env, jstr); // 使用完成之后马上释放
    }
    

  • 在编写JNI工具函数时，工具函数在程序当中是公用的，被谁调用你是不知道的。上面newString这个函数演示了怎么样在工具函数中使用完局部引用后，调用DeleteLocalRef删除。不这样做的话，每次调用newString之后，都会遗留两个引用占用空间（elemArray和cls_string，cls_string不用static缓存的情况下）。

  • 如果你的本地函数不会返回。比如一个接收消息的函数，里面有一个死循环，用于等待别人发送消息过来while(true) { if (有新的消息) ｛ 处理之。。。。｝ else { 等待新的消息。。。}}。如果在消息循环当中创建的引用你不显示删除，很快将会造成JVM局部引用表溢出。

  • 局部引用会阻止所引用的对象被GC回收。比如你写的一个本地函数中刚开始需要访问一个大对象，因此一开始就创建了一个对这个对象的引用，但在函数返回前会有一个大量的非常复杂的计算过程，而在这个计算过程当中是不需要前面创建的那个大对象的引用的。但是，在计算的过程当中，如果这个大对象的引用还没有被释放的话，会阻止GC回收这个对象，内存一直占用者，造成资源的浪费。所以这种情况下，在进行复杂计算之前就应该把引用给释放了，以免不必要的资源浪费。

    /* 假如这是一个本地方法实现 */
    JNIEXPORT void JNICALL Java_pkg_Cls_func(JNIEnv *env, jobject this)
    {
       lref = ...              /* lref引用的是一个大的Java对象 */
       ...                     /* 在这里已经处理完业务逻辑后，这个对象已经使用完了 */
       (*env)->DeleteLocalRef(env, lref); /* 及时删除这个对这个大对象的引用，GC就可以对它回收，并释放相应的资源*/
       lengthyComputation();   /* 在里有个比较耗时的计算过程 */
       return;                 /* 计算完成之后，函数返回之前所有引用都已经释放 */
    }
    

• 管理局部引用

  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_org_professor_jni_bean_Person_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 (local_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;
}

当我们的本地代码不再需要一个全局引用时，应该马上调用DeleteGlobalRef来释放它。如果不手动调用这个函数，即使这个对象已经没用了，JVM也不会回收这个全局引用所指向的对象。

弱全局引用

弱全局引用使用NewGlobalWeakRef创建，使用``DeleteGlobalWeakRef```释放。与全局引用类似，弱引用可以跨方法、线程使用。但与全局引用很重要不同的一点是，弱引用不会阻止GC回收它引用的对象。在newString这个函数中，我们也可以使用弱引用来存储String的Class引用，因为java.lang.String这个类是系统类，永远不会被GC回收。当本地代码中缓存的引用不一定要阻止GC回收它所指向的对象时，弱引用就是一个最好的选择。假设，一个本地方法org.professor.jni.MainActivity.testWeakRef需要缓存一个指向类org.professor.jni.bean.Student的引用，如果在弱引用中缓存的话，仍然允许类org.professor.jni.bean.Student这个类被unload，因为弱引用不会阻止GC回收所引用的对象。请看下面的代码段：

JNIEXPORT void JNICALL
Java_org_professor_jni_MainActivity_testWeakRef(JNIEnv *env, jobject self) {
    static jclass clazz = NULL;
    if (clazz == NULL) {
        jclass clazzLocal = (*env)->FindClass(env, "org/professor/jni/bean/Student");
        if (NULL == clazzLocal) {
            return;
        }
        clazz = (*env)->NewWeakGlobalRef(env, clazzLocal);
        if (NULL == clazz) {
            return; /* 内存溢出 */
        }
    }
    //省略代码... 
    /* 使用Student的引用 */
}

我们假设当前类和Student有相同的生命周期（例如，他们可能被相同的类加载器加载），因为弱引用的存在，我们不必担心当前类和它所在的本地代码在被使用时，Student这个类出现先被unload，后来又会preload的情况。当然，如果真的发生这种情况时（当前类和Student此时的生命周期不同），我们在使用弱引用时，必须先检查缓存过的弱引用是指向活动的类对象，还是指向一个已经被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，g_obj_ref仍然指向一个活动对象，会返回JNI_FALSE。

当我们的本地代码不再需要一个弱全局引用时，也应该调用DeleteWeakGlobalRef来释放它，如果不手动调用这个函数来释放所指向的对象，JVM仍会回收弱引用所指向的对象，但弱引用本身在引用表中所占的内存永远也不会被回收。

引用规则

前面对三种引用已做了一个全面的介绍，下面来总结一下引用的管理规则和使用时的一些注意事项，使用好引用的目的就是为了减少内存使用和对象被引用保持而不能释放，造成内存浪费。所以在开发当中要特别小心！

• 直接实现Java层声明的native函数的本地代码 当编写这类本地代码时，要当心不要造成全局引用和弱引用的累加，因为本地方法执行完毕后，这两种引用不会被自动释放。

• 被用在任何环境下的工具函数。例如：方法调用、属性访问和异常处理的工具函数等。

  编写工具函数的本地代码时，要当心不要在函数的调用轨迹上遗漏任何的局部引用，因为工具函数被调用的场合和次数是不确定的，一量被大量调用，就很有可能造成内存溢出。所以在编写工具函数时，请遵守下面的规则：

  • 一个返回值为基本类型的工具函数被调用时，它决不能造成局部、全局、弱全局引用被回收的累加

  • 当一个返回值为引用类型的工具函数被调用时，它除了返回的引用以外，它决不能造成其它局部、全局、弱引用的累加

  对于工具函数来说，为了使用缓存技术而创建一些全局引用或者弱全局引用是正常的。如果一个工具函数返回的是一个引用，我们应该写好注释详细说明返回引用的类型，以便于使用者更好的管理它们。下面的代码中，频繁地调用工具函数GetInfoString，我们需要知道GetInfoString返回引用的类型是什么，以便于每次使用完成后调用相应的JNI函数来释放掉它。

  while (JNI_TRUE) {
      jstring infoString = GetInfoString(info);
      ... /* 处理infoString */
      ??? /* 使用完成之后，调用DeleteLocalRef、DeleteGlobalRef、DeleteWeakGlobalRef哪一个函数来释放这个引用呢？*/
  }
  

  函数NewLocalRef有时被用来确保一个工具函数返回一个局部引用。我们改造一下newString这个函数，演示一下这个函数的用法。下面的newString是把一个被频繁调用的字符串“CommonString”缓存在了全局引用里：

  JNIEXPORT jstring JNICALL
  Java_org_professor_jni_bean_Person_WeakRef(JNIEnv *env, jobject self, jcharArray j_char_arr,
                                         jint len) {
       static jstring result;
      /* 使用wstrncmp函数比较两个Unicode字符串 */
      //省略部分代码
      if (strncmp("CommonString", char_arr, len) == 0) {
          /* 将"CommonString"这个字符串缓存到全局引用中 */
          static jstring cachedString = NULL;
          if (cachedString == NULL) {
              /* 先创建"CommonString"这个字符串 */
              jstring cachedStringLocal = /*...*/;
              /* 然后将这个字符串缓存到全局引用中 */
              cachedString = (*env)->NewGlobalRef(env, cachedStringLocal);
          }
          // 基于全局引用创建一个局引用返回，也同样会阻止GC回收所引用的这个对象，因为它们指向的是同一个对象
          return (*env)->NewLocalRef(env, cachedString);
      }
      //...
      return result;
  }
  

  在管理局部引用的生命周期中，Push/PopLocalFrame是非常方便且安全的。我们可以在本地函数的入口处调用PushLocalFrame，然后在出口处调用PopLocalFrame，这样的话，在函数内任何位置创建的局部引用都会被释放。而且，这两个函数是非常高效的，强烈建议使用它们。需要注意的是，如果在函数的入口处调用了PushLocalFrame，记住要在函数所有出口（有return语句出现的地方）都要调用PopLocalFrame。在下面的代码中，对PushLocalFrame的调用只有一次，但调用PopLocalFrame确有多次，当然你也可以使用goto语句来统一处理。

  jobject fun(JNIEnv *env, ...) {
      jobject result;
      if ((*env)->PushLocalFrame(env, 10) < 0) {
          /* 调用PushLocalFrame获取10个局部引用失败，不需要调用PopLocalFrame */
          return NULL;
      }
      //...
      result = ...; // 创建局部引用result
      if (...)
      {
          /* 返回前先弹出栈顶的frame */
          result = (*env)->PopLocalFrame(env, result);
          return result;
      }
      ...
      result = (*env)->PopLocalFrame(env, result);
      /* 正常返回 */
      return result;
  }
  

  上面的代码同样演示了函数PopLocalFrame的第二个参数的用法，局部引用result一开始在PushLocalFrame创建在当前frame里面，而把result传入PopLocalFrame中时，PopLocalFrame在弹出当前的frame前，会由result生成一个新的局部引用，再将这个新生成的局部引用存储在上一个frame当中。

相关：

• xyang0917-JNI/NDK开发指南（十）引用