linux下jni编程指南之——HelloWorld

Posted on 2011-05-14 08:40 Braincol 阅读(222) 评论(0) 编辑 收藏

    该示例源于jni官方编程指南——《The Java™ NativeInterface Programmer’s Guide and Specification》。

    本文通过一个简单的例子来演示如何使用JNI。我们写一个JAVA程序，并用它调用一个C函数来打印“Hello World!”。

    这个过程包含下面几步：

    1、 创建一个类（HelloWorld.java）声明本地方法。

    2、 使用javac编译源文件HollowWorld.java，产生HelloWorld.class。使用javah –jni来生成C头文件（HelloWorld.h），这个头文件里面包含了本地方法的函数原型。

    3、 用C/C++代码写函数原型的实现。

    4、 把C/C++函数实现编译成一个本地库，生成libHelloWorld.so。

    5、 使用java命令运行HelloWorld程序，类文件HelloWorld.class和本地库(libHelloWorld.so)在运行时被加载。

     这个流程如下图所示：

jni-helloworld

 

    现在我们按上述步骤一步步的实现：

一、创建HelloWorld.java

class HelloWorld
{
    private native void print();
    public static void main(String[] args)
    {
        new HelloWorld().print();
    }

    static
    {
        System.loadLibrary("HelloWorld");
    }
}


二、生成HelloWorld.class、HelloWorld.h

    1. 编译HelloWorld.java生成HelloWorld.class

    CD到HelloWorld.java所在的目录，在命令行中运行如下命令：

    javac HelloWorld.java

在当前文件夹编译生成HelloWorld.class。

    2.生成HelloWorld.h

    在命令行中运行：

    javah -jni HelloWorld

可能会提示如下错误：

    error: cannot access HelloWorld
    file HelloWorld.class not found
    javadoc: error - Class HelloWorld not found.

错误的原因的是java的classpath没有包含当前路劲,解决办法有两种：

   用下面的命令行代替

    javah -classpath $PWD -jni HelloWorld

或者：

    export CLASSPATH=$CLASSPATH:$PWD; 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


该文件中包含了一个函数Java_HelloWorld_print的声明。这里面包含两个参数，非常重要，后面讲实现的时候会讲到。

三、用C/C++代码写函数原型的实现

    在当前目录下创建HelloWorld.cpp， 内容如下：

#include <jni.h>
#include <stdio.h>
#include "HelloWorld.h"

JNIEXPORT void JNICALL

    Java_HelloWorld_print(JNIEnv *env, jobject obj)
{
    printf("Hello World!\n");
}

    注意必须要包含jni.h头文件，该文件中定义了JNI用到的各种类型，宏定义等。jni头文件存在于你jdk的安装路劲下，比如我的jdk安装在 /usr/lib/jvm/java-1.5.0-sun 目录下， 那么jni.h就存在于/usr/lib/jvm/java-1.5.0-sun/include目录下，这个路径待会会用到。

    另外需要注意Java_HelloWorld_print的两个参数，本例比较简单，不需要用到这两个参数。但是这两个参数在JNI中非常重要。env代表java虚拟机环境，Java传过来的参数和c有很大的不同，需要调用JVM提供的接口来转换成C/C++类型的，就是通过调用env方法来完成转换的。obj代表调用的对象，相当于c++的this。当 c/C++ 函数需要改变调用对象成员变量时，可以通过操作这个对象来完成。

四、 把C/C++函数实现编译成一个本地库，生成libHelloWorld.so

    在终端执行如下命令生成libHelloWorld.so：

    g++ -I/usr/lib/jvm/java-1.5.0-sun/include/linux/ -I/usr/lib/jvm/java-1.5.0-sun/include/ -fPIC -shared -o libHelloWorld.so HelloWorld.cpp

    在当前目录生成libHelloWorld.so。注意一定需要包含Java的include目录（请根据自己系统环境设定），因为Helloworld.c中包含了jni.h。

另外一个值得注意的是在HelloWorld.java中我们LoadLibrary方法加载的是“HelloWorld”，可我们生成的 Library却是libHelloWorld。这是Linux的链接规定的，一个库的必须要是：lib+库名+.so。链接的时候只需要提供库名就可以了

五、 使用java命令运行HelloWorld程序

    在终端中输入运行HelloWorld程序：

    java HelloWorld

   可能会出现如下错误：

    Exception in thread "main" java.lang.NoClassDefFoundError: HelloWorld

出现这个错误也是因为CLASSPATH环境变量没有包含当前目录,解决方法与上面提到的一样：

    java -classpath $PWD HelloWorld

或者：

    export CLASSPATH=$CLASSPATH:$PWD; java HelloWorld

紧接着可能也会出现下面的一个错误：

    Exception in thread "main" java.lang.UnsatisfiedLinkError: no HelloWorld in java.library.path
        at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1682)
        at java.lang.Runtime.loadLibrary0(Runtime.java:822)
        at java.lang.System.loadLibrary(System.java:993)
        at HelloWorld.<clinit>(HelloWorld.java:11)

这个错误的原因是LD_LIBRARY_PATH环境变量没有包含当前目录，HelloWorld程序无法找到libHelloWorld.so这个库，解决办法如下：

    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD; export CLASSPATH=$CLASSPATH:$PWD; java HelloWorld

这样就能看到我们想要的结果了：

    Hello World!



其实，在生成HelloWorld.h之前，我们就可以先修改好 LD_LIBRARY_PATH、CLASSPATH 这两个环境变量：

    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD; export CLASSPATH=$CLASSPATH:$PWD

这样生成HelloWorld.h 就只需命令： javah –jni HelloWorld； 运行HelloWorld只需命令： java HelloWorld 了。

在这里给出一个jni学习资料的下载链接：