Java JNI 调用C/C++ 本地库（dll/so)

Java JNI 调用C/C++ 本地库（dll/so)
阅读目录

一. 什么是JNI

JNI是Java Native Interface的缩写，它提供了若干的API实现了Java和其他语言的通信（主要是C&C++）。从Java1.1开始，JNI标准成为java平台的一部分，它允许Java代码和其他语言写的代码进行交互。JNI一开始是为了本地已编译语言，尤其是C和C++而设计的，但是它并不妨碍你使用其他编程语言，只要调用约定受支持就可以了。使用java与本地已编译的代码交互，通常会丧失平台可移植性。但是，有些情况下这样做是可以接受的，甚至是必须的。例如，使用一些旧的库，与硬件、操作系统进行交互，或者为了提高程序的性能。JNI标准至少要保证本地代码能工作在任何Java 虚拟机环境下。
　　总的来说，JNI就是一个允许Java语言和其他编程语言(主要是C/C++)通信的接口。C/C++是系统级的编程语言, 可以用来开发任何和系统相关的程序和类库, 但是Java本身编写底层的应用比较难实现, 使用JNI可以调用现有的本地库, 极大地灵活了Java的开发. C/C++的效率是目前最好的语言, 可以使用C/C++来实现一些实时性非常高的部分. C/C++和Java本身都是非常流行的编程语言, 一些大型软件中经常使用语言之间的混合编程.
　　一旦使用JNI, JAVA程序就丧失了JAVA平台的两个优点: 程序不在跨平台。要想跨平台，必须在不同的系统环境中重新编译本地语言部分；程序不再是绝对安全的，本地代码的不当使用可能导致整个程序崩溃。一个通用的规则是，你应该让本地方法集中在少数几个类当中，这样就降低了Java语言和C/C++之间的耦合性。

　使用JNI实现Java与C语言混合编程的基本步骤如下：

1. 编写带有native声明的方法的java类
2. 使用javac命令编译所有的java类
3. 然后使用javah + 类名生成扩展名为.h的头文件(javah 包名.类名）
4. 使用C/C++实现本地方法
5. 将C/C++编写的文件生成动态链接库
6. 将编译生成的动态库文件放到java工程中，运行java jni程序

二. 编写带有native声明的方法的java类

public class Sample
{
    public static void main(String[] args)
    {
        System.loadLibrary("SampleC"); 
        NativeMethodTest nmt = new NativeMethodTest();

        int square = nmt.intMethod(5);
        boolean bool = nmt.booleanMethod(true);
        String text = nmt.stringMethod("java");
        int sum = nmt.intArrayMethod(new int[]{1,2,3,4,5,6,7,8,13});

        System.out.println("intMethod: " + square);
        System.out.println("booleanMethod:" + bool);
        System.out.println("stringMethod:" +text);
        System.out.println("intArrayMethod:" + sum);
    }
}

class NativeMethodTest
{   
    public native int intMethod(int n);
    public native boolean booleanMethod(boolean bool);
    public native String stringMethod(String text);
    public native int intArrayMethod(int[] intArray);
}

上面NativeMethodTest类中有四个native关键字声明的方法，分别是4种类型的参数, int, boolean, String, int[]. 其中 System.loadLibrary(“SampleC”); 这行代码加载了本地动态链接库，在Windows系统下加载的就是SampleC.dll, 在Linux系统下加载的就是SampleC.so。注意不可以在代码中写上扩展名.dll或者.so。本文使用的是Windows系统，加载的是SampleC.dll，这个DLL文件就是我们稍后要使用C/C++编译生成的文件。
　　这4个native关键字修饰的方法就是需要我们用C/C++实现的方法。

三. 使用javac命令编译所有的java类

编译Sample.java，使用命令行(Windows下是cmd) javac Sample.java 可以看到生成两个class文件：
Sample.class, NativeMethodTest.class(本示例未新建java包名)

四. 使用javah命令生成.h文件（javah 包名.类名)

命令行中运行 javah NativeMethodTest 可以生成NativeMethodTest.h文件，注意不是 javah Sample , native关键字修饰的方法在那个类中就使用javah命令生成对应的头文件。NativeMethodTest.h的代码如下(假如添加了包名com.csdn.test,生成的.h文件中的方法为Java_包名NativeMethodTest_intMethod，class NativeMethodTest中的native方法名不变）

/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class NativeMethodTest */

#ifndef _Included_NativeMethodTest
#define _Included_NativeMethodTest
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     NativeMethodTest
 * Method:    intMethod
 * Signature: (I)I
 */
JNIEXPORT jint JNICALL Java_NativeMethodTest_intMethod
  (JNIEnv *, jobject, jint);

/*
 * Class:     NativeMethodTest
 * Method:    booleanMethod
 * Signature: (Z)Z
 */
JNIEXPORT jboolean JNICALL Java_NativeMethodTest_booleanMethod
  (JNIEnv *, jobject, jboolean);

/*
 * Class:     NativeMethodTest
 * Method:    stringMethod
 * Signature: (Ljava/lang/String;)Ljava/lang/String;
 */
JNIEXPORT jstring JNICALL Java_NativeMethodTest_stringMethod
  (JNIEnv *, jobject, jstring);

/*
 * Class:     NativeMethodTest
 * Method:    intArrayMethod
 * Signature: ([I)I
 */
JNIEXPORT jint JNICALL Java_NativeMethodTest_intArrayMethod
  (JNIEnv *, jobject, jintArray);

#ifdef __cplusplus
}
#endif
#endif

