用JNI进行Java编程---从C/C++程序调用Java代码

概述

JNI 允许您从本机代码内调用 Java 类方法。要做到这一点，通常必须使用 Invocation API 在本机代码内创建和初始化一个 JVM。下列是您可能决定从 C/C++ 代码调用 Java 代码的典型情况：

• 希望实现的这部分代码是平台无关的，它将用于跨多种平台使用的功能。
  
  
• 需要在本机应用程序中访问用 Java 语言编写的代码或代码库。
  
  
• 希望从本机代码利用标准 Java 类库。

从 C/C++ 程序调用 Java 代码的四个步骤

从 C/C++ 调用 Java 方法过程的四个步骤如下：

1. 编写 Java 代码。这个步骤包含编写一个或多个 Java 类，这些类实现（或调用其它方法实现）您想要访问的功能。
   
   
2. 编译 Java 代码。在能够使用这些 Java 类之前，必须成功地将它们编译成字节码。
   
   
3. 编写 C/C++ 代码。这个代码将创建和实例化 JVM，并调用正确的 Java 方法。
   
   
4. 运行本机 C/C++ 应用程序。将运行应用程序以查看它是否正常工作。我们还将讨论一些用于处理常见错误的技巧。

步骤 1：编写 Java 代码

我们从编写一个或多个 Java 源代码文件开始，这些文件将实现我们想要本机 C/C++ 代码使用的功能。

下面显示了一个 Java 代码示例 Sample2.java：

 1. public class Sample2 2. { 3.   public static int intMethod(int n) { 4.       return n*n; 5.   } 6. 7.   public static boolean booleanMethod(boolean bool) { 8.        return !bool; 9.   }10. }

注：Sample2.java 实现了两个 static Java 方法：intMethod(int n) 和 booleanMethod(boolean bool)（分别在第 3 行和第 7 行）。static 方法是一种不需要与对象实例关联的类方法。调用 static 方法要更容易些，因为不必实例化对象来调用它们。

步骤 2：编译 Java 代码

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

javac Sample1.java

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

即使是在本机应用程序中运行，所有 Java 字节码也必须在 JVM 中执行。因此 C/C++ 应用程序必须包含用来创建和初始化 JVM 的调用。为了方便我们，SDK 包含了作为共享库文件（jvm.dll 或 jvm.so）的 JVM，这个库文件可以嵌入到本机应用程序中。

让我们先从浏览一下 C 和 C++ 应用程序的整个代码开始，然后对两者进行比较。

带有嵌入式 JVM 的 C 应用程序

Sample2.c 是一个带有嵌入式 JVM 的简单的 C 应用程序：

 1. #include <jni.h> 2. 3. #ifdef _WIN32 4. #define PATH_SEPARATOR ';' 5. #else 6. #define PATH_SEPARATOR ':' 7. #endif 8. 9. int main()10. {11.   JavaVMOption options[1];12.   JNIEnv *env;13.   JavaVM *jvm;14.   JavaVMInitArgs vm_args;15.   long status;16.   jclass cls;17.   jmethodID mid;18.   jint square;19.   jboolean not;20.21.   options[0].optionString = "-Djava.class.path=.";22.   memset(&vm_args, 0, sizeof(vm_args));23.   vm_args.version = JNI_VERSION_1_2;24.   vm_args.nOptions = 1;25.   vm_args.options = options;26.   status = JNI_CreateJavaVM(&jvm, (void**)&env, &vm_args);27.28.   if (status != JNI_ERR)29.   {30.     cls = (*env)->FindClass(env, "Sample2");31.     if(cls !=0)32.     { mid = (*env)->GetStaticMethodID(env, cls, "intMethod", "(I)I");33.       if(mid !=0)34.       { square = (*env)->CallStaticIntMethod(env, cls, mid, 5);35.printf("Result of intMethod: %d\n", square);36.       }37.38.       mid = (*env)->GetStaticMethodID(env, cls, "booleanMethod", "(Z)Z");39.       if(mid !=0)40.  { not = (*env)->CallStaticBooleanMethod(env, cls, mid, 1);41.         printf("Result of booleanMethod: %d\n", not);42.       }43.     }44.45.     (*jvm)->DestroyJavaVM(jvm);46.     return 0;47/   }48.   else49.   return -1;50. }

带有嵌入式 JVM 的 C++ 应用程序

