简述
- 写 JNI 代码时，需要时刻考虑每一个 JNI函数 可能抛出的异常。
- 在原生代码中，一旦发生异常，需要马上处理。
简单示例
public class CatchThrow {
static {
System.loadLibrary("CatchThrow");
}
public static void main(String args[]) {
CatchThrow c = new CatchThrow();
try {
c.doit();
} catch (Exception e) {
System.out.println("In Java:\n\t" + e);
}
}
private native void doit() throws IllegalArgumentException;
private void callback() throws NullPointerException {
throw new NullPointerException("CatchThrow.callback");
}
}
JNIEXPORT void JNICALL Java_CatchThrow_doit(JNIEnv * env, jobject obj) {
jclass cls = (* env)->GetObjectClass(env, obj);
jmethodID mid = (* env)->GetMethodID(env, cls, "callback", "()V");
if (mid == NULL) {
return;
}
// 注意此调用会抛出异常
(* env)->CallVoidMethod(env, obj, mid);
// 尝试获取已抛出的异常
jthrowable exc = (* env)->ExceptionOccurred(env);
// 通过此处的判断，检查是否真的抛出了异常
if (exc) {
// 输出异常描述
(* env)->ExceptionDescribe(env);
// 清除异常
(* env)->ExceptionClear(env);
// 创建新的异常
jclass newExcCls = (* env)->FindClass(env, "java/lang/IllegalArgumentException");
if (newExcCls == NULL) {
return;
}
// 抛出新的异常取代旧的异常
(* env)->ThrowNew(env, newExcCls, "thrown from C code");
}
}
示例解说
- 示例演示了如何声明一个可能抛出异常的 原生方法 。
- 在原生代码中，通过
ThrowNew()抛出异常时，不会马上中断执行流程。若在 Java 代码中抛出异常则会马上中断执行流程，转到最近的try/catch块执行代码。
函数解说
-
ExceptionOccurred()：若有异常，则返回一个jthrowable对象，否则返回NULL。
-
ExceptionCheck()：若有异常，则返回JNI_TRUE，否则返回JNI_FALSE。
-
ExceptionDescribe()：若有异常，输出异常描述，相当于 Java 代码中的Exception.printStackTrace()。
-
ExceptionClear()：清除队列中的异常，后续代码不会在获取到。
-
ThrowNew()：抛出异常。
异常检查
第一种
简介
- 大多数 JNI函数 会直接通过返回值（如返回
NULL）来说明是否遇到了错误，同时也暗示了此线程的队列中有待处理的异常。
简单示例
public class Window {
static native void initIDs();
static {
initIDs();
}
long handle;
int length;
int width;
}
jfieldID FID_Window_handle;
jfieldID FID_Window_length;
jfieldID FID_Window_width;
JNIEXPORT void JNICALL Java_Window_initIDs(JNIEnv * env, jclass classWindow) {
// 即便可以确保Window类中有这些字段，也必须要检查，因为仍然可能会因为内存不足而失败
FID_Window_handle = (* env)->GetFieldID(env, classWindow, "handle", "J");
if (FID_Window_handle == NULL) {
return;
}
FID_Window_length = (* env)->GetFieldID(env, classWindow, "length", "I");
if (FID_Window_length == NULL) {
return;
}
FID_Window_width = (* env)->GetFieldID(env, classWindow, "width", "I");
// 此处没有检测的必要，无论成功与否都是直接return
}
第二种
简介
- 有些 JNI函数 的返回值无法表明错误是否发生，因为这类 JNI函数 的返回值可能另作他用，如
CallIntMethod()，此时可以通过ExceptionOccurred()或ExceptionCheck()来检测。
简单示例
public class Fraction {
public int floor() {
return (int) Math.floor((double) over / under);
}
int over, under;
}
void Java_Fraction_floor(JNIEnv * env, jobject fraction) {
// ...
jint floor = (* env)->CallIntMethod(env, fraction, MID_Fraction_floor);
// 检查是否有异常
if ((* env)->ExceptionCheck(env)) {
// 处理异常
return;
}
// ...
}
异常处理
- 有两种处理异常的方法：
- 立即返回，让异常传递至 Java 代码。
- 使用
ExceptionClear()清除异常，然后处理异常
- 在调用一些 JNI函数 前，检查、处理、清理异常很重要。
- 大部分 JNI函数 在队列中有待处理异常时，调用会导致一些无法预料的错误，另一小部分 JNI函数 之所以能在这种情况下调用是因为这些函数为了处理异常而设计的。
- 通常很有必要在发生异常的时候清理资源。
JNIEXPORT void JNICALL Java_pkg_Cls_f(JNIEnv * env, jclass cls, jstring jstr) {
const jchar * cstr = (* env)->GetStringChars(env, jstr);
if (c_str == NULL) {
return;
}
// ...
if (/* ... */) {
// 发生异常，释放资源
(* env)->ReleaseStringChars(env, jstr, cstr);
return;
}
// 函数结束时，释放资源
(* env)->ReleaseStringChars(env, jstr, cstr);
}
效用函数里的异常
- 对于 效用函数 里的异常，应该要确保异常能够传播到 原生函数 调用者中。
- 通常情况下， 效用函数 应该提供一个特殊的返回值来表明异常在 效用函数 里发生了。
- 应该在 效用函数 的异常处理代码中，处理好 局部引用 。
相关工具函数
用于便捷抛出异常
// name是异常的类型描述符，msg是抛出异常时需要输出的信息
void JNU_ThrowByName(JNIEnv * env, const char * name, const char * msg) {
// 此处若FindClass失败，会抛出NoClassDefFoundError异常
jclass cls = (* env)->FindClass(env, name);
if (cls != NULL) {
(* env)->ThrowNew(env, cls, msg);
}
// 若cls是NULL，DeleteLocalRef不会执行任何操作
(* env)->DeleteLocalRef(env, cls);
}
通用调用函数
代码
// 参数说明：
// hasException：用来接收异常是否抛出的信息，若非NULL，则代表着调用者关心是否有异常抛出
// obj：方法所属的对象
// name：方法名字
// descriptor：方法描述符
jvalue
JNU_CallMethodByName(JNIEnv * env, jboolean * hasException, jobject obj, const char * name, const char * descriptor,
...) {
va_list args;
// 联合体
jvalue result = NULL;
if ((* env)->EnsureLocalCapacity(env, 2) == JNI_OK) {
jclass clazz = (* env)->GetObjectClass(env, obj);
jmethodID mid = (* env)->GetMethodID(env, clazz, name, descriptor);
if (mid) {
const char * p = descriptor;
while (* p != ')') p++;
p++;
va_start(args, descriptor);
switch (* p) {
case 'V':
(* env)->CallVoidMethodV(env, obj, mid, args);
break;
case '[':
case 'L':
// result任意一个字段被初始化，都代表着有错误发生
result.l = (* env)->CallObjectMethodV(env, obj, mid, args);
break;
case 'Z':
result.z = (* env)->CallBooleanMethodV(env, obj, mid, args);
break;
case 'B':
result.b = (* env)->CallByteMethodV(env, obj, mid, args);
break;
case 'C':
result.c = (* env)->CallCharMethodV(env, obj, mid, args);
break;
case 'S':
result.s = (* env)->CallShortMethodV(env, obj, mid, args);
break;
case 'I':
result.i = (* env)->CallIntMethodV(env, obj, mid, args);
break;
case 'J':
result.j = (* env)->CallLongMethodV(env, obj, mid, args);
break;
case 'F':
result.f = (* env)->CallFloatMethodV(env, obj, mid, args);
break;
case 'D':
result.d = (* env)->CallDoubleMethodV(env, obj, mid, args);
break;
default:
(* env)->FatalError(env, "illegal descriptor");
}
va_end(args);
}
(* env)->DeleteLocalRef(env, clazz);
}
// 若调用者关心是否有异常抛出，则检查是否有异常抛出
if (hasException) {
* hasException = (* env)->ExceptionCheck(env);
}
// // JDK release 1.1版本
// if (hasException) {
// jthrowable exc = (* env)->ExceptionOccurred(env);
// * hasException = (jboolean) (exc != NULL);
// (* env)->DeleteLocalRef(env, exc);
// }
return result;
}
使用例子
JNIEXPORT void JNICALL Java_InstanceMethodCall_nativeMethod(JNIEnv * env, jobject obj) {
printf("In C\n");
JNU_CallMethodByName(env, NULL, obj, "callback", "()V");
// 这里之所以不检查错误是因为无论是否发生错误，都会直接return
}
