用 JNI 进行 Java 编程
从Java 程序调用C/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 源代码文件的示例：
01 public class Sample1
02 {
03 public native int intMethod(int n);
04 public native boolean booleanMethod(boolean bool);
05 public native String stringMethod(String text);
06 public native int intArrayMethod(int[] intArray);
07
08 public static void main(String[] args)
09 {
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 代码编译成字节码的命令是：
1 javac Sample1.java
步骤3：创建C/C++ 头文件
第三步是创建C/C++ 头文件，它定义本机函数说明。完成这一步的方法之一是使用javah.exe，它是随SDK 一起提供的本机方法C 存根生成器工具。这个工具被设计成用来创建头文件，该头文件为在Java 源代码文件中所找到的每个native方法定义C 风格的函数。这里使用的命令是：
1 javah Sample1
在Sample1.java上运行javah.exe的结果
下面的Sample1.h 是对我们的Java 代码运行javah 工具所生成的C/C++ 头文件：
01 /* DO NOT EDIT THIS FILE - it is machine generated */
02 #include
03 /* Header for class Sample1 */
04
05 #ifndef _Included_Sample1
06 #define _Included_Sample1
07 #ifdef __cplusplus
08 extern "C" {
09 #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 编写的实现：
01 #include "Sample1.h"
02 #include
03
04 JNIEXPORT jint JNICALL Java_Sample1_intMethod
05 (JNIEnv *env, jobject obj, jint num) {
06 return num * num;
07 }
08
09 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 29 { sum += body[i]; } 30 (*env)->ReleaseIntArrayElements(env, array, body, 0); 31 return sum; 32 } 33 34 void main(){} C++ 函数实现 以下是Sample1.cpp（C++ 实现） 01 1. #include "Sample1.h" 02 2. #include 03 3. 04 4.JNIEXPORT jint JNICALL Java_Sample1_intMethod 05 5. (JNIEnv *env, jobject obj, jint num) { 06 6. return num * num; 07 7. } 08 8. 09 9. JNIEXPORT jboolean JNICALL Java_Sample1_booleanMethod 10 10. (JNIEnv *env, jobject obj, jboolean boolean) { 11 11. return !boolean; 12 12. } 13 13. 14 14. JNIEXPORT jstring JNICALL Java_Sample1_stringMethod 15 15. (JNIEnv *env, jobject obj, jstring string) { 16 16. const char *str = env->GetStringUTFChars(string, 0); 17 17. char cap[128]; 18 18. strcpy(cap, str); 19 19. env->ReleaseStringUTFChars(string, str); 20 20. return env->NewStringUTF(strupr(cap)); 21 21. } 22 22. 23 23. JNIEXPORT jint JNICALL Java_Sample1_intArrayMethod 24 24. (JNIEnv *env, jobject obj, jintArray array) { 25 25. int i, sum = 0; 26 26. jsize len = env->GetArrayLength(array); 27 27. jint *body = env->GetIntArrayElements(array, 0); 28 28. for (i=0; i 29 29. { sum += body[i]; 30 30. } 31 31. env->ReleaseIntArrayElements(array, body, 0); 32 32. return sum; 33 33. } 34 34. 35 35. void main(){} C 和 C++ 函数实现的比较 C 和 C++ 代码几乎相同；唯一的差异在于用来访问 JNI 函数的方法。在 C 中，JNI 函数调用由“(*env)->”作前缀，目的是为了取出函数指针所引用的值。在 C++ 中，JNIEnv 类拥有处理函数指针查找的内联成员函数。下面将说明这个细微的差异，其中，这两行代码访问同一函数，但每种语言都有各自的语法。 1 C 语法： jsize len = (*env)->GetArrayLength(env,array); 2 C++ 语法： jsize len =env->GetArrayLength(array); 步骤 5：创建共享库文件 接下来，我们创建包含本机代码的共享库文件。大多数 C 和 C++ 编译器除了可以创建机器代码可执行文件以外，也可以创建共享库文件。用来创建共享库文件的命令取决于您使用的编译器。下面是在 Windows 和 Solaris 系统上执行的命令。 1 Windows ： cl -Ic:\jdk\include -Ic:\jdk\include\win3 2 -LD Sample1.c -FeSample1.dll 2 Solaris ： cc -G -I/usr/local/jdk/include -I/user/local/jdk/include/solaris Sample1.c -o Sample1.so 步骤 6：运行 Java 程序 最后一步是运行 Java 程序，并确保代码正确工作。因为必须在 Java 虚拟机中执行所有 Java 代码，所以需要使用 Java 运行时环境。完成这一步的方法之一是使用 java ，它是随 SDK 一起提供的 Java 解释器。所使用的命令是： 1 java Sample1 当运行Sample1.class程序时，应该获得下列结果： 1 PROMPT>java Sample1 2 intMethod: 25 3 booleanMethod: false 4 stringMethod: JAVA 5 intArrayMethod: 33 6 7 PROMPT> 故障排除 当使用JNI 从Java 程序访问本机代码时，您会遇到许多问题。您会遇到的三个最常见的错误是： ?无法找到动态链接。它所产生的错误消息是：https://www.sodocs.net/doc/5918322744.html,ng.UnsatisfiedLinkError。 这通常指无法找到共享库，或者无法找到共享库内特定的本机方法。 ?无法找到共享库文件。当用System.loadLibrary(String libname)方法（参数是文件名）装入库文件时，请确保文件名拼写正确以及没有指定扩展名。还有，确保库文件的位置在类路径中，从而确保JVM 可以访问该库文件。 ?无法找到具有指定说明的方法。确保您的C/C++ 函数实现拥有与头文件中的函数说明相同的说明。 结束语 从Java 调用C 或C++ 本机代码（虽然不简单）是Java 平台中一种良好集成的功能。虽然JNI 支持C 和C++，但C++ 接口更清晰一些并且通常比C 接口更可取。 正如您已经看到的，调用C 或C++ 本机代码需要赋予函数特殊的名称，并创建共享库文件。当利用现有代码库时，更改代码通常是不可取的。要避免这一点，在C++ 中，通常创建代理代码或代理类，它们有专门的JNI 所需的命名函数。然后，这些函数可以调用底层库函数，这些库函数的说明和实现保持不变。