用JNI进行Java编程

关于本教程

本教程是关于什么的？

Java 本机接口（Java Native Interface (JNI)）是一个本机编程接口，它是 Java 软件开发工具箱（Java Software Development Kit (SDK)）的一部分。JNI 允许 Java 代码使用以其它语言（譬如 C 和 C++）编写的代码和代码库。Invocation API（JNI 的一部分）可以用来将 Java 虚拟机（JVM）嵌入到本机应用程序中，从而允许程序员从本机代码内部调用 Java 代码。

本教程涉及 JNI 最常见的两个应用：从 Java 程序调用 C/C++，以及从 C/C++ 程序调用 Java 代码。我们将讨论 Java 本机接口的这两个基本部分以及可能出现的一些更高级的编程难题。

我应该学习本教程吗？

本教程将带您去了解使用 Java 本机接口的所有步骤。您将学习如何从 Java 应用程序内部调用本机 C/C++ 代码以及如何从本机 C/C++ 应用程序内部调用 Java 代码。

所有示例都是使用 Java、C 和 C++ 代码编写的，并可以移植到 Windows 和基于 UNIX 的平台上。要完全理解这些示例，您必须有一些 Java 语言编程经验。此外，您还需要一些 C 或 C++ 编程经验。严格来说，JNI 解决方案可以分成 Java 编程任务和 C/C++ 编程任务，由不同的程序员完成每项任务。然而，要完全理解 JNI 是如何在两种编程环境中工作的，您必须能够理解 Java 和 C/C++ 代码。

我们还将讲述一些高级主题，包括本机方法的异常处理和多线程。要充分理解本教程，您应该熟悉 Java 平台的安全性模型，并有一些多线程应用程序开发的经验。

这里将关于高级主题的节从较基本的循序渐进 JNI 简介中划分出来。现在，初级 Java 程序员可以先学习本教程的前两部分，掌握之后再开始学习高级主题。

请参阅参考资料，那里有关于本文所提到的教程、文章和其它一些参考书目的清单。

工具与组件

要运行本教程中的示例，您需要下列工具与组件：

• Java 编译器：随 SDK 一起提供的 javac.exe。

• Java 虚拟机（JVM）：随 SDK 一起提供的 java.exe。

• 本机方法 C 文件生成器：随 SDK 一起提供的 javah.exe。

• 定义 JNI 的库文件和本机头文件。jni.h C 头文件、jvm.lib 和 jvm.dll 或 jvm.so 文件，这些文件都是随 SDK 一起提供的。

• 能够创建共享库的 C 和 C++ 编译器。最常见的两个 C 编译器是用于 Windows 的 Visual C++ 和用于基于 UNIX 系统的 cc。

虽然您可以使用自己喜欢的任何开发环境，但我们将在本教程中使用示例是用随 SDK 一起提供的标准工具和组件编写的。请参阅参考资料来下载 SDK、完整的源文件以及对于完成本教程不可缺少的其它工具。本教程具体地解释了 Sun 的 JNI 实现，该实现被认为是 JNI 解决方案的标准。本教程中没有讨论其它 JNI 实现的详细信息。

其它注意事项

在 Java 2 SDK 中，JVM 和运行时支持位于名为 jvm.dll（Windows）或 libjvm.so（UNIX）的共享库文件中。在 Java 1.1 JDK 中，JVM 和运行时支持位于名为 javai.dll（Windows）或 libjava.so（UNIX）的共享库文件中。版本 1.1 的共享库包含运行时以及类库的一些本机方法，但在版本 1.2 中已经不包含运行时，并且本机方法被放在 java.dll 和 libjava.so 中。对于以下 Java 代码，这一变化很重要：

• 代码是用非 JNI 本机方法编写的（因为使用了 JDK 1.0 中旧的本机方法接口）

• 通过 JNI Invocation 接口使用了嵌入式 JVM

在两种情况下，在您的本机库能与版本 1.2 一起使用之前，都必须重新链接它们。注：这个变化应该不影响 JNI 程序员实现本机方法 — 只有通过 Invocation API调用 JVM 的 JNI 代码才会受到影响。

如果使用随 SDK/JDK 一起提供的 jni.h 文件，则头文件将使用 SDK/JDK 安装目录中的缺省 JVM（jvm.dll 或 libjvm.so）。支持 JNI 的 Java 平台的任何实现都会这么做，或允许您指定 JVM 共享库；然而，完成这方面操作的细节可能会因具体 Java 平台／JVM 实现而有所不同。实际上，许多 JVM 实现根本不支持 JNI。

关于作者

Scott Stricker 是 IBM Global Services 下属的 Business Innovation Services 的企业应用程序开发人员。他的专长是面向对象技术，尤其是 Java 和 C++ 编程。

