原创 初识JNI

摘自：http://www.iteye.com/topic/304594

JNI技术实践小结

xx组  kimmking

2008年11月12日

 ="MsoNormal" style="margin: 0cm 0cm 0pt;">       昨天和一部zzz一起研究解决一个java调用第三方dll的问题，从零开始学习了jni技术的应用，现在总结如下。

       事情的起因是一部的一个项目需要用到一个爱国者提供的基于U盘的加密技术。对方提供了U盘和一个dll动态链接库hiddenIO.dll。在U盘的隐藏区域内可以储存USB-Key信息，通过这个dll里的两个方法可以使用c/c++编写程序在U盘的隐藏区域读写信息，对方提供了示例代码。由于一部的项目是基于SWT/RCP技术的，所以需要在java程序中调用这两个方法。

 

 

 

       目前java与dll交互的技术主要有3种：jni，jawin和jacob。Jni（Java Native Interface）是sun提供的java与系统中的原生方法交互的技术（在windows\linux系统中，实现java与native method互调）。目前只能由c/c++实现。后两个都是sourceforge上的开源项目，同时也都是基于jni技术的windows系统上的一个应用库。Jacob（Java-Com Bridge）提供了java程序调用microsoft的com对象中的方法的能力。而除了com对象外，jawin（Java/Win32 integration project）还可以win32-dll动态链接库中的方法。就功能而言：jni >> jawin>jacob，其大致的结构如下图：

 

 

jni技术体系功能结构图

 

就易用性而言，正好相反：jacob>jawin>>jni。

Jvm封装了各种操作系统实际的差异性的同时，提供了jni技术，使得开发者可以通过java程序（代码）调用到操作系统相关的技术实现的库函数，从而与其他技术和系统交互，使用其他技术实现的系统的功能；同时其他技术和系统也可以通过jni提供的相应原生接口开调用java应用系统内部实现的功能。

在windows系统上，一般可执行的应用程序都是基于native的PE结构，windows上的jvm也是基于native结构实现的。Java应用体系都是构建于jvm之上。

 

 

 

Windows系统上的java体系

 

Jni对于应用本身来说，可以看做一个代理模式。对于开发者来说，需要使用c/c++来实现一个代理程序（jni程序）来实际操作目标原生函数，java程序中则是jvm通过加载并调用此jni程序来间接地调用目标原生函数。

 

 

Jni调用过程示意图

 

 

 

 

 

Jni程序开发的一般操作步骤如下：

l         编写java中的调用类

l         用javah生成c/c++原生函数的头文件

l         c/c++中调用需要的其他函数功能，实现原生函数(原则上可以调用任何资源)

l         将项目依赖的所有原生库和资源加入到java项目的java.library.path

l         生成java程序

l         发布java应用和dll库

 

 

Jni程序开发示例：

1、  在eclipse项目中新建一个TestHello.java，输入以下内容：

public class TestHello {

 

  static {

     System.loadLibrary("TestHello");

  }

 

  public static native void hello(String msg);

 

  public static void main(String[] args) {

    

     hello("Hello,Kimm!");

    

  }

 

}

编译生成TestHello.class文件。

2、  在命令行下使用javah TestHello命令，生成TestHello.h头文件（就是jni代理stub的接口）。

3、  在VC6中新建一个项目TestHello, 项目类型为Win32 Dynamic-Link Library。点击OK。

 

 

 

 

在弹出的窗口中选择A simple DLL project，点击Finish。

 

 

 

 

打开项目所在的文件目录，将步骤2中生成的TestHello.h文件复制到此目录。点击左边中间的FileView，切换到文件浏览模式。在Header Files上点击右键，选择Add Files to Folder…。

选择TestHello.h文件，点击OK。

 

 

 

打开StdAfx.h文件，再最后面添加：

#include <jni.h>

#include "TestHello.h"

 

 

打开TestHello.cpp文件，在最后面添加一段代码：

JNIEXPORT void JNICALL Java_TestHello_hello(JNIEnv * env, jclass obj, jstring jMsg)

{

    const char *strMsgPtr = env->GetStringUTFChars( jMsg , 0);   

 

       MessageBox( 0, strMsgPtr,"Message box from VC++ ", 0 );

 

       env->ReleaseStringUTFChars( jMsg, strMsgPtr); 

 

}

 

 

