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

从 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.
35. void main(){}



C 和 C++ 函数实现的比较

C 和 C++ 代码几乎相同;唯一的差异在于用来访问 JNI 函数的方法。在 C 中,JNI 函数调用由“(*env)->”作前缀,目的是为了取出函数指针所引用的值。在 C++ 中,JNIEnv 类拥有处理函数指针查找的内联成员函数。下面将说明这个细微的差异,其中,这两行代码访问同一函数,但每种语言都有各自的语法。

C 语法:jsize len = (*env)->GetArrayLength(env,array);
C++ 语法:jsize len =env->GetArrayLength(array);


步骤 5:创建共享库文件

接下来,我们创建包含本机代码的共享库文件。大多数 C 和 C++ 编译器除了可以创建机器代码可执行文件以外,也可以创建共享库文件。用来创建共享库文件的命令取决于您使用的编译器。下面是在 Windows 和 Solaris 系统上执行的命令。

Windows:cl -Ic:\jdk\include -Ic:\jdk\include\win32 -LD Sample1.c -FeSample1.dll
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 解释器。所使用的命令是:

java Sample1

当运行 Sample1.class 程序时,应该获得下列结果:

PROMPT>java Sample1
intMethod: 25
booleanMethod: false
stringMethod: JAVA
intArrayMethod: 33

PROMPT>


故障排除

当使用 JNI 从 Java 程序访问本机代码时,您会遇到许多问题。您会遇到的三个最常见的错误是:

  • 无法找到动态链接。它所产生的错误消息是:java.lang.UnsatisfiedLinkError。这通常指无法找到共享库,或者无法找到共享库内特定的本机方法。

  • 无法找到共享库文件。当用 System.loadLibrary(String libname) 方法(参数是文件名)装入库文件时,请确保文件名拼写正确以及没有指定扩展名。还有,确保库文件的位置在类路径中,从而确保 JVM 可以访问该库文件。

  • 无法找到具有指定说明的方法。确保您的 C/C++ 函数实现拥有与头文件中的函数说明相同的说明。


结束语

从 Java 调用 C 或 C++ 本机代码(虽然不简单)是 Java 平台中一种良好集成的功能。虽然 JNI 支持 C 和 C++,但 C++ 接口更清晰一些并且通常比 C 接口更可取。

正如您已经看到的,调用 C 或 C++ 本机代码需要赋予函数特殊的名称,并创建共享库文件。当利用现有代码库时,更改代码通常是不可取的。要避免这一点,在 C++ 中,通常创建代理代码或代理类,它们有专门的 JNI 所需的命名函数。然后,这些函数可以调用底层库函数,这些库函数的说明和实现保持不变。

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值