Scott 拥有美国辛辛那提大学计算机科学理学学士学位。他是“Sun 认证的 Java 2 程序员与开发者（Sun Certified Java 2 Programmer and Developer）”。可通过 sstricke@us.ibm.com 联系 Scott。

从Java调用C++代码

概述

当无法用 Java 语言编写整个应用程序时，JNI 允许您使用本机代码。在下列典型情况下，您可能决定使用本机代码：

• 希望用更低级、更快的编程语言去实现对时间有严格要求的代码。

• 希望从 Java 程序访问旧代码或代码库。

• 需要标准 Java 类库中不支持的依赖于平台的特性。

从 Java 代码调用 C/C++ 的六个步骤

从 Java 程序调用 C 或 C ++ 代码的过程由六个步骤组成。我们将在下面几页中深入讨论每个步骤，但还是先让我们迅速地浏览一下它们。

1. 编写 Java 代码。我们将从编写 Java 类开始，这些类执行三个任务：声明将要调用的本机方法；装入包含本机代码的共享库；然后调用该本机方法。

2. 编译 Java 代码。在使用 Java 类之前，必须成功地将它们编译成字节码。

3. 创建 C/C++ 头文件。C/C++ 头文件将声明想要调用的本机函数说明。然后，这个头文件与 C/C++ 函数实现（请参阅步骤 4）一起来创建共享库（请参阅步骤 5）。

4. 编写 C/C++ 代码。这一步实现 C 或 C++ 源代码文件中的函数。C/C++ 源文件必须包含步骤 3 中创建的头文件。

5. 创建共享库文件。从步骤 4 中创建的 C 源代码文件来创建共享库文件。

6. 运行 Java 程序。运行该代码，并查看它是否有用。我们还将讨论一些用于解决常见错误的技巧。

步骤 1：编写 Java 代码

我们从编写 Java 源代码文件开始，它将声明本机方法（或方法），装入包含本机代码的共享库，然后实际调用本机方法。

这里是名为 Sample1.java 的 Java 源代码文件的示例：

 1. public class Sample1

 2. {

 3. public native int intMethod(int n);

 4. public native boolean booleanMethod(boolean bool);

 5. public native String stringMethod(String text);

 6. public native int intArrayMethod(int[] intArray);

 7.

 8. public static void main(String[] args)

 9. {

10. System.loadLibrary("Sample1");

11. Sample1 sample = new Sample1();

12. int square = sample.intMethod(5);

13. boolean bool = sample.booleanMethod(true);

14. String text = sample.stringMethod("JAVA");

15. int sum = sample.intArrayMethod(

16. new int[]{1,1,2,3,5,8,13} );

17.

18. System.out.println("intMethod: " + square);

19. System.out.println("booleanMethod: " + bool);

20. System.out.println("stringMethod: " + text);

21. System.out.println("intArrayMethod: " + sum);

22. }

23. }

这段代码做了些什么？

首先，请注意对 native 关键字的使用，它只能随方法一起使用。native 关键字告诉 Java 编译器：方法是用 Java 类之外的本机代码实现的，但其声明却在 Java 中。只能在 Java 类中声明本机方法，而不能实现它，所以本机方法不能拥有方法主体。

现在，让我们逐行研究一下代码：

• 从第 3 行到第 6 行，我们声明了四个 native 方法。

• 在第 10 行，我们装入了包含这些本机方法的实现的共享库文件。（到步骤 5 时，我们将创建该共享库文件。）

• 最终，从第 12 行到第 15 行，我们调用了本机方法。注：这个操作和调用非本机 Java 方法的操作没有差异。

注：基于 UNIX 的平台上的共享库文件通常含有前缀“lib”。在本例中，第 10 行可能是 System.loadLibrary("libSample1");。请一定要注意您在步骤 5：创建共享库文件中生成的共享库文件名。

步骤 2：编译 Java 代码

接下来，我们需要将 Java 代码编译成字节码。完成这一步的方法之一是使用随 SDK 一起提供的 Java 编译器 javac。用来将 Java 代码编译成字节码的命令是：

javac Sample1.java

步骤 3：创建 C/C++ 头文件

第三步是创建 C/C++ 头文件，它定义本机函数说明。完成这一步的方法之一是使用 javah.exe，它是随 SDK 一起提供的本机方法 C 存根生成器工具。这个工具被设计成用来创建头文件，该头文件为在 Java 源代码文件中所找到的每个 native 方法定义 C 风格的函数。这里使用的命令是：

javah Sample1 

在 Sample1.java 上运行 javah.exe 的结果

下面的 Sample1.h 是对我们的 Java 代码运行 javah 工具所生成的 C/C++ 头文件：

1. /* DO NOT EDIT THIS FILE - it is machine generated */

 2. #include <jni.h>

 3. /* Header for class Sample1 */

 4. 

