JNI备忘

以下摘自IBM网络教程，特此说明。

概述	第 1 页（共13 页）

从 Java 程序内调用本机代码破坏了 Java 程序的可移植性和安全性。尽管已编译的 Java 字节码保持了很好的可移植性，但必须为您打算用来运行该应用程序的每个平台重新编译本机代码。另外，由于本机代码在 JVM 之外执行，所以约束它的安全性协议不必和 Java 代码的相同。

从本机程序调用 Java 代码也很复杂。因为 Java 语言是面向对象的，所以从本机应用程序调用 Java 代码通常涉及面向对象技术。有些本机语言不支持面向对象编程或只是有限地支持面向对象编程（譬如 C），使用这些语言调用 Java 方法可能会产生问题。在本节中，我们将讨论使用 JNI 所带来的若干复杂性，并研究解决它们的方法。

Java 字符串 vs. C 字符串

第 2 页（共13 页）

Java 字符串是作为 16 位 Unicode 字符存储的，而 C 字符串是作为一组 8 位且以空字符为结束的字符存储的。JNI 提供了几个有用的函数，它们用于在 Java 字符串和 C 字符串之间进行转换并操作这两种字符串。下面的代码片段演示了如何将 C 字符串转换成 Java 字符串：

 1. /* Convert a C string to a Java String. */
 2. char[]  str  = "To be or not to be.\n";
 3. jstring jstr = (*env)->NewStringUTF(env, str);

