JNI编程

JNI介绍

Java 本机接口（Java Native Interface (JNI)）是一个本机编程接口，它是 Java 软件开发工具箱（Java SoftwareDevelopment Kit (SDK)）的一部分。

JNI允许 Java 代码使用以其它语言（譬如 C 和 C++）编写的代码和代码库。Invocation API（JNI 的一部分）可以用来将 Java 虚拟机（JVM）嵌入到本机应用程序中，从而允许程序员从本机代码内部调用 Java 代码。

 

环境需求

JNI 最常见的两个应用：从 Java 程序调用 C/C++，以及从 C/C++ 程序调用 Java 代码

需要下列工具与组件：

• Java 编译器：随 SDK（Java 2 SDK及以上） 一起提供的 javac.exe。
• Java 虚拟机（JVM）：随 SDK 一起提供的 java.exe。
• 本机方法 C 文件生成器：随 SDK 一起提供的 javah.exe。
• 定义 JNI 的库文件和本机头文件。jni.h （C 头文件）、jvm.lib 和 jvm.dll （window下）或 libjvm.so 文件（linux下），这些文件都是随 SDK 一起提供的。
• 能够创建共享库的 C 和 C++ 编译器。最常见的两个 C 编译器是用于 Windows 的 Visual C++ 和用于基于 UNIX 系统的 gcc/cc。

用Java调用C/C++代码

当无法用 Java 语言编写整个应用程序时，JNI 允许您使用本机代码。在下列典型情况下，您可能决定使用本机代码：

• 希望用更低级、更快的编程语言去实现对时间有严格要求的代码。
• 希望从 Java 程序访问旧代码或代码库。
• 需要标准 Java 类库中不支持的依赖于平台的特性。

从 Java 代码调用 C/C++ 的六个步骤

从 Java 程序调用 C 或 C ++ 代码的过程由六个步骤组成。我们将在下面几页中深入讨论每个步骤，但还是先让我们迅速地浏览一下它们。

1. 编写 Java 代码。我们将从编写 Java 类开始，这些类执行三个任务：声明将要调用的本机方法；装入包含本机代码的共享库；然后调用该本机方法。
2. 编译 Java 代码。在使用 Java 类之前，必须成功地将它们编译成字节码。
3. 创建 C/C++ 头文件。C/C++ 头文件将声明想要调用的本机函数说明。然后，这个头文件与 C/C++ 函数实现（请参阅步骤 4）一起来创建共享库（请参阅步骤 5）。
4. 编写 C/C++ 代码。这一步实现 C 或 C++ 源代码文件中的函数。C/C++ 源文件必须包含步骤 3 中创建的头文件。
5. 创建共享库文件。从步骤 4 中创建的 C 源代码文件来创建共享库文件。
6. 运行 Java 程序。运行该代码，并查看它是否有用。我们还将讨论一些用于解决常见错误的技巧。

 

最终目录结构如下：

E:.

│  Sample1.c

│  Sample1.cpp

│  Sample1.dll

│  Sample1.exp

│  Sample1.lib

│  Sample1.obj

│  test_Sample1.h

│

└─test

        Sample1.class

        Sample1.java

步骤 1：编写 Java 代码

我们从编写 Java 源代码文件开始，它将声明本机方法（或方法），装入包含本机代码的共享库，然后实际调用本机方法。

这里是名为 Sample1.java 的 Java 源代码文件的示例：

package test;

public class Sample1 {

    public native int intMethod(int n);

    public native boolean booleanMethod(boolean bool);

    public native String stringMethod(String text);

    public native int intArrayMethod(int[] intArray);

    public static void main(String[] args) {

       System.loadLibrary("Sample1");

       Sample1 sample = new Sample1();

       int square = sample.intMethod(5);

       boolean bool = sample.booleanMethod(true);

       String text =sample.stringMethod("JAVA");

       int sum = sample.intArrayMethod(new int[] { 1, 1, 2, 3, 5, 8, 13 });

       System.out.println("intMethod: " + square);

       System.out.println("booleanMethod: " + bool);

       System.out.println("stringMethod: " + text);

       System.out.println("intArrayMethod: " + sum);

    }

}

 

这段代码做了些什么？

首先，请注意对 native 关键字的使用，它只能随方法一起使用。native 关键字告诉 Java 编译器：方法是用 Java 类之外的本机代码实现的，但其声明却在 Java 中。只能在 Java 类中声明本机方法，而不能实现它（但是不能声明为抽象的方法，使用native关键字即可），所以本机方法不能拥有方法主体。

现在，让我们逐行研究一下代码：