在VC的菜单上选择Tools-Options…，打开选项对话框。在Directories文件夹，添加上jdk所在文件夹下的include和include\win32文件夹。

 

点击VC上的菜单项Build-Build All，生成TestHello.dll。

4、  将VC项目Debug文件夹中的TestHello.dll复制到TestHello.class所在的文件夹下。

5、  在命令行下输入java TestHello，弹出MessageBox对话框。调用win32 api成功。

 

 

还有一篇博文，对代码的解释更详细些，摘自：

http://blog.csdn.net/drean725/article/details/1599116

JNI是Java Native Interface的 缩写。从Java 1.1开始，Java Native Interface (JNI)标准成为java平台的一部分，它允许Java代码和其他语言写的代码进行交互。JNI一开始是为了本地已编译语言，尤其是C和C++而设计 的，但是它并不妨碍你使用其他语言，只要调用约定受支持就可以了。

      使用java与本地已编译的代码交互，通常会丧失平台可移植性。但是，有些情况下这样做是可以接受的，甚至是必须的，比如，使用一些旧的库，与硬件、操作 系统进行交互，或者为了提高程序的性能。JNI标准至少保证本地代码能工作在任何Java 虚拟机实现下。

一、JNI（Java Native Interface）的设计目的

      ·The standard Java class library may not support the platform-dependent features needed by your application.
      ·You may already have a library or application written in another programming language and you wish to make it accessible to Java applications
      ·You may want to implement a small portion of time-critical code in a lower-level programming language, such as assembly, and then have your Java application call these functions

二、JNI（Java Native Interface）的书写步骤

      ·编写带有native声明的方法的java类
      ·使用javac命令编译所编写的java类
      ·使用javah ?jni java类名生成扩展名为h的头文件
      ·使用C/C++实现本地方法
      ·将C/C++编写的文件生成动态连接库

1) 编写java程序：
这里以HelloWorld为例。
代码1：

声明native方法：如果你想将一个方法做为一个本地方法的话，那么你就必须声明改方法为native的，并且不能实现。其中方法的参数和返回值在后面讲述。
Load动态库：System.loadLibrary("hello");加载动态库（我们可以这样理解：我们的方法displayHelloWorld()没有实现，但是我们在下面就直接使用了，所以必须在使用之前对它进行初始化）这里一般是以static块进行加载的。同时需要注意的是System.loadLibrary();的参数“hello”是动态库的名字。
main()方法是函数得入口点。

2) 编译
javac HelloWorld.java

3) 生成扩展名为h的头文件
javah  HelloWorld

头文件的内容：

（这里我们可以这样理解：这个h文件相当于我们在java里面的接口，这里声明了一个 Java_HelloWorld_displayHelloWorld (JNIEnv *, jobject);方法，然后在我们的本地方法里面实现这个方法，也就是说我们在编写C/C++程序的时候所使用的方法名必须和这里的一致）。

4) 编写本地方法（c/c++程序）
实现和由javah命令生成的头文件里面声明的方法名相同的方法。
代码2：

注意第1行，需要将jni.h（该文件可以在%JAVA_HOME%/include文件夹下面找到）文件引入，因为在程序中的JNIEnv、jobject等类型都是在该头文件中定义的；

另外在第2行需要将HelloWorld.h头文件引入（我是这么理解的：相当于我们在编写java程序的时候，实现一个接口的话需要声明才可以，这里就是将HelloWorld.h头文件里面声明的方法加以实现。当然不一定是这样）。然后保存为HelloWorldImpl.c就ok了。

5) 生成动态库
这里以在Windows中为例，需要生成dll文件。在保存HelloWorldImpl.c文件夹下面，使用VC的编译器cl生成。
命令行如下:cl -I%java_home%/include -I%java_home%/include/win32 -LD HelloWorldImp.c -Fehello.dll

注意：生成的dll文件名在选项-Fe后面配置，这里是hello，因为在HelloWorld.java文件中我们loadLibary的时候使 用的名字是hello。当然这里修改之后那里也需要修改。另外需要将-I%java_home%/include -I%java_home%/include/win32参数加上，因为在第四步里面编写本地方法的时候引入了jni.h文件。