　这个h文件相当于我们在java里面的接口，这里声明了四个方法，然后在我们的本地方法里面实现这个方法，也就是说我们在编写C/C++程序的时候所使用的方法名必须和这里的一致。

　　在注释中我们可以看到这样一个东西 Signature, 这个是方法的签名. 关于Signature, 下面通过一个表格来说明.

java类型	Signature	备注
boolean	Z
byte	B
char	C
short	S
int	I
long	L
float	F
double	D
void	V
Object	L用/分割的完整类名	例如: Ljava/lang/String表示String类型
Array	[签名	例如: [I表示int类型的数组, [Ljava/lang/String表示String类型的数组
Method	(参数签名)返回类型签名	例如: ([I)I表示参数类型为int数组，返回值int类型的方法

五. 使用C/C++实现本地方法

# include "NativeMethodTest.h"
# include <string.h>

JNIEXPORT jint JNICALL Java_NativeMethodTest_intMethod
  (JNIEnv * env, jobject obj, jint i)
{
    return i * i;
}

JNIEXPORT jboolean JNICALL Java_NativeMethodTest_booleanMethod
  (JNIEnv * env, jobject obj, jboolean b)
{
    return !b;
}

JNIEXPORT jstring JNICALL Java_NativeMethodTest_stringMethod
  (JNIEnv * env, jobject obj, jstring string)
{
    const char* str = (*env)->GetStringUTFChars(env, string, 0);
    char cap[128];
    strcpy(cap, str);
    (*env)->ReleaseStringUTFChars(env, string, 0);
    return (*env)->NewStringUTF(env, strupr(cap));
}

JNIEXPORT jint JNICALL Java_NativeMethodTest_intArrayMethod
  (JNIEnv * env, jobject obj, jintArray array)
{
    int i, sum = 0;
    jsize len = (*env)->GetArrayLength(env, array);
    jint * body = (*env)->GetIntArrayElements(env, array, 0);

    for (i=0; i<len; i++)
    {
        sum += body[i];
    }
    (*env)->ReleaseIntArrayElements(env, array, body, 0);
    return sum;
}

(*env)->GetStringUTFChars()这个方法, 是用来在Java和C之间转换字符串的, 因为Java本身都使用了双字节的字符, 而C语言本身都是单字节的字符, 所以需要进行转换.
　　JNIEnv *是每个函数都有的参数, 它包含了很多有用的方法, 使用起来类似Java的反射, 也提供了这样一个编码转换的函数.
　　GetStringUTFChars()和NewStringUTF(), 第一个是从UTF-8转换为C的编码格式, 第二个是根据C的字符串返回一个UTF8字符串.
　　ReleaseStringUTFChars()是用来释放对象的, 在Java中有虚拟机进行垃圾回收, 但是在C语言中, 这些对象必须手动回收. 否则可能造成内存泄漏.
　　函数的名字一眼看到就可以猜出功能, jni.h中的大部分函数名都是这样.

六. 将C/C++编写的文件生成动态链接库

1）可以将jni.h和jin_cmd.h放在当前目录下，运行gcc -I. -shared -Wl,–kill-at -s -o Sample.dll test.c
2）也可以直接指定依赖的头文件路径 gcc -I%JAVA_HOME%\include -I%JAVA_HOME%\include\win32 -LD Sample1.c -o Sample.dll

-I(大写字母I，include的意思)是加入自己的库，也就是告诉编译器jni.h的位置。当然不加这个参数也可以，自己把jni.h和jni_md.h文件复制出来和Test.c放一起，另外include改为””
-shared表示编译成.dll库文件
-s参数可以大幅减小.dll文件的大小，不加也可以
-o表示目标文件名，不加也可以，会有默认名，但要自己改成java中导入库的名字，这里是lib
-Wl,–kill-at  防止编译后的函数名被自动加上@符号，并取消警告。(是小写字母L，不是数字1)

将编译生成的SampleC.dll文件拷贝到Sample.class所在的文件夹中，在命令行中运行：java Sample 即可看到如下结果：

intMethod: 25
booleanMethod:false
stringMethod:JAVA
intArrayMethod:49

注意: 1)64位版本的JDK可能会在运行时报错:
java.lang.UnsatisfiedLinkError: …Sample1.dll: Can’t load IA 32-bit .dll on a AMD 64-bit platform
如果您有这样的错误, 请使用32位的JDK来重新运行.考虑到兼容性问题，最好用32位的JDK和32位的gcc编译生成32位的dll动态库，方便在32位和64位的机器上运行
2)实际操作过程中还遇到了如下错误，在调用具体native函数时报错，更换编译命令后解决，编译时需要保证编译成动态库文件

Exception in thread “main” java.lang.UnsatisfiedLinkError: intMethod
at NativeMethodTest.intMethod(Native Method)
at Sample.main(Sample.java:7)
本文所用编译器为MinGW中的gcc编译器