JNI编程系列之基础篇

JNI编程系列之基础篇

最近干一个活需要从Java调用C++编译的动态链接库，研究了一下JNI，现在将网上搜罗的文档和自己的体会贡献出来。

JNI的做法是：通过在方法前加上关键字native来识别本地方法，然后用本地语言(如C，C++)来实现该方法，并编译成动态链接库，在Java的类中调用该动态链接库，然后就可以像使用Java自己的方法一样使用native方法了。这样做的好处是既具有了Java语言的便利性，又具有了C语言的效率；另一个好处是可以利用已有的C代码，避免重复开发。

下面从最简单的JNI程序入手，介绍如何进行JNI编程。

下面是一个简单的Java程序HelloWorld.java，

class HelloWorld {

    private native void print();

    public static void main(String[] args) {

        new HelloWorld().print();

    }

    static {

        System.loadLibrary("HelloWorld");

    }

}

在这个例子中，注意到两个关键的地方。

首先是第二行
private native void print();
如果没有native关键字，这一行代码就是普通Java方法的声明。关键字native表明这是一个用本地语言实现的方法。

第二个地方是
System.loadLibrary("HelloWorld");
这行代码的作用是调用名为HelloWorld的动态链接库，在Windows下，是HelloWorld.dll，在Linux下是HelloWorld.so。

显然现在这个Java程序是不能运行的。要运行它先要做下面的工作。执行
> javac HelloWorld.java
> javah -jni HelloWorld
执行完这两条语句之后，会生成一个名为HelloWorld.h的文件，它的内容应该是这样的，

/* DO NOT EDIT THIS FILE - it is machine generated */

#include <jni.h>

/* Header for class HelloWorld */

#ifndef _Included_HelloWorld

#define _Included_HelloWorld

#ifdef __cplusplus

extern "C" {

#endif

/*

* Class:     HelloWorld

* Method:    print

* Signature: ()V

*/

JNIEXPORT void JNICALL Java_HelloWorld_print (JNIEnv *, jobject);

#ifdef __cplusplus

}

#endif

#endif

注意到在这个程序的开头有这样一行代码，
#include <jni.h>
这里的jni.h，只要你安装了JDK就能在安装目录下找到它。

不要修改这个文件的内容，现在要做的是写一个名为HelloWorld.cpp程序，实现上面这个.h文件里的函数，

#include "HelloWorld.h"

#include <iostream>

JNIEXPORT void JNICALL Java_HelloWorld_print (JNIEnv *, jobject) {

    std::cout << "Hello World!" << std::endl;

}

这是一个最简单的C++程序。将它编译为动态链接库，我们得到HelloWorld.dll，将这个.dll文件拷到HelloWorld.java文件所在的目录下。执行
> java HelloWorld
你会看到屏幕上输出
> Hello World!

现在来总结一下，要实现JNI编程，需要以下几个步骤：
1. 写一个Java程序，将你希望用C语言实现的方法用native关键字标识出来，同时加上调用动态链接库的语句。
   System.loadLibrary("HelloWorld");
2. 执行下面两条语句，生成.h文件
   > javac HelloWorld.java
   > javah -jni HelloWorld
3. 根据.h文件，写一个.cpp程序，编译成动态链接库，并将其复制到.java文件所在的路径下。
4. 执行java HelloWorld

这样，就学会了最简单的JNI编程，网上能google到的大部分文章也就到此为止了。但是你一定还有很多疑问，就像我刚开始一样，最容易想到的就是，如果本地方法要传递参数或者返回值怎么办？本地方法的定义在.java文件中，参数或者返回值的类型都是Java的类型。而它的实现是通过C程序完成的，参数和返回值的类型只能是C的类型。诸如此类的问题，上面这个简单的例子是回答不了的。在下一篇，我将解释这些问题。

本篇将介绍在JNI编程中如何传递参数和返回值。

首先要强调的是，native方法不但可以传递Java的基本类型做参数，还可以传递更复杂的类型，比如String，数组，甚至自定义的类。这一切都可以在jni.h中找到答案。

1. Java基本类型的传递

用过Java的人都知道，Java中的基本类型包括boolean，byte，char，short，int，long，float，double这样几种，如果你用这几种类型做native方法的参数，当你通过javah -jni生成.h文件的时候，只要看一下生成的.h文件，就会一清二楚，这些类型分别对应的类型是jboolean，jbyte，jchar，jshort，jint，jlong，jfloat，jdouble 。这几种类型几乎都可以当成对应的C++类型来用，所以没什么好说的。

2. String参数的传递

Java的String和C++的string是不能对等起来的，所以处理起来比较麻烦。先看一个例子，

class Prompt {

    // native method that prints a prompt and reads a line

    private native String getLine(String prompt);

    public static void main(String args[]) {

        Prompt p = new Prompt();

        String input = p.getLine("Type a line: ");

        System.out.println("User typed: " + input);

    }

    static {

        System.loadLibrary("Prompt");

    }

}

在这个例子中，我们要实现一个native方法
String getLine(String prompt);
读入一个String参数，返回一个String值。

通过执行javah -jni得到的头文件是这样的

#include <jni.h>

#ifndef _Included_Prompt

#define _Included_Prompt

#ifdef __cplusplus

