JNI允许您从本机代码内调用 Java 类方法。
要做到这一点,通常必须使用 Invocation API 在本机代码内创建和初始化一个 JVM。
下列是您可能决定从 C/C++ 代码调用Java 代码的典型情况:
1.希望实现的这部分代码是平台无关的,它将用于跨多种平台使用的功能。
2.需要在本机应用程序中访问用 Java 语言编写的代码或代码库。
3.希望从本机代码利用标准 Java 类库。
从C/C++ 程序调用 Java 代码的四个步骤:
1.编写 Java 代码。
这个步骤包含编写一个或多个 Java 类,这些类实现(或调用其它方法实现)您想要访问的功能。
2.编译 Java 代码。
在能够使用这些 Java 类之前,必须成功地将它们编译成字节码。
3.编写 C/C++ 代码。
这个代码将创建和实例化 JVM,并调用正确的 Java 方法。
4.运行本机 C/C++ 应用程序。
将运行应用程序以查看它是否正常工作。我们还将讨论一些用于处理常见错误的技巧。
步骤 1:编写Java 代码
我们从编写一个或多个 Java 源代码文件开始,这些文件将实现我们想要本机 C/C++ 代码使用的功能。
下面显示了一个 Java 代码示例JNI_cCalljava_test.java:
1. package test;
2.
3. pulic class JNI_cCalljava_test {
4.
5. pulic static int intMethod(int n) {
6. return n*n;
7. }
8.
9. pblic static boolean booleanMethod(boolean bool) {
10. return !bool;
11. }
12.
13. }
注:JNI_cCalljava_test.java 实现了两个 static Java 方法:intMethod(intn) 和 booleanMethod(boolean bool)(分别在第 3 行和第 7 行)。static方法是一种不需要与对象实例关联的类方法。调用 static方法要更容易些,因为不必实例化对象来调用它们。
步骤 2:编译Java 代码
接下来,我们将 Java 代码编译成字节码。
完成这一步的方法之一是使用随SDK 一起提供的Java 编译器 javac。使用的命令是:
JNI_cCalljava_test.java
或者直接在eclipose中编写保存即可
步骤 3:编写 C/C++ 代码
即使是在本机应用程序中运行,所有 Java 字节码也必须在 JVM 中执行。
因此 C/C++ 应用程序必须包含用来创建和初始化 JVM 的调用。
为了方便我们,SDK 包含了作为共享库文件(jvm.dll 或 jvm.so)的 JVM,这个库文件可以嵌入到本机应用程序中。
让我们先从浏览一下 C 和 C++ 应用程序的整个代码开始,然后对两者进行比较。
带有嵌入式 JVM的 C 应用程序:
1. #include <jni.h>
2. //jni.h文件包含在 C 代码中所需要的 JNI 的所有类型和函数定义
3. #ifdef _WIN32
4. #define PATH_SEPARATOR ';'
5. #else
6. #define PATH_SEPARATOR ':'
7. #endif
8. //1.包括准备本机应用程序以处理 Java 代码
9. //2.将 JVM 嵌入本机应用程序
10. //3.然后从该应用程序内找到并调用 Java 方法。
11. int main()
12. {
13. /*
14. 接下来,声明所有希望在程序中使用的变量。
15. JavaVMOption options[] 具有用于 JVM 的各种选项设置。
16. 当声明变量时,确保所声明的JavaVMOption options[] 数组足够大,以便能容纳您希望使用的所有选项。
17. 在本例中,我们使用的唯一选项就是类路径选项。
18. 因为在本示例中,我们所有的文件都在同一目录中,所以将类路径设置成当前目录。
19. 可以设置类路径,使它指向任何您希望使用的目录结构。*/
20. JavaVMOption options[1];
21. JNIEnv *env;
22. JavaVM *jvm;
23. JavaVMInitArgs vm_args;
24. /*JNIEnv *env 表示 JNI 执行环境。
25. JavaVM jvm 是指向 JVM 的指针,我们主要使用这个指针来创建、初始化和销毁 JVM。
26. JavaVMInitArgs vm_args 表示可以用来初始化 JVM 的各种 JVM 参数。*/
27.
28. long status;
29. jclass cls;
30. jmethodID mid;
31. jint square;
32. jboolean not;
33.
34. /*avaVMInitArgs 结构表示用于 JVM 的初始化参数。
35. 在执行 Java 代码之前,可以使用这些参数来定制运行时环境。
36. 正如您所见,这些选项是一个参数,而 Java 版本是另一个参数。
37. 按如下所示设置了这些参数:*/
38.
39. /*为 JVM 设置类路径,以使它能找到所需要的 Java 类。
40. 在这个特定示例中,因为 Sample2.class 和Sample2.exe 都位于同一目录中,所以将类路径设置成当前目录。
41. 我们用来为 Sample2.c 设置类路径的代码如下所示:*/
42. "-Djava.class.path=.";
43. sizeof(vm_args));
44. vm_args.version = JNI_VERSION_1_2;
45. vm_args.nOptions = 1;
46. vm_args.options = options;
47.
48. /*创建 JVM
49. 处理完所有设置之后,现在就准备创建 JVM 了。先从调用方法开始
50. 如果成功,则这个方法返回零,否则,如果无法创建 JVM,则返回JNI_ERR。*/
51. void**)&env, &vm_args);
52.
53. if (status != JNI_ERR)
54. {
55. /*
56. 查找并装入 Java 类
57. 一旦创建了 JVM 之后,就可以准备开始在本机应用程序中运行 Java 代码。
58. 首先,需要使用FindClass() 函数查找并装入 Java 类,如下所示:
59. cls 变量存储执行FindClass() 函数后的结果,如果找到该类,则 cls 变量表示该Java 类的句柄,
60. 如果不能找到该类,则 cls 将为零。
61. */
62. "test/JNI_cCalljava_test");
63. "test1,cls=%d...\n",cls);
64.
65. if(cls !=0)
66. {
67. /*
68. 查找 Java 方法
69. 接下来,我们希望用 GetStaticMethodID() 函数在该类中查找某个方法。
70. 我们希望查找方法 intMethod,它接收一个 int 参数并返回一个 int。
71. 以下是查找 intMethod 的代码:
72. */
73. "intMethod", "(I)I");
74. /*
75. mid 变量存储执行 GetStaticMethodID() 函数后的结果。
76. 如果找到了该方法,则 mid 变量表示该方法的句柄。
77. 如果不能找到该方法,则mid 将为零。
78. */
79. if(mid !=0)
80. {
81. /*CallStaticIntMethod() 方法接受 cls(表示类)、mid(表示方法)以及用于该方法一个或多个参数。
82. 在本例中参数是 int 5。*/
83. square = (*env)->CallStaticIntMethod(env, cls, mid, 5);
84. "Result of intMethod: %d\n", square);
85. }
86.
87. "booleanMethod", "(Z)Z");
88. if(mid !=0)
89. {
90. not = (*env)->CallStaticBooleanMethod(env, cls, mid, 1);
91. "Result of booleanMethod: %d\n", not);
92. }
93. }
94.
95. (*jvm)->DestroyJavaVM(jvm);
96. return 0;
97. }
98. else
99. return -1;
100. }
带有嵌入式 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. "-Djava.class.path=.";
22. sizeof(vm_args));
23. vm_args.version = JNI_VERSION_1_2;
24. vm_args.nOptions = 1;
25. vm_args.options = options;
26. void**)&env, &vm_args);
27.
28. if (status != JNI_ERR)
29. {
30. "Sample2");
31. if(cls !=0)
32. {
33. "intMethod", "(I)I");
34. if(mid !=0)
35. {
36. square = env->CallStaticIntMethod(cls, mid, 5);
37. "Result of intMethod: %d\n", square);
38. }
39.
40. "booleanMethod", "(Z)Z")
41. if(mid !=0)
42. {
43. not = env->CallStaticBooleanMethod(cls, mid, 1);
44. "Result of booleanMethod: %d\n", not);
45. }
46. }
47.
48. jvm->DestroyJavaVM();
49. return 0;
50. }
51. else
52. return -1;
53. }
C 和 C++ 实现的比较
C 和C++ 代码几乎相同;唯一的差异在于用来访问 JNI 函数的方法。
在 C 中,为了取出函数指针所引用的值,JNI 函数调用前要加一个(*env)-> 前缀。
在 C++ 中,JNIEnv类拥有处理函数指针查找的内联成员函数。
因此,虽然这两行代码访问同一函数,但每种语言都有各自的语法,如下所示。
C 语法:
cls = (*env)->FindClass(env, "Sample2");
C++ 语法:
cls = env->FindClass("Sample2");
C 语法:
mid = (*env)->GetStaticMethodID(env, cls, "intMethod", "(I)I");
C++ 语法:
mid = env->GetStaticMethodID(cls, "intMethod", "(I)I");
C 语法:
square = env->CallStaticIntMethod(cls, mid, 5);
C++ 语法:
square = (*env)->CallStaticIntMethod(env, cls, mid, 5);
C 语法:
(*jvm)->DestroyJavaVM(jvm);
C++ 语法:
jvm->DestroyJavaVM();
步骤 4:运行应用程序
现在准备运行这个 C 应用程序,并确保代码正常工作。当运行 Sample2.exe 时,应该可以得到如下结果:
windows:
使用vc6.0建一个普通的C语言工程
头文件路径设置同Java调用C语言里的设置
连接时需要jvm.lib支持
这里需要右击建立的工程,单击设置(Settings),link选项栏将数据库路径添加进来
C:"\Program Files"\Java\jdk1.6.0_10\lib\jvm.lib
在下面的project options中加入以上语句,用空格隔开,programe Files用双引号引起来
运行时需要jvm.dll动态库的支持,需要在系统环境变量中增加以下路径:
C:\Program Files\Java\jdk1.6.0_10\jre\bin\server
方法:右击 我的电脑-》属性-》高级-》环境变量-》PATH 编辑,在原有环境变量的基础上增加以上路径,注意用";"号隔开
将eclipose生成的java代码放在JNI_cCalljava_test.exe同目录下(注意按照把报名文件夹也拷过去)
E:\Sample2>JNI_cCalljava_test.exe
Result of intMethod: 25
Result of booleanMethod: 0
此文章纯粹实例操作,关于jni已经有不少人不少文章讲的很清楚了,所以就不罗列理论了。
看了kimmking的JNI技术实践小结,又读了danlley的Java JNI 编程进阶,这些文章中都是自己调用自己,方法很java化,而对于真正的调用dll还是不理解,心中一直存在问题:现在系统中已经有的dll我该如何去调用?如果一个大工程里需要cpp和java一起开发,cpp给出接口、SDK,我该如何处理?
带着这些疑问我决定从cpp到java的jni调用这个全过程亲自动手操作一下。
完成此示例需要下列工具/环境:
1、java环境(废话谁都知道)
2、编译c/cpp的工具。推荐用vs/vc++,我用的是vs2008
一 先制作一个系统中有的DLL文件(cpp给出的sdk接口)
既然是测试我们就把我们这个dll叫做testDll吧,为了简单其间,我只写一个add方法,就是简单的2个数字相加,对于真正的开发中我们肯定会遇到其他类型,java到c/cpp中类型需要转换,具体类型转换对应关系g一下就能得到,我也不在列举。c/cpp中一个class一般包含2个文件,一个头文件定义(*.h),一个文件主体(*.c/*.cpp)。啰嗦了这么多还是直接动手吧,先在vs2008中建立一个工程(当然你也可以直接编写不用这些IDE工具,gcc g++的命令自己g。下同,不在注释不在废话),选取win32工程
键入工程名字testDll,点击next选取DLL,然后点击完成
打开我们的testdll.cpp,添加进我们的add方法
1. int add(int a,int
2. return
3. }
注意到文件列表里并没有testDll.h,因为我们要给出调用者一个接口,如果不给头文件,人家就没办法调用,所以我们就必须添加一个头文件testDll.h。
1. #ifdef TEST_DLL
2. #define TEST_API __declspec(dllexport)
3. #else
4. #define TEST_API __declspec(dllimport)
5. #endif
6.
7. /* Set up for C function definitions, even when using C++ */
8. #ifdef __cplusplus
9. extern "C"
10. #endif
11.
12. TEST_API int add(int,int);
13.
14. /* Ends C function definitions when using C++ */
15. #ifdef __cplusplus
16. }
17. #endif
在这个头文件中我们把我们的add方法给定义了进去。注意到testdll.cpp中#include "stdafx.h",所以我们就把这个testDll.h include进stdafx.h里面。
按道理说我们的这个dll已经完成了,但是一般c/cpp给接口SDK的时候大都给.h和.lib,为了一步生成dll和lib,我们添加进一个testDll.def,有了这个文件就可以一步生成dll和lib。在source file里右键add new item ,选择Module-Definition File
键入testDll,OK了,我们可以直接build了。生成testDll.dll和testDll.lib。
把testDll.dll扔到system32目录里等待我们高大威猛的java jni调用。
二 JNI
2.1 编写java文件
为了显示我们的与众相同,我们就把我们的这个java文件命名为Demo.java顺便直接带上包名
,因为我们知道人家给我们的接口里有个add方法,所以我们就直接来个调用吧。
1. package
2.
3. pblic class
4. static
5. {
6. //System.out.println(System.getProperty("java.library.path"));
7. "testDll");
8. "jniDll");
9. }
10. pblic native static int add(int a,int
11.
12. }
demo.java代码暂时如此,我们把将要生成的jni的dll叫做jniDll,有童鞋讲,我不想用你这个烂名字jniDll多俗啊,没关系,你可以换,随你换,生成文件后你再换也可以,现在换也可以。
2.2 生成.h头文件
javah命令,不多讲。生成的文件com_testJni_testDemo_Demo.h这个文件的命名规则我就不多讲了,一目了然。
1. /* DO NOT EDIT THIS FILE - it is machine generated */
2. #include <jni.h>
3. /* Header for class com_testJni_testDemo_Demo */
4.
5. #ifndef _Included_com_testJni_testDemo_Demo
6. #define _Included_com_testJni_testDemo_Demo
7. #ifdef __cplusplus
8. extern "C"
9. #endif
10. /*
11. * Class: com_testJni_testDemo_Demo
12. * Method: add
13. * Signature: (II)I
14. */
15. JNIEXPORT jint JNICALL Java_com_testJni_testDemo_Demo_add
16. (JNIEnv *, jclass, jint, jint);
17.
18. #ifdef __cplusplus
19. }
20. #endif
21. #endif
2.3 用c/cpp实现这个头文件
c/cpp中已经实现了这个add方法,我们只需要调用就可以啦。所以直接vs2008中建立一个dll工程,工程名我们就叫jniDll,具体过程不再多讲,方法同上面testDll的建立一样。在这个工程里kimmking把需要引用的包、文件等已经讲的很清楚了。打开jniDll.cpp,添加下面代码
1. JNIEXPORT jint JNICALL Java_com_testJni_testDemo_Demo_add
2. (JNIEnv *env,jclass jobject,jint a,jint b){
3.
4. return
5. }
因为int对应的类型就刚好是jint,所以就不需要转换,其他需要转换的类型自己g对应关系转换,注意释放。
这个工程里我们还需要打开 stdafx.h添加
1. #include <jni.h>
2.
3. #include "testDll.h"
4. #include "com_testJni_testDemo_Demo.h"
在编译这个jniDll工程的时候需要引入testDll.h,com_testJni_testDemo_Demo.h,另外添加testDll.lib这个依赖。
好了做好这些后,build下,生成了我们期待已久的jniDll.dll,把这个dll同样扔到system32下。
三 测试
本人特懒,不想写多余的class,所以直接修改Demo.java 这也是刚才为什么讲暂时如此的原因
1. package
2.
3. pblic class
4. static
5. {
6. //System.out.println(System.getProperty("java.library.path"));
7. "testDll");
8. "jniDll");
9. }
10. pblic native static int add(int a,int
11. pblic static void
12. 7,2));
13. }
14. }
四 最后补充
如果系统已经加载过c/cpp的dll,我们就不用再System.loadLibrary("testDll")了,加载一遍就可以了,因为我们刚才写的testDll系统没有加载,所以我就加载了一下。对于多个dll可以写多个System.loadLibrary去加载,修改static{}里面的内容不需要重新生成dll,除非你多加了一个调用方法,如果你看清楚规则,就不用javah命令就可以直接编写头文件,用javah太麻烦了。
本文是javaJNI调用c/cpp实例(姊妹篇之一)的续集c/cpp调用java。
计划第三篇写一个java安装程序实例(客户端无jre环境的安装包),以解决java程序(软件)安装不方便的问题,使java程序安装也傻瓜化。
直接进入正题:
完成本实例需要下列工具/环境:
1、java环境
2、c/cpp编辑器。windows下推荐用vs/vc++,我用的是vs2008。linux下gcc/g++
从 C/CPP 程序调用 Java 代码需要四个步骤 :
一 编写 Java 代码。
二 编译 Java 代码。
三 编写 C/C++ 代码。
四 运行本机 C/C++ 应用程序。
1、编写java代码
为了达到示范作用,java方法我用两个,一个是静态方法,一个是普通方法。
C2java.java
1. package
2.
3. pulic class
4. pulic
5. super();
6. }
7. pblic static int add(int a,int
8. return
9. }
10. pblic boolean judge(boolean
11. return
12. }
13.
14. }
静态方法的好处是我不用实例化,直接可以调用方法。调用起来比较简单,不容易出错。
2、编译java代码
javac 命令。(略)
3、编写 C/C++ 代码
我想在c/cpp中直接生成一个exe然后窗口输出结果,所以我就建立一个exe工程。编辑器jni环境是上篇已经搭建好的,所以这里只需要少量配置就可以了。好了,我们先建立一个工程:
打开vs2008,新建一 win32 console App 工程
键入工程名字c2java,点击OK,出来窗口点击next,选取console app
点击完成。到这里先不忙编码实现,我们先把环境搭建好,右键工程属性,选取 linker -->input,在右边窗口添加依赖jvm.lib,这个lib的位置在你%JAVA_HOME%/lib 下。如果你的路径中同我一样包含空格(例如Program Files)记得用引号括起来。
打开stdafx.h文件添加
1. #include <iostream>
2. #include <jni.h>
3.
4. #ifdef _WIN32
5. #define PATH_SEPARATOR ';'
6. #else
7. #define PATH_SEPARATOR ':'
8. #endif
打开c2java.cpp,键入下面的代码
1. using namespace
2.
3. int
4. {
5.
6. JavaVMOption options[1];
7. JNIEnv *env;
8. JavaVM *jvm;
9. JavaVMInitArgs vm_args;
10. long
11. jclass cls;
12. jmethodID mid;
13. jint square;
14. jboolean not;
15. jobject jobj;
16.
17. "-Djava.class.path=.";
18. vm_args.version = JNI_VERSION_1_2;
19. vm_args.nOptions = 1;
20. vm_args.options = options;
21. void**)&env, &vm_args);
22. if
23. {
24. "com/testJni/testDemo/C2java");
25. if(cls !=0)
26. {
27. "add", "(II)I");
28. if(mid !=0)
29. {
30. square = env->CallStaticIntMethod( cls, mid, 5,5);
31. std::cout << square << std::endl;
32. }
33. "<init>","()V");
34. if(mid !=0)
35. {
36. jobj=env->NewObject(cls,mid);
37. "init ok"
38. }
39. "judge","(Z)Z");
40. if(mid !=0)
41. {
42. not = env->CallBooleanMethod(jobj, mid, 1);
43. if(!not){
44. "Boolean ok"
45. }
46. }
47.
48. }
49.
50. jvm->DestroyJavaVM();
51. return
52. }
53. else
54. return
55.
56. }
下面解释下上面的代码:
JavaVMOption options[] 具有用于 JVM 的各种选项设置。声明的 JavaVMOption options[] 数组足够大,就能容纳我们希望使用的所有选项。在本实例中,我们使用的选项就是类路径选项。
JNIEnv *env 表示 JNI 执行环境。
JavaVM *jvm 是指向 JVM 的指针。我们主要使用这个指针来创建、初始化和销毁 JVM。JavaVMInitArgs vm_args 表示可以用来初始化 JVM 的各种 JVM 参数。
设置参数后,创建我们的jvm :
status = JNI_CreateJavaVM(&jvm, (void**)&env, &vm_args);
成功返回0,不成功返回JNI_ERR。
创建完成后,我们就可以查找我们的class了,因为我们的java类一般都有包,所以我们也要加上包路径com/testJni/testDemo/C2java
在这里我们会使用到java的一个命令javap ,这个命令有什么用那,我们用javap -s -p C2java看看
打开jni.h我们会发现,Signature就是sig,也就是GetStaticMethodID( cls, "add", "(II)I")方法的第三个参数。GetStaticMethodID表示调用static方法,GetMethodID调用普通方法。下面就是传入参数,打出结果。
在看jni.h的时候我们注意到有 CallStaticXXXMethod() 和 CallXXXMethod() 之类的方法。这些方法分别代表调用静态方法和成员方法,用方法的返回类型(例如,Object、Boolean、Byte、Char、Int、Long 等等)代替变量 XXX。
静态方法和普通方法不同之处就是普通方法必须要先实例化一个java对象,调用构造器的时候方法的名称为“<init>”。
下面的代码就不用我再解释了,先是new一个实例出来,然后调用实例的方法。
最后记得销毁jvm。
代码解释完了,我们build下这个工程,生成c2java.exe。
4、运行exe
因为我们生成的exe需要调用jvm.dll初始化,为了使运行的exe不报错误,我们把%JAVA_HOME%/jre/bin/server也加进path目录。方便系统自动搜索jvm.dll。
运行结果:
最后补充:本实例并没有涉及到java的异常、java c/cpp的编码转换问题,对于异常问题,C里没有异常,请使用jni的异常处理函数。编码转换问题上篇已有介绍,此处略去。