• 从第 3 行到第 6 行，我们声明了四个 native 方法。
• 在第 10 行，我们装入了包含这些本机方法的实现的共享库文件。（到步骤 5 时，我们将创建该共享库文件。）
• 最终，从第 12 行到第 15 行，我们调用了本机方法。注：这个操作和调用非本机 Java 方法的操作没有差异。

步骤 2：编译 Java 代码

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

cd test

javac Sample1.java

 

步骤 3：创建 C/C++ 头文件

第三步是创建 C/C++ 头文件，它定义本机函数说明。完成这一步的方法之一是使用 javah.exe，它是随 SDK 一起提供的本机方法 C 存根生成器工具。这个工具被设计成用来创建头文件，该头文件为在 Java 源代码文件中所找到的每个 native 方法定义 C 风格的函数。这里使用的命令是：

cd test/..

javah –classpath . test.Sample1

在 Sample1.java 上运行 javah.exe 的结果，生成头文件test_Sample1.h，内容如下：

/* DO NOT EDIT THIS FILE - it ismachine generated */

#include <jni.h>

/* Header for class test_Sample1 */

 

#ifndef _Included_test_Sample1

#define _Included_test_Sample1

#ifdef __cplusplus

extern "C" {

#endif

/*

 * Class:    test_Sample1

 * Method:   intMethod

 * Signature: (I)I

 */

JNIEXPORT jint JNICALLJava_test_Sample1_intMethod

 (JNIEnv *, jobject, jint);

 

/*

 * Class:    test_Sample1

 * Method:   booleanMethod

 * Signature: (Z)Z

 */

JNIEXPORT jboolean JNICALLJava_test_Sample1_booleanMethod

 (JNIEnv *, jobject, jboolean);

 

/*

 * Class:    test_Sample1

 * Method:   stringMethod

 * Signature:(Ljava/lang/String;)Ljava/lang/String;

 */

JNIEXPORT jstring JNICALLJava_test_Sample1_stringMethod

 (JNIEnv *, jobject, jstring);

 

/*

 * Class:    test_Sample1

 * Method:   intArrayMethod

 * Signature: ([I)I

 */

JNIEXPORT jint JNICALLJava_test_Sample1_intArrayMethod

 (JNIEnv *, jobject, jintArray);

 

#ifdef __cplusplus

}

#endif

#endif

 

关于 C/C++ 头文件

正如您可能已经注意到的那样，Sample1.h 中的 C/C++ 函数说明和 Sample1.java 中的 Java native 方法声明有很大差异。JNIEXPORT 和 JNICALL 是用于导出函数的、依赖于编译器的指示符。返回类型是映射到 Java 类型的 C/C++ 类型。附录 A：JNI 类型中完整地说明了这些类型。

除了 Java 声明中的一般参数以外，所有这些函数的参数表中都有一个指向 JNIEnv 和 jobject 的指针。指向 JNIEnv 的指针实际上是一个指向函数指针表的指针。正如将要在步骤 4 中看到的，这些函数提供各种用来在 C 和 C++ 中操作 Java 数据的能力。

jobject 参数引用当前对象。因此，如果 C 或 C++ 代码需要引用 Java 函数，则这个 jobject 充当引用或指针，返回调用的 Java 对象。函数名本身是由前缀“Java_”加全限定类名，再加下划线和方法名构成的。

JNI类型

JNI 使用几种映射到 Java 类型的本机定义的 C 类型。这些类型可以分成两类：原始类型和伪类（pseudo-classes）。在 C 中，伪类作为结构实现，而在 C++ 中它们是真正的类。

Java 原始类型直接映射到 C 依赖于平台的类型，如下所示：

C 类型 jarray 表示通用数组。在 C 中，所有的数组类型实际上只是 jobject 的同义类型。但是，在 C++ 中，所有的数组类型都继承了 jarray，jarray 又依次继承了 jobject。下列表显示了 Java 数组类型是如何映射到 JNI C 数组类型的。

这里是一棵对象树，它显示了 JNI 伪类是如何相关的。

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

当谈到编写 C/C++ 函数实现时，有一点需要牢记：说明必须和 Sample1.h 的函数声明完全一样。我们将研究用于 C 实现和 C++ 实现的完整代码，然后讨论两者之间的差异。

C函数实现

以下是 Sample1.c，它是用 C 编写的实现：

#include "test_Sample1.h"

#include <string.h>

 

JNIEXPORT jint JNICALLJava_test_Sample1_intMethod

   (JNIEnv *env, jobject obj, jint num) {

    return num * num;

  }

JNIEXPORT jboolean JNICALLJava_test_Sample1_booleanMethod

  (JNIEnv *env, jobject obj, jboolean boolean) {

   return!boolean;

}

 