接下来，我们研究将 Java 字符串转换成 C 字符串的代码。请注意第 5 行对 ReleaseStringUTFChars() 函数的调用。当您不再使用 Java 字符串时，应该使用这个函数来释放它们。当本机代码不再需要引用字符串时，请总是确保释放它们。不这样做可能导致内存泄漏。

 1. /* Convert a Java String into a C string. */
 2. char buf[128; 
 3. const char *newString = (*env)->GetStringUTFChars(env, jstr, 0);
 4. ...
 5. (*env)->ReleaseStringUTFChars(env, jstr, newString);

Java 数组 vs. C 数组

第 3 页（共13 页）

与字符串类似，Java 数组和 C 数组在内存中的表示不同。幸运的是，一组 JNI 函数可以提供指向数组中元素的指针。下图显示了如何将 Java 数组映射到 JNI C 类型。

局部引用 vs. 全局引用

第 5 页（共13 页）

当使用 JNI 编程时，会需要使用对 Java 对象的引用。缺省情况下，JNI 创建局部引用以确保它们可以被垃圾收集。由于这一点，您可能会因为尝试存储一个本地引用，以便稍后重用它而无意间编写出非法代码，如下面的代码样本所示：

 1. /* This code is invalid! */
 2. static jmethodID mid;
 3. 
 4. JNIEXPORT jstring JNICALL
 5. Java_Sample1_accessMethod(JNIEnv *env, jobject obj)
 6. {
 7.    ...
 8.	 cls = (*env)->GetObjectClass(env, obj);
 9.    if (cls != 0)
10.       mid = (*env)->GetStaticMethodID(env, cls, "addInt", "(I)I");
11.    ...
12. }

因为第 10 行的错误，所以这个代码段是非法的。mid 是 methodID，并且 GetStaticMethodID() 返回methodID。但是，返回的methodID 是一个局部引用，而您不应该将一个局部引用赋给全局引用。而 mid 是一个全局引用。

在 Java_Sample1_accessMethod() 返回之后，mid 引用就不再有效，因为赋给它现在超出作用域以外的局部引用。尝试使用mid 将导致错误结果或 JVM 崩溃。

创建全局引用

第 6 页（共13 页）

要纠正这个问题，需要创建和使用全局引用。全局引用将在显式释放之前一直有效，您必须记住去显式地释放它。没有释放引用可能导致内存泄漏。

使用 NewGlobalRef() 创建全局引用，并用 DeleteGlobalRef() 删除它，如下面的代码样本所示：

 1. /* This code is valid! */
 2. static jmethodID mid;
 3. 
 4. JNIEXPORT jstring JNICALL
 5. Java_Sample1_accessMethod(JNIEnv *env, jobject obj)
 6. {
 7.    ...
 8.	 cls = (*env)->GetObjectClass(env, obj);
 9.    if (cls != 0)
10.    {
11.       mid1 = (*env)->GetStaticMethodID(env, cls, "addInt", "(I)I");
12.       mid = (*env)->NewGlobalRef(env, mid1);
13.    ...
14. }

错误处理	第 7 页（共13 页）

在 Java 程序中使用本机方法，就以某种基本的方式破坏了 Java 安全性模型。因为 Java 程序在一个受控的运行时系统（JVM）中运行，所以 Java 平台设计师决定通过检查常见运行时系统错误（如数组下标、越界错误、空指针错误）来帮助程序员。从另一方面讲，由于 C 和 C++ 不使用此类错误检查，所以本机方法程序员必须自己处理所有错误情况，而在运行时，这些错误可以在 JVM 中被捕获。

例如，对于 Java 程序而言，通过抛出一个异常来向 JVM 报告出错是常见和正确的操作。C 没有异常，因此必须使用 JNI 的异常处理函数。

JNI 的异常处理函数

第 8 页（共13 页）

有两种方法用来在本机代码中抛出异常：可以调用 Throw() 函数或 ThrowNew() 函数。在调用Throw() 之前，首先需要创建一个Throwable 类型的对象。可以通过调用 ThrowNew() 跳过这一步，因为这个函数为您创建了该对象。在下面的示例代码片段中，我们使用这两个函数抛出IOException：

 1. /* Create the Throwable object. */
 2. jclass cls = (*env)->FindClass(env, "java/io/IOException");
 3. jmethodID mid = (*env)->GetMethodID(env, cls, "<init>", "()V");
 4. jthrowable e = (*env)->NewObject(env, cls, mid);
 5. 
 6. /* Now throw the exception */
 7. (*env)->Throw(env, e);
 8. ...
 9. 
10. /* Here we do it all in one step and provide a message*/
11. (*env)->ThrowNew(env,
12.                  (*env)->FindClass("java/io/IOException"),
13.                  "An IOException occurred!");

Throw() 和 ThrowNew() 函数并不中断本机方法中的控制流。直到本机方法返回，在 JVM 中才会将异常实际抛出。在 C 中，一旦碰到错误条件，不能使用Throw() 和ThrowNew() 函数立即退出方法，而在 Java 中，这可以使用 throw 语句来退出方法。相反，需要在Throw() 和ThrowNew() 函数之后立即使用 return 语句，以便在出错点退出本机方法。

JNI 的异常捕获函数

第 9 页（共13 页）

当从 C 或 C++ 调用 Java 时，也可能需要捕获异常。许多 JNI 函数都能抛出希望捕获的异常。ExceptionCheck() 函数返回jboolean 以表明是否抛出了异常，而ExceptionOccured() 方法返回指向当前异常的 jthrowable 引用（或者返回 NULL，如果未抛出异常的话）。

如果正在捕获异常，可能要处理异常，在这种情况下需要在 JVM 中清除该异常。可以使用 ExceptionClear() 函数来进行这个操作。ExceptionDescribed() 函数用来显示异常的调试消息。

本机方法中的多线程

第 10 页（共13 页）

在使用 JNI 工作时，您将遇到的更高级的问题之一是在本机方法中使用多线程。即使是在不需要支持多线程的系统上运行时，Java 平台也是作为多线程系统来实现的；因此您有责任确保本机函数是线程安全的。

在 Java 程序中，可以通过使用 synchronized 语句实现线程安全的代码。synchronized 语句的语法使您能够获取对象上的锁。只要在synchronized 块中，就可以执行任何数据操作，而不必担心其它线程会悄悄进入并访问您锁定的对象。

JNI 使用 MonitorEnter() 和 MonitorExit() 函数提供类似的结构。对于传递到MonitorEnter() 函数中的对象，您会得到一个用于该对象的监视器（锁），并在使用MonitorExit() 函数释放它之前一直持有该锁。对于您锁定的对象而言，MonitorEnter() 和MonitorExit() 函数之间的所有代码保证是线程安全的。

本机方法中的同步

第 11 页（共13 页）

下表显示了如何在 Java、C 和 C++ 中同步一块代码。正如您所见，这些 C 和 C++ 函数类似于 Java 代码中的 synchronized 语句。

随本机方法一起使用synchronized

第 12 页（共13 页）

确保本机方法同步的另一种方法是：当在 Java 类中声明 native 方法时使用 synchronized 关键字。

使用 synchronized 关键字将确保任何时候从 Java 程序调用 native 方法，它都将是synchronized。尽管用synchronized 关键字来标记线程安全的本机方法是个好想法，但通常最好总是在本机方法实现中实现同步。这样做的主要原因如下：

• C 或 C++ 代码和 Java 本机方法声明不同，因此，如果方法声明有变动（即，如果一旦除去了 synchronized 关键字），此方法可能马上不再是线程安全的了。
  
  
• 如果有人对使用该函数的其它本机方法（或其它 C 或 C++ 函数）进行编码，他们可能并没有意识到该本机实现不是线程安全的。
  
  
• 如果将函数作为普通的 C 函数在 Java 程序之外使用，则它不是线程安全的。

其它同步技术

第 13 页（共13 页）

Object.wait()、Object.notify() 和 Object.notifyAll() 方法也支持线程同步。因为所有 Java 对象都将Object 类作为父类，所以所有 Java 对象都有这些方法。您可以象调用其它方法一样，从本机代码调用这些方法，并以 Java 代码中相同的方式来使用它们，以实现线程同步。