5. #ifndef _Included_Sample1

 6. #define _Included_Sample1

 7. #ifdef __cplusplus

 8. extern "C" {

 9. #endif

10.

11. JNIEXPORT jint JNICALL Java_Sample1_intMethod

12. (JNIEnv *, jobject, jint);

13.

14. JNIEXPORT jboolean JNICALL Java_Sample1_booleanMethod

15. (JNIEnv *, jobject, jboolean);

16. 

17. JNIEXPORT jstring JNICALL Java_Sample1_stringMethod

18. (JNIEnv *, jobject, jstring);

19.

20. JNIEXPORT jint JNICALL Java_Sample1_intArrayMethod

21. (JNIEnv *, jobject, jintArray);

22. 

23. #ifdef __cplusplus

24. }

25. #endif

26. #endif

关于 C/C++ 头文件

正如您可能已经注意到的那样，Sample1.h 中的 C/C++ 函数说明和 Sample1.java 中的 Java native 方法声明有很大差异。JNIEXPORT 和 JNICALL 是用于导出函数的、依赖于编译器的指示符。返回类型是映射到 Java 类型的 C/C++ 类型。附录 A：JNI 类型中完整地说明了这些类型。

除了 Java 声明中的一般参数以外，所有这些函数的参数表中都有一个指向 JNIEnv 和 jobject 的指针。指向 JNIEnv 的指针实际上是一个指向函数指针表的指针。正如将要在步骤 4 中看到的，这些函数提供各种用来在 C 和 C++ 中操作 Java 数据的能力。

jobject 参数引用当前对象。因此，如果 C 或 C++ 代码需要引用 Java 函数，则这个 jobject 充当引用或指针，返回调用的 Java 对象。函数名本身是由前缀“Java_”加全限定类名，再加下划线和方法名构成的。

步骤 4：编写 C/C++ 代码

当谈到编写 C/C++ 函数实现时，有一点需要牢记：说明必须和 Sample1.h 的函数声明完全一样。我们将研究用于 C 实现和 C++ 实现的完整代码，然后讨论两者之间的差异。

C 函数实现

以下是 Sample1.c，它是用 C 编写的实现：

1. #include "Sample1.h"

 2. #include <string.h>

 3. 

4. JNIEXPORT jint JNICALL Java_Sample1_intMethod

 5. (JNIEnv *env, jobject obj, jint num) {

 6. return num * num;

 7. }

 8. 

9. JNIEXPORT jboolean JNICALL Java_Sample1_booleanMethod

10. (JNIEnv *env, jobject obj, jboolean boolean) {

11. return !boolean;

12. }

13.

14. JNIEXPORT jstring JNICALL Java_Sample1_stringMethod

15. (JNIEnv *env, jobject obj, jstring string) {

16. const char *str = (*env)->GetStringUTFChars(env, string, 0);

17. char cap[128];

18. strcpy(cap, str);

19. (*env)->ReleaseStringUTFChars(env, string, str);

20. return (*env)->NewStringUTF(env, strupr(cap));

21. }

22. 

23. JNIEXPORT jint JNICALL Java_Sample1_intArrayMethod

24. (JNIEnv *env, jobject obj, jintArray array) {

25. int i, sum = 0;

26. jsize len = (*env)->GetArrayLength(env, array);

27. jint *body = (*env)->GetIntArrayElements(env, array, 0);

28. for (i=0; i<len; i++)

29. { sum += body[i];

30. }

31. (*env)->ReleaseIntArrayElements(env, array, body, 0);

32. return sum;

33. }

34. 

35. void main(){}

C++ 函数实现

以下是 Sample1.cpp（C++ 实现）

1. #include "Sample1.h"

 2. #include <string.h>

 3.

 4.JNIEXPORT jint JNICALL Java_Sample1_intMethod

 5. (JNIEnv *env, jobject obj, jint num) {

 6. return num * num;

 7. }

 8.

 9. JNIEXPORT jboolean JNICALL Java_Sample1_booleanMethod

10. (JNIEnv *env, jobject obj, jboolean boolean) {

11. return !boolean;

12. }

13.

14. JNIEXPORT jstring JNICALL Java_Sample1_stringMethod

15. (JNIEnv *env, jobject obj, jstring string) {

16. const char *str = env->GetStringUTFChars(string, 0);

17. char cap[128];

18. strcpy(cap, str);

19. env->ReleaseStringUTFChars(string, str);

20. return env->NewStringUTF(strupr(cap));

21. }

22. 

23. JNIEXPORT jint JNICALL Java_Sample1_intArrayMethod

24. (JNIEnv *env, jobject obj, jintArray array) {

25. int i, sum = 0;

26. jsize len = env->GetArrayLength(array);

27. jint *body = env->GetIntArrayElements(array, 0);

28. for (i=0; i<len; i++)

29. { sum += body[i];

30. }

31. env->ReleaseIntArrayElements(array, body, 0);

32. return sum;

33. }

34.