JNIEXPORT jstring JNICALLJava_test_Sample1_stringMethod

  (JNIEnv *env, jobject obj, jstring string) {

    const char *str = (*env)->GetStringUTFChars(env, string, 0);

     charcap[128];

    strcpy(cap, str);

    (*env)->ReleaseStringUTFChars(env, string, str);

    return (*env)->NewStringUTF(env, strupr(cap));

}

 

JNIEXPORT jint JNICALL Java_test_Sample1_intArrayMethod

  (JNIEnv *env, jobject obj, jintArray array) {

     inti, 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;

}

 

void main(){}

 

C++ 函数实现

以下是 Sample1.cpp（C++ 实现）

#include "test_Sample1.h"

#include <string.h>

 

JNIEXPORT jint JNICALL Java_Sample1_intMethod

  (JNIEnv*env, jobject obj, jint num) {

   return num* num;

}

 

JNIEXPORT jboolean JNICALLJava_Sample1_booleanMethod

   (JNIEnv *env,jobject obj, jboolean boolean) {

   return!boolean;

}

 

JNIEXPORT jstring JNICALL Java_Sample1_stringMethod

   (JNIEnv*env, jobject obj, jstring string) {

     constchar *str = env->GetStringUTFChars(string, 0);

     charcap[128];

    strcpy(cap, str);

    env->ReleaseStringUTFChars(string, str);

     returnenv->NewStringUTF(strupr(cap));

}

 

JNIEXPORT jint JNICALL Java_Sample1_intArrayMethod

   (JNIEnv*env, jobject obj, jintArray array) {

     int i,sum = 0;

     jsizelen = env->GetArrayLength(array);

     jint*body = env->GetIntArrayElements(array, 0);

     for(i=0; i<len; i++)

     {   sum += body[i];

     }

    env->ReleaseIntArrayElements(array, body, 0);

     returnsum;

}

 

void main(){}

 

C 和 C++ 函数实现的比较

唯一的差异在于用来访问 JNI 函数的方法。在 C 中，JNI 函数调用由“(*env)->”作前缀，目的是为了取出函数指针所引用的值。在 C++ 中，JNIEnv 类拥有处理函数指针查找的内联成员函数。下面将说明这个细微的差异，其中，这两行代码访问同一函数，但每种语言都有各自的语法。

C 语法：jsize len = (*env)->GetArrayLength(env,array);

C++ 语法：jsize len =env->GetArrayLength(array);

 

步骤 5：创建共享库文件

接下来，我们创建包含本机代码的共享库文件。大多数 C 和 C++ 编译器除了可以创建机器代码可执行文件以外，也可以创建共享库文件。用来创建共享库文件的命令取决于您使用的编译器。下面是在 Windows 和 linux 系统上执行的命令。

Windows：使用visual studio commandprompt工具cl.exe

cl -I"C:\Program Files\Java\jdk1.6.0_23\include"-I"C:\Program Files\Java\jdk1.6.0_23\include\win32" -LD Sample1.c-FeSample1.dll

Linux：使用gcc工具

gcc -c -fPIC -I/usr/java/jdk1.6.0_22/include/-I/usr/java/jdk1.6.0_22/include/linux/ Sample1.c

gcc -shared -fPIC -o libSample1.so Sample1.o

步骤 6：运行 Java 程序

最后一步是运行 Java 程序，并确保代码正确工作。因为必须在 Java 虚拟机中执行所有 Java 代码，所以需要使用 Java 运行时环境。完成这一步的方法之一是使用 java，它是随 SDK 一起提供的 Java 解释器。所使用的命令是：

java -cp . test.Sample1

输出：

intMethod: 25

booleanMethod: false

stringMethod: JAVA

intArrayMethod: 33

故障排除

当使用 JNI 从 Java 程序访问本机代码时，您会遇到许多问题。您会遇到的三个最常见的错误是：

• 无法找到动态链接。它所产生的错误消息是：java.lang.UnsatisfiedLinkError。这通常指无法找到共享库，或者无法找到共享库内特定的本机方法。
• 无法找到共享库文件。当用 System.loadLibrary(String libname) 方法（参数是文件名）装入库文件时，请确保文件名拼写正确以及没有指定扩展名。还有，确保库文件的位置在类路径中，从而确保 JVM 可以访问该库文件。
• 无法找到具有指定说明的方法。确保您的 C/C++ 函数实现拥有与头文件中的函数说明相同的说明

摘自：http://www.cnblogs.com/BloodAndBone/archive/2010/12/22/1913882.html