Sample2.cpp 是一个带有嵌入式 JVM 的 C++ 应用程序：

 1. #include <jni.h> 2. 3. #ifdef _WIN32 4. #define PATH_SEPARATOR ';' 5. #else 6. #define PATH_SEPARATOR ':' 7. #endif 8. 9. int main()10. {11.  JavaVMOption options[1];12.  JNIEnv *env;13.  JavaVM *jvm;14.  JavaVMInitArgs vm_args;15.  long status;16.  jclass cls;17.  jmethodID mid;18.  jint square;19.  jboolean not;20.21.  options[0].optionString = "-Djava.class.path=.";22.  memset(&vm_args, 0, sizeof(vm_args));23.  vm_args.version = JNI_VERSION_1_2;24.  vm_args.nOptions = 1;25.  vm_args.options = options;26.  status = JNI_CreateJavaVM(&jvm, (void**)&env, &vm_args);27.28.  if (status != JNI_ERR)29.   {30.    cls = (*env)->FindClass(env, "Sample2");31.    if(cls !=0)32.     {   mid = (*env)->GetStaticMethodID(env, cls, "intMethod", "(I)I");33.        if(mid !=0)34.        {  square = (*env)->CallStaticIntMethod(env, cls, mid, 5);35.       printf("Result of intMethod: %d\n", square);36.        }37.38.        mid = (*env)->GetStaticMethodID(env, cls, "booleanMethod", "(Z)Z");39.        if(mid !=0)40.        {  not = (*env)->CallStaticBooleanMethod(env, cls, mid, 1);41.       printf("Result of booleanMethod: %d\n", not);42.        }43.     }44.45.    (*jvm)->DestroyJavaVM(jvm);46.    return 0;47.   }48.  else49.    return -1;50. }

C 和 C++ 实现的比较

C 和 C++ 代码几乎相同；唯一的差异在于用来访问 JNI 函数的方法。在 C 中，为了取出函数指针所引用的值，JNI 函数调用前要加一个 (*env)-> 前缀。在 C++ 中，JNIEnv 类拥有处理函数指针查找的内联成员函数。因此，虽然这两行代码访问同一函数，但每种语言都有各自的语法，如下所示。

C 语法：cls = (*env)->FindClass(env, "Sample2");C++ 语法：cls = env->FindClass("Sample2");

对 C 应用程序更深入的研究

我们刚才编写了许多代码，但它们都做些什么呢？ 在执行步骤 4 之前，让我们更深入地研究一下 C 应用程序的代码。我们将先浏览一些必要的步骤，包括准备本机应用程序以处理 Java 代码、将 JVM 嵌入本机应用程序，然后从该应用程序内找到并调用 Java 方法。

包括 jni.h 文件

我们从 C 应用程序中所包括的 jni.h C 头文件开始，如下面的代码样本中所示：

#include <jni.h>

jni.h 文件包含在 C 代码中所需要的 JNI 的所有类型和函数定义。

声明变量

接下来，声明所有希望在程序中使用的变量。JavaVMOption options[] 具有用于 JVM 的各种选项设置。当声明变量时，确保所声明的 JavaVMOption options[] 数组足够大，以便能容纳您希望使用的所有选项。在本例中，我们使用的唯一选项就是类路径选项。因为在本示例中，我们所有的文件都在同一目录中，所以将类路径设置成当前目录。可以设置类路径，使它指向任何您希望使用的目录结构。

以下代码声明了用于 Sample2.c 的变量：

JavaVMOption options[1];JNIEnv *env;JavaVM *jvm;JavaVMInitArgs vm_args;

注：

• JNIEnv *env 表示 JNI 执行环境。
  
  
• JavaVM jvm 是指向 JVM 的指针。我们主要使用这个指针来创建、初始化和销毁 JVM。
  
  
• JavaVMInitArgs vm_args 表示可以用来初始化 JVM 的各种 JVM 参数。

设置初始化参数

JavaVMInitArgs 结构表示用于 JVM 的初始化参数。在执行 Java 代码之前，可以使用这些参数来定制运行时环境。正如您所见，这些选项是一个参数而 Java 版本是另一个参数。按如下所示设置了这些参数：

vm_args.version = JNI_VERSION_1_2;vm_args.nOptions = 1;vm_args.options = options;

设置类路径

接下来，为 JVM 设置类路径，以使它能找到所需要的 Java 类。在这个特定示例中，因为 Sample2.class 和 Sample2.exe 都位于同一目录中，所以将类路径设置成当前目录。我们用来为 Sample2.c 设置类路径的代码如下所示：

options[0].optionString = "-Djava.class.path=."; // same text as command-line options for the java.exe JVM

