大多数JNI函数创建局部引用,例如,NewObject函数创建一个新的对象实例并返回指向这个实例的一个局部引用。
一个局部引用仅在创建它的Native方法以及调用这个Native方法的上下文中才是有效的。在函数执行过程中创建的所有的局部引用都会在函数返回之后被释放。
请不要使用静态变量缓存一个局部引用留作以后使用,如下示例,是一个局部引用使用的错误示例:
~~~
/* This code is illegal */
jstring MyNewString(JNIEnv *env, jchar *chars, jint len) {
static jclass stringClass;
jmethodID cid;
jcharArray elemArr;
jstring result;
if(!stringClass) {
stringClass = (*env)->FindClass(env, "java/lang/String");
if(!stringClass){
return 0; /* exception thrown */
}
}
/* It is wrong to use the cached stringClass here'
* because it may be invalid. */
cid = (*env)->GetMethodID(env, stringClass, "<init>", "([C)V");
if(!cid) {
return 0; /* exception thrown */
}
/* Create a char[] that holds the string characters */
elemArr = (*env)->NewCharArray(env, len);
if(!elemArr) {
return 0; /* exception thrown */
}
(*env)->SetCharArrayRegion(env, elemArr, 0, len, chars);
/* Construct a java.lang.String */
result = (*env)->NewObject(env, stringClass, cid, elemArr);
/* Free local references */
(*env)->DeleteLocalRef(env, elemArr);
return result;
}
~~~
如上例,代码中以静态变量的形式缓存了stringClass,并希望借此减少多次执行FindClass带来的开销。
不幸的是,这种做法是错误的,因为FindClass返回了指向一个java.lang.String类的对象的局部引用。为了说明为什么这么做存在问题,假设上边的MyNewString被另一个函数C.f调用:
~~~
JNIEXPORT jstring JNICALL Java_C_f(JNIEnv* env, jobject this){
char *c_str = ...;
...
return MyNewString(c_str);
}
~~~
在C.f返回之后,虚拟机释放了Java_C_f执行过程中创建的所有局部引用。这些被释放的局部引用包括函数MyNewString中用静态变量缓存的stringClass变量。当下一次MyNewString被调用的时候,就会触发访问一个非法的局部引用,并进一步导致内存异常或者系统崩溃。如下例子,连续两次调用C.f函数就会让MyNewString触发非法局部引用访问。
有两种方式让一个局部引用失效。第一种是上边介绍过的,虚拟机会在一个Native函数返回之后释放所有在该函数执行期间创建的局部引用,另一种方式,开发者可以显式使用DeleteLocalRef这样的JNI函数手动管理局部引用的声明周期。
你一定会提出一个问题,既然虚拟机会自动释放局部引用,那么什么时候需要开发者手动释放局部引用呢?我们知道,在局部引用无效之前,它都会阻止所引用的真实资源被释放。
局部引用仅仅在创建它的线程中是有效的。在线程A中被创建的局部引用是不能够在线程B中被使用的。千万不要将一个局部引用保存在全局变量中给其他线程使用!
- JNI编程指南翻译
- 第一部分:介绍与入门
- 介绍
- Java平台与宿主环境
- JNI的角色
- 使用JNI的潜在风险
- 什么时候应该使用JNI
- JNI的进化
- 示例程序
- 入门
- 概览
- 声明一个Native方法
- 编译HelloWorld类
- 创建Native方法头文件
- 实现Native方法
- 编译C源码并创建一个Native库
- 执行程序
- 第二部分:编程指南
- 基础类型, Strings, Arrays
- 一个简单的Native方法
- Native方法实现的C语言原型
- Native方法的参数
- 类型映射
- 访问Strings
- 转换成为Native Strings
- 释放Native Strings资源
- 创建新的Strings
- String相关的其他JNI函数
- Java SDK2 中的新的String相关的JNI方法
- JNI String函数总结
- 在String函数中选择
- 访问Arrays
- 在C语言中操作数组
- 访问基础类型的数组
- JNI基础类型数组操作函数总结
- 如何在基础类型数组函数中做选择
- 访问对象数组
- 属性和方法
- 访问属性
- 如何访问一个对象实例的属性
- 属性描述符
- 访问静态属性
- 调用方法
- 调用对象实例方法
- 获取方法描述符
- 调用静态方法
- 调用对象的基类方法
- 调用构造函数
- 缓存属性和方法ID
- 在使用时缓存
- 在类初始化的时候缓存
- 两种ID缓存方式的对比
- JNI属性和方法操作的性能
- 局部和全局引用
- 局部和全局引用说明
- 局部引用
- 全局引用
- 弱全局引用
- 引用的比较
- 引用资源的释放
- 释放局部引用
- JDK2中的局部引用管理
- 释放全局引用
- 管理引用的原则
- 异常
- 概览
- 在Native代码中捕获与抛出异常
- 工具函数
- 异常处理最佳实践
- 异常检查
- 异常处理
- 工具函数中的异常
- The Invocation Interface
- 创建Java虚拟机
- 链接ava虚拟机到Native应用程序
- 链接某个确定的虚拟机实现
- 链接未知虚拟机
- 绑定Native线程
- 一些JNI特性
- JNI与线程
- 约束
- 监视进入与退出
- 监视等待和通知
- 如何从当前Context中获取JNIEnv的指针
- 匹配线程模型
- 编写国际化代码
- 注册Native方法
- 加载与卸载时机
- 加载时机
- 卸载时机
- 反射的支持
- 使用C++实现JNI
- 改变现有的Native库
- 一对一映射关系
- 共享桩
- 一对一映射VS共享桩
- 共享桩的实现
- Peer类
- Java平台中的Peer类
- 释放Native数据结构
- Peer类背后的指针
- 缺陷与陷阱
- 错误检查
- 向JNI函数传递非法参数
- jclass与jobject的困惑
- jboolean类型参数的截断机制
- Java应用与Native代码之间的边界
- ID与引用的困惑
- 缓存属性和方法ID
- 终结Unicode 字符串
- Violating访问控制原则
- 无视国际化
- 保持虚拟机资源
- 被滥用的局部引用创建
- 跨线程使用JNIEnv
- 错误使用的线程模型
- 第三部分:详细说明
- JNI设计概览
- 设计目标
- 加载Native库
- 类加载器
- 类加载器与Native库
- 加载Native库
- 类型安全限制
- 卸载Native库
- 链接Native方法
- 调用转换
- JNIEnv接口指针
- JNIEnv接口指针的组织
- 接口指针的好处
- 传递数据
- 全局和局部引用
- 局部引用的实现
- 弱全局引用
- 访问对象
- 访问原始数组
- 属性和方法
- 错误和异常
- 如果没有对编码错误的检查
- Java虚拟机异常
- 异步异常
- JNI类型
- 原始类型和引用类型
- 原始类型
- 引用类型
- jvalue类型
- 属性和方法ID
- 字符串格式
- UTF-8字符串
- 类描述符
- 属性描述符
- 方法描述符
- 常量
- JNI函数
- JNI函数总结
- 直接导出调用的接口函数
- Java虚拟机接口
- 在Native库中定义的函数
- JNIEnv接口
- JNI函数使用规范