extern "C" {

#endif

JNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject this, jstring prompt);

#ifdef __cplusplus

}

#endif

#endif

jstring是JNI中对应于String的类型，但是和基本类型不同的是，jstring不能直接当作C++的string用。如果你用
cout << prompt << endl;
编译器肯定会扔给你一个错误信息的。

其实要处理jstring有很多种方式，这里只讲一种我认为最简单的方式，看下面这个例子，

#include "Prompt.h"

#include <iostream>

JNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject obj, jstring prompt)

{

    const char* str;

    str = env->GetStringUTFChars(prompt, false);

    if(str == NULL) {

        return NULL; /* OutOfMemoryError already thrown */

    }

    std::cout << str << std::endl;

    env->ReleaseStringUTFChars(prompt, str);

    char* tmpstr = "return string succeeded";

    jstring rtstr = env->NewStringUTF(tmpstr);

    return rtstr;

}

在上面的例子中，作为参数的prompt不能直接被C++程序使用，先做了如下转换
str = env->GetStringUTFChars(prompt, false);
将jstring类型变成一个char*类型。

返回的时候，要生成一个jstring类型的对象，也必须通过如下命令，
jstring rtstr = env->NewStringUTF(tmpstr);

这里用到的GetStringUTFChars和NewStringUTF都是JNI提供的处理String类型的函数，还有其他的函数这里就不一一列举了。

3. 数组类型的传递

和String一样，JNI为Java基本类型的数组提供了j*Array类型，比如int[]对应的就是jintArray。来看一个传递int数组的例子，Java程序就不写了，

JNIEXPORT jint JNICALL Java_IntArray_sumArray(JNIEnv *env, jobject obj, jintArray arr)

{

    jint *carr;

    carr = env->GetIntArrayElements(arr, false);

    if(carr == NULL) {

        return 0; /* exception occurred */

    }

    jint sum = 0;

    for(int i=0; i<10; i++) {

        sum += carr[i];

    }

    env->ReleaseIntArrayElements(arr, carr, 0);

    return sum;

}

这个例子中的GetIntArrayElements和ReleaseIntArrayElements函数就是JNI提供用于处理int数组的函数。如果试图用arr[i]的方式去访问jintArray类型，毫无疑问会出错。JNI还提供了另一对函数GetIntArrayRegion和ReleaseIntArrayRegion访问int数组，就不介绍了，对于其他基本类型的数组，方法类似。

4. 二维数组和String数组

在JNI中，二维数组和String数组都被视为object数组，因为数组和String被视为object。仍然用一个例子来说明，这次是一个二维int数组，作为返回值。

JNIEXPORT jobjectArray JNICALL Java_ObjectArrayTest_initInt2DArray(JNIEnv *env, jclass cls, int size)

{

    jobjectArray result;

    jclass intArrCls = env->FindClass("[I");

    result = env->NewObjectArray(size, intArrCls, NULL);

    for (int i = 0; i < size; i++) {

        jint tmp[256]; /* make sure it is large enough! */

        jintArray iarr = env->NewIntArray(size);

        for(int j = 0; j < size; j++) {

            tmp[j] = i + j;

        }

        env->SetIntArrayRegion(iarr, 0, size, tmp);

        env->SetObjectArrayElement(result, i, iarr);

        env->DeleteLocalRef(iarr);

    }

    return result;

}

上面代码中的第三行，
jobjectArray result;
因为要返回值，所以需要新建一个jobjectArray对象。

jclass intArrCls = env->FindClass("[I");
是创建一个jclass的引用，因为result的元素是一维int数组的引用，所以intArrCls必须是一维int数组的引用，这一点是如何保证的呢？注意FindClass的参数"[I"，JNI就是通过它来确定引用的类型的，I表示是int类型，[标识是数组。对于其他的类型，都有相应的表示方法，

Z boolean 
B byte 
C char 
S short 
I int 
J long 
F float 
D double

String是通过“Ljava/lang/String;”表示的，那相应的，String数组就应该是“[Ljava/lang/String;”。

还是回到代码，
result = env->NewObjectArray(size, intArrCls, NULL);
的作用是为result分配空间。

jintArray iarr = env->NewIntArray(size);
是为一维int数组iarr分配空间。

env->SetIntArrayRegion(iarr, 0, size, tmp);
是为iarr赋值。

env->SetObjectArrayElement(result, i, iarr);
是为result的第i个元素赋值。

通过上面这些步骤，我们就创建了一个二维int数组，并赋值完毕，这样就可以做为参数返回了。

如果了解了上面介绍的这些内容，基本上大部分的任务都可以对付了。虽然在操作数组类型，尤其是二维数组和String数组的时候，比起在单独的语言中编程要麻烦，但既然我们享受了跨语言编程的好处，必然要付出一定的代价。

有一点要补充的是，本文所用到的函数调用方式都是针对C++的，如果要在C中使用，所有的env->都要被替换成(*env)->，而且后面的函数中需要增加一个参数env，具体请看一下jni.h的代码。另外还有些省略的内容，可以参考JNI的文档：Java Native Interface 6.0 Specification，在JDK的文档里就可以找到。如果要进行更深入的JNI编程，需要仔细阅读这个文档。接下来的高级篇，也会讨论更深入的话题。