为 vm_args 留出内存

在可以使用 vm_args 之前，必需为它留出一些内存。一旦设置了内存，就可以设置版本和选项参数了，如下所示：

    memset(&vm_args, 0, sizeof(vm_args));  // set aside enough memory for vm_args    vm_args.version = JNI_VERSION_1_2;         // version of Java platform    vm_args.nOptions = 1;                      // same as size of options[1]    vm_args.options = options;

创建 JVM

处理完所有设置之后，现在就准备创建 JVM 了。先从调用方法开始：

JNI_CreateJavaVM(JavaVM **jvm, void** env, JavaVMInitArgs **vm_args)

如果成功，则这个方法返回零，否则，如果无法创建 JVM，则返回 JNI_ERR。

查找并装入 Java 类

一旦创建了 JVM 之后，就可以准备开始在本机应用程序中运行 Java 代码。首先，需要使用 FindClass() 函数查找并装入 Java 类，如下所示：

cls = (*env)->FindClass(env, "Sample2");

cls 变量存储执行 FindClass() 函数后的结果。 如果找到该类，则 cls 变量表示该 Java 类的句柄。如果不能找到该类，则 cls 将为零。

查找 Java 方法

接下来，我们希望用 GetStaticMethodID() 函数在该类中查找某个方法。我们希望查找方法 intMethod，它接收一个 int 参数并返回一个 int。以下是查找 intMethod 的代码：

mid = (*env)->GetStaticMethodID(env, cls, "intMethod", "(I)I");

mid 变量存储执行 GetStaticMethodID() 函数后的结果。如果找到了该方法，则 mid 变量表示该方法的句柄。如果不能找到该方法，则 mid 将为零。

请记住，在本示例中，我们正在调用 static Java 方法。 那就是我们使用 GetStaticMethodID() 函数的原因。GetMethodID() 函数与GetStaticMethodID() 函数的功能一样，但它用来查找实例方法。

如果正在调用构造器，则方法的名称为“<init>”。 要了解更多关于调用构造器的知识，请参阅错误处理。 要了解更多关于用来指定参数类型的代码以及关于如何将 JNI 类型映射到 Java 原始类型的知识，请参阅附录 。

调用 Java 方法

最后，我们调用 Java 方法，如下所示：

square = (*env)->CallStaticIntMethod(env, cls, mid, 5);

CallStaticIntMethod() 方法接受 cls（表示类）、mid（表示方法）以及用于该方法一个或多个参数。在本例中参数是 int 5。

您还会遇到 CallStaticXXXMethod() 和 CallXXXMethod() 之类的方法。这些方法分别调用静态方法和成员方法，用方法的返回类型（例如，Object、Boolean、Byte、Char、Int、Long 等等）代替变量 XXX。

步骤 4：运行应用程序

现在准备运行这个 C 应用程序，并确保代码正常工作。当运行 Sample2.exe 时，应该可以得到如下结果：

PROMPT>Sample2Result of intMethod: 25Result of booleanMethod: 0PROMPT>

故障排除

JNI 的 Invocation API 有点麻烦，因为它是用 C 语言定义的，而 C 语言基本上不支持面向对象编程。结果是，它很容易遇到问题。下面是一份检查表，它可能有助于您避免一些较常见的错误。

• 请总是确保正确设置了引用。例如，当使用 JNI_CreateJavaVM() 方法创建 JVM 时，确保它返回零。还请确保，在使用FindClass() 和 GetMethodID() 方法之前，它们的引用设置不是零。
  
  
• 请检查方法名是否拼写正确以及是否适当地转换了方法说明。还请确保，对静态方法使用了 CallStaticXXXMethod() 以及对成员方法使用了 CallXXXMethod()。
  
  
• 确保使用任何 Java 类所需的特殊的参数或选项来初始化 JVM。例如，如果 Java 类需要大量内存，则可能需要增加堆的最大大小选项。
  
  
• 请总是确保正确设置了类路径。使用嵌入式 JVM 的本机应用程序必须能够找到 jvm.dll 或 jvm.so 共享库。

结束语

尽管从 C 调用 Java 方法确实需要相当高级的“类面向对象编程”技术，但这对经验丰富的 C 程序员而言相对比较简单。尽管 JNI 支持 C 和 C++，但 C++ 接口要更清晰些，通常比 C 接口更可取。

要记住很重要的一点是：可以用单个 JVM 来装入和执行多个类和方法。如果每次从本机代码与 Java 交互都创建和销毁 JVM，则会浪费资源并降低性能。