6) 运行程序
java HelloWorld就ok。

三、JNI（Java Native Interface）的简要使用例子

      下面是一个简单的例子实现打印一句话的功能，但是用的c的printf最终实现。一般提供给java的jni接口包括一个so文件（封装了c函数的实现）和一个java文件（需要调用path的类）。

      1． JNI的目的是使java方法中能够调用c实现的一些函数，比如以下的java类，就需要调用一个本地函数testjni（一般声明为private native类型），首先需要创建文件weiqiong.java，内容如下：

      2．然后执行javac weiqiong.java，如果没有报错，会生成一个weiqiong.class。

      3．然后执行javah weiqiong，会生成一个文件weiqiong.h文件，其中有一个函数的声明如下：

      4．创建文件testjni.c将上面那个函数实现，内容如下：

      5．为了生成.so文件，创建makefile文件如下：
libtestjni.so:testjni.o makefile
gcc -Wall -rdynamic -shared -o libtestjni.so testjni.o
testjni.o:testjni.c weiqiong.h
gcc -Wall -c testjni.c -I./ -I/usr/java/j2sdk1.4.0/include -I/usr/java/j2sdk1.4.0/include/linux
cl:
rm -rf *.o *.so
注意：gcc前面是tab空，j2sdk的目录根据自己装的j2sdk的具体版本来写，生成的so文件的名字必须是loadLibrary的参数名前加“lib”。

      6．export LD_LIBRARY_PATH=.，由此设置library路径为当前目录，这样java文件才能找到so文件。一般的做法是将so文件copy到本机的LD_LIBRARY_PATH目录下。

      7．执行java weiqiong，打印出结果：“haha---------go into c!!!”

四．JNI（Java Native Interface）调用中考虑的问题

      在首次使用JNI的时候有些疑问，后来在使用中一一解决，下面就是这些问题的备忘：

      1。 java和c是如何互通的？
      其实不能互通的原因主要是数据类型的问题，jni解决了这个问题，例如那个c文件中的jstring数据类型就是java传入的String对象 ，经过jni函数的转化就能成为c的char*。
      对应数据类型关系如下表：

Java 类型	本地C类型	说明
boolean	jboolean	无符号，8 位
byte	jbyte	无符号，8 位
char	jchar	无符号，16 位
short	jshort	有符号，16 位
int	jint	有符号，32 位
long	jlong	有符号，64 位
float	jfloat	32 位
double	jdouble	64 位
void	void	N/A

JNI 还包含了很多对应于不同 Java 对象的引用类型

      2. 如何将java传入的String参数转换为c的char*，然后使用?
java传入的String参数，在c 文件中被jni转换为jstring的数据类型，在c文件中声明char* test，然后test = (char*)(*env)->GetStringUTFChars(env, jstring, NULL);注意：test使用完后，通知虚拟机平台相关代码无需再访问：(*env)->ReleaseStringUTFChars(env, jstring, test);

      3. 将c中获取的一个char*的buffer传递给java？
这个char*如果是一般的字符串的话，作为string传回去就可以了。如果是含有’/0’的buffer，最好作为bytearray传出，因为可以制定copy的length，如果copy到string，可能到’/0’就截断了。
      有两种方式传递得到的数据：
      一种是在jni中直接new一个byte数组，然后调用函数(*env)->SetByteArrayRegion(env, bytearray, 0, len, buffer);将buffer的值copy到bytearray中，函数直接return bytearray就可以了。
      一种是return错误号，数据作为参数传出，但是java的基本数据类型是传值，对象是传递的引用，所以将这个需要传出的byte数组用某个类包一下，如下：

这个对象作为函数的参数retobj传出，通过如下函数将retobj中的byte数组赋值便于传出。代码如下：

      4. 不知道占用多少空间的buffer，如何传递出去呢？
      在jni的c文件中new出空间，传递出去。java的数据不初始化，指向传递出去的空间即可。

五．JNI中对JAVA传入数据的处理

      如果传入的是bytearray的话，作如下处理得到buffer：

六．JAVA调用本地接口后的数据处理问题
1． java得到的数据是String的话，直接处理就可以了。
2． 得到的如果是bytearray的话，作如下处理：