从 C/C++ 程序调用 Java 代码java
概述程序员
JNI 容许您从本机代码内调用 Java 类方法。要作到这一点,一般必须使用 Invocation API 在本机代码内建立和初始化一个 JVM。下列是您可能决定从 C/C++ 代码调用 Java 代码的典型状况:shell
从 C/C++ 调用 Java 方法过程的四个步骤以下:编程
咱们从编写一个或多个 Java 源代码文件开始,这些文件将实现咱们想要本机 C/C++ 代码使用的功能。c#
下面显示了一个 Java 代码示例 Sample2.java:数组
public class Sample2 { public static int intMethod(int n) { return n*n; } public static boolean booleanMethod(boolean bool) { return !bool; } }
注:Sample2.java 实现了两个 static
Java 方法:intMethod(int n)
和 booleanMethod(boolean bool)
(分别在第 3 行和第 7 行)。static
方法是一种不须要与对象实例关联的类方法。调用 static
方法要更容易些,由于没必要实例化对象来调用它们。jvm
接下来,咱们将 Java 代码编译成字节码。完成这一步的方法之一是使用随 SDK 一块儿提供的 Java 编译器 javac
。 使用的命令是:ide
javac Sample1.java
即便是在本机应用程序中运行,全部 Java 字节码也必须在 JVM 中执行。所以 C/C++ 应用程序必须包含用来建立和初始化 JVM 的调用。为了方便咱们,SDK 包含了做为共享库文件(jvm.dll 或 jvm.so)的 JVM,这个库文件能够嵌入到本机应用程序中。函数
让咱们先从浏览一下 C 和 C++ 应用程序的整个代码开始,而后对二者进行比较。性能
Sample2.c 是一个带有嵌入式 JVM 的简单的 C 应用程序:
#include <jni.h> #ifdef _WIN32 #define PATH_SEPARATOR ';' #else #define PATH_SEPARATOR ':' #endif int main() { JavaVMOption options[1]; JNIEnv *env; JavaVM *jvm; JavaVMInitArgs vm_args; long status; jclass cls; jmethodID mid; jint square; jboolean not; options[0].optionString = "-Djava.class.path=."; memset(&vm_args, 0, sizeof(vm_args)); vm_args.version = JNI_VERSION_1_2; vm_args.nOptions = 1; vm_args.options = options; status = JNI_CreateJavaVM(&jvm, (void**)&env, &vm_args); if (status != JNI_ERR) { cls = (*env)->FindClass(env, "Sample2"); if(cls !=0) { mid = (*env)->GetStaticMethodID(env, cls, "intMethod", "(I)I"); if(mid !=0) { square = (*env)->CallStaticIntMethod(env, cls, mid, 5); printf("Result of intMethod: %d\n", square); } mid = (*env)->GetStaticMethodID(env, cls, "booleanMethod", "(Z)Z"); if(mid !=0) { not = (*env)->CallStaticBooleanMethod(env, cls, mid, 1); printf("Result of booleanMethod: %d\n", not); } } (*jvm)->DestroyJavaVM(jvm); return 0; } else return -1; }
Sample2.cpp 是一个带有嵌入式 JVM 的 C++ 应用程序:
#include <jni.h> #ifdef _WIN32 #define PATH_SEPARATOR ';' #else #define PATH_SEPARATOR ':' #endif int main() { JavaVMOption options[1]; JNIEnv *env; JavaVM *jvm; JavaVMInitArgs vm_args; long status; jclass cls; jmethodID mid; jint square; jboolean not; options[0].optionString = "-Djava.class.path=."; memset(&vm_args, 0, sizeof(vm_args)); vm_args.version = JNI_VERSION_1_2; vm_args.nOptions = 1; vm_args.options = options; status = JNI_CreateJavaVM(&jvm, (void**)&env, &vm_args); if (status != JNI_ERR) { cls = (*env)->FindClass(env, "Sample2"); if(cls !=0) { mid = (*env)->GetStaticMethodID(env, cls, "intMethod", "(I)I"); if(mid !=0) { square = (*env)->CallStaticIntMethod(env, cls, mid, 5); printf("Result of intMethod: %d\n", square); } mid = (*env)->GetStaticMethodID(env, cls, "booleanMethod", "(Z)Z"); if(mid !=0) { not = (*env)->CallStaticBooleanMethod(env, cls, mid, 1); printf("Result of booleanMethod: %d\n", not); } } (*jvm)->DestroyJavaVM(jvm); return 0; } else return -1; }
C 和 C++ 代码几乎相同;惟一的差别在于用来访问 JNI 函数的方法。在 C 中,为了取出函数指针所引用的值,JNI 函数调用前要加一个 (*env)->
前缀。在 C++ 中,JNIEnv
类拥有处理函数指针查找的内联成员函数。所以,虽然这两行代码访问同一函数,但每种语言都有各自的语法,以下所示。
C 语法: | cls = (*env)->FindClass(env, "Sample2"); |
C++ 语法: | cls = env->FindClass("Sample2"); |
咱们刚才编写了许多代码,但它们都作些什么呢? 在执行步骤 4 以前,让咱们更深刻地研究一下 C 应用程序的代码。咱们将先浏览一些必要的步骤,包括准备本机应用程序以处理 Java 代码、将 JVM 嵌入本机应用程序,而后从该应用程序内找到并调用 Java 方法。
咱们从 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
以前,必需为它留出一些内存。一旦设置了内存,就能够设置版本和选项参数了,以下所示:
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 了。先从调用方法开始:
JNI_CreateJavaVM(JavaVM **jvm, void** env, JavaVMInitArgs **vm_args)
若是成功,则这个方法返回零,不然,若是没法建立 JVM,则返回 JNI_ERR
。
一旦建立了 JVM 以后,就能够准备开始在本机应用程序中运行 Java 代码。首先,须要使用 FindClass()
函数查找并装入 Java 类,以下所示:
cls = (*env)->FindClass(env, "Sample2");
cls
变量存储执行 FindClass()
函数后的结果。 若是找到该类,则 cls
变量表示该 Java 类的句柄。若是不能找到该类,则 cls
将为零。
接下来,咱们但愿用 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 方法,以下所示:
square = (*env)->CallStaticIntMethod(env, cls, mid, 5);
CallStaticIntMethod()
方法接受 cls
(表示类)、mid
(表示方法)以及用于该方法一个或多个参数。在本例中参数是 int
5。
您还会遇到 CallStaticXXXMethod()
和 CallXXXMethod()
之类的方法。这些方法分别调用静态方法和成员方法,用方法的返回类型(例如,Object
、Boolean
、Byte
、Char
、Int
、Long
等等)代替变量 XXX
。
如今准备运行这个 C 应用程序,并确保代码正常工做。当运行 Sample2.exe 时,应该能够获得以下结果:
PROMPT>Sample2 Result of intMethod: 25 Result of booleanMethod: 0 PROMPT>
JNI 的 Invocation API 有点麻烦,由于它是用 C 语言定义的,而 C 语言基本上不支持面向对象编程。结果是,它很容易遇到问题。下面是一份检查表,它可能有助于您避免一些较常见的错误。
JNI_CreateJavaVM()
方法建立 JVM 时,确保它返回零。还请确保,在使用 FindClass()
和 GetMethodID()
方法以前,它们的引用设置不是零。CallStaticXXXMethod()
以及对成员方法使用了 CallXXXMethod()
。尽管从 C 调用 Java 方法确实须要至关高级的“类面向对象编程”技术,但这对经验丰富的 C 程序员而言相对比较简单。尽管 JNI 支持 C 和 C++,但 C++ 接口要更清晰些,一般比 C 接口更可取。
要记住很重要的一点是:能够用单个 JVM 来装入和执行多个类和方法。若是每次从本机代码与 Java 交互都建立和销毁 JVM,则会浪费资源并下降性能。