Java JNI调用本地动态库使用详解

java native方法与JNI实现

native方法定义：        

      简单地讲，一个Native Method就是一个java调用非java代码的接口。一个Native Method是这样一个java的方法：该方法的实现由非java语言实现，比如C。这个特征并非java所特有，很多其它的编程语言都有这一机制，比如在C＋＋中，你可以用extern "C"告知C＋＋编译器去调用一个C的函数。

VM怎样使Native Method跑起来：
    我们知道，当一个类第一次被使用到时，这个类的字节码会被加载到内存，并且只会回载一次。在这个被加载的字节码的入口维持着一个该类所有方法描述符的list，这些方法描述符包含这样一些信息：方法代码存于何处，它有哪些参数，方法的描述符（public之类）等等。
    如果一个方法描述符内有native，这个描述符块将有一个指向该方法的实现的指针。这些实现在一些DLL文件内，但是它们会被操作系统加载到java程序的地址空间。当一个带有本地方法的类被加载时，其相关的DLL并未被加载，因此指向方法实现的指针并不会被设置。当本地方法被调用之前，这些DLL才会被加载，这是通过调用java.system.loadLibrary()实现的。

 

2.概述

今天在看Java多线程编程的时候，发现Thread这个类中有多个native方法，以前从来没有见过这种方法，因此对于比较好奇，查阅了一些资料，现在整理一下，以作备忘。

 

2.1.native关键字用法

native是与C++联合开发的时候用的！使用native关键字说明这个方法是原生函数，也就是这个方法是用C/C++语言实现的，并且被编译成了DLL，由java去调用。 这些函数的实现体在DLL中，JDK的源代码中并不包含，你应该是看不到的。对于不同的平台它们也是不同的。这也是java的底层机制，实际上java就是在不同的平台上调用不同的native方法实现对操作系统的访问的。总而言之：

1. native 是用做java 和其他语言（如c++）进行协作时使用的，也就是native 后的函数的实现不是用java写的。
2.  既然都不是java，那就别管它的源代码了，我们只需要知道这个方法已经被实现即可。
3. native的意思就是通知操作系统， 这个函数你必须给我实现，因为我要使用。 所以native关键字的函数都是操作系统实现的， java只能调用。
4. java是跨平台的语言，既然是跨了平台，所付出的代价就是牺牲一些对底层的控制，而java要实现对底层的控制，就需要一些其他语言的帮助，这个就是native的作用了

2.2JNI简介

native方法是通过java中的JNI实现的。JNI是Java Native Interface的 缩写。从Java 1.1开始，Java Native Interface (JNI)标准成为java平台的一部分，它允许Java代码和其他语言写的代码进行交互。JNI一开始是为了本地已编译语言，尤其是C和C++而设计 的，但是它并不妨碍你使用其他语言，只要调用约定受支持就可以了。使用java与本地已编译的代码交互，通常会丧失平台可移植性。但是，有些情况下这样做是可以接受的，甚至是必须的，比如，使用一些旧的库，与硬件、操作系统进行交互，或者为了提高程序的性能。JNI标准至少保证本地代码能工作在任何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，其大致的结构如下图：

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

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

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

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

 

2.3JN的书写步骤

1. 编写带有native声明的方法的java类，生成.java文件
2. 使用javac命令编译所编写的java类，生成.class文件
3. 使用javah -jni java类名生成扩展名为h的头文件，也即生成.h文件
4. 使用C/C++（或者其他编程想语言）实现本地方法，创建.h文件的实现，也就是创建.cpp文件实现.h文件中的方法
5. 将C/C++编写的文件生成动态连接库，生成dll文件

3.JNI实例

下列是所有操作都是在目录：D:\JNI 下进行的，这样做的好处是便于控制。还有另外一个要求是我们的java类不含包名，当前我只测试成功不含包名的类型。

3.1.编写带有native声明的方法的java类：HelloWorld.java

public class HelloWorld {  
    public native void displayHelloWorld();// java native方法申明  
  
    static {  
        System.loadLibrary("HelloWorldImpl");// 装入动态链接库，"HelloWorldImpl"是要装入的动态链接库名称。  
    }  
  
    public static void main(String[] args) {  
        // TODO Auto-generated method stub  
        HelloWorld helloWorld = new HelloWorld();  
        helloWorld.displayHelloWorld();  
    }  
}  

3.2.使用javac命令编译所编写的java类

1. d:\JNI>javac HelloWorld.java  

执行完上述命令以后生成D:\JNI\HelloWorld.class文件

3.3.使用javah -jni java类名生成扩展名为h的头文件

d:\JNI>javah -jni HelloWorld  

执行完上述命令以后生成D:\JNI\HelloWorld.h文件，该文件内容如下：

/* DO NOT EDIT THIS FILE - it is machine generated */  
#include   
/* Header for class HelloWorld */  
  
#ifndef _Included_HelloWorld  
#define _Included_HelloWorld  
#ifdef __cplusplus  
extern "C" {  
#endif  
/* 
 * Class:     HelloWorld 
 * Method:    displayHelloWorld 
 * Signature: ()V 
 */  
JNIEXPORT void JNICALL Java_HelloWorld_displayHelloWorld  
  (JNIEnv *, jobject);  
  
#ifdef __cplusplus  
}  
#endif  
#endif  

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

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

创建HelloWorldImpl.cpp，代码如下所示：

#include "HelloWorld.h"  
#include   
#include   
/* 
 * Class:     HelloWorld 
 * Method:    displayHelloWorld 
 * Signature: ()V 
 */  
JNIEXPORT void JNICALL Java_HelloWorld_displayHelloWorld  
  (JNIEnv *, jobject)  
 {  
    printf("Hello World!\n");  
    return;  
}  

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

将D:\Program Files\Java\jdk1.6.0_26\include\jni.h和D:\Program Files\Java\jdk1.6.0_26\include\win32\jni_md.h这两个文件拷贝到D:\JNI\目录下。与HelloWorldImpl.cpp同目录，目录结构如下图所示：

3.7 执行 cl/LD D:\JNI\HelloWorldImpl.cpp  得到HelloWorldImpl.dll文件

我使用的是visual studio 2010，要使用其中的cl命令，必须打开visual studio 命令行，如下图所示：

然后再命令行中输入如下命令

1. cl/LD D:\JNI\HelloWorldImpl.cpp    

具体如下图所示：

执行完上述命令以后，我们在C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC可以看到生成的四个文件，分别是：

• HelloWorldImpl.dll
• HelloWorldImpl.exp
• HelloWorldImpl.lib
• HelloWorldImpl.obj

将其中的HelloWorldImpl.dll拷贝到D:\JNI\目录下。

3.8.执行class得到结果

在cmd中运行：

d:\JNI>java HelloWorld  

具体如下图所示：

===============================================================================================

案例2：

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

本例基于Windows平台，首先生成被调用的目的dll动态库：Lib4JNI.dll
Lib4JNI动态库中导出了一个add方法。在本例中用JNI去调用。

// dllmain.cpp : Defines the entry point for the DLL application.
#include "stdafx.h"
#include "stdlib.h"
#include "stdio.h"

BOOL APIENTRY DllMain( HMODULE hModule,
                       DWORD  ul_reason_for_call,
                       LPVOID lpReserved
                                    )
{

       switch (ul_reason_for_call)
       {
       case DLL_PROCESS_ATTACH:
       case DLL_THREAD_ATTACH:
       case DLL_THREAD_DETACH:
       case DLL_PROCESS_DETACH:
              break;
       }
       return TRUE;
}


extern "C"
int _declspec(dllexport) add(int a, int b)
{
       int iResult = a + b;
       printf("%d + %d = ", a, b);
       return iResult;
}

接下来要做的是，使用中介（或者叫代理）dll调用目的动态库（目的动态库就是本例中的Lib4JNI.dll）。在Java中，是不可以直接调用目的动态库的。因此，需要有一个中介（或代理），由本地的Java代码先调用这个中介（或代理）动态库，再由这个中介（或代理）动态库调用目的动态库。
我们给中介dll起个名字，叫做Lib2Invoke。生成这个中介dll的过程比较复杂，下面，我们用分解动作，详细说明。

第一步：需要创建本地Java的调用代码。

public class TestJNI {
   public native int getNumber(int a, int b); //声明Native方法

   public static void main(String[] args) {
   }
} 

将以上代码，以文本形式，保存为TestJNI.java。

第二步：用javac编译。javac TestJNI.java

第三步：用javah生成中介（或代理）动态库的头文件。javah TestJNI，运行后，生成TestJNI.h文件，本例中生成的文件示例如下：

/* DO NOT EDIT THIS FILE - it is machine generated */
#include 
/* Header for class TestJNI */

#ifndef _Included_TestJNI
#define _Included_TestJNI
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     TestJNI
 * Method:    getNumber
 * Signature: (II)I
 */
JNIEXPORT jint JNICALL Java_TestJNI_getNumber
  (JNIEnv *, jobject, jint, jint);

#ifdef __cplusplus
}
#endif
#endif

第四步：生成中介（或代理）动态库
为什么到这里才开始生成中介dll呢？因为，我们需要上一步生成的TestJNI.h，作为中介dll的头文件。详细请参考代码。

// dllmain.cpp : Defines the entry point for the DLL application.
#include "stdafx.h"

#include "jni.h"    //在这里，我们要注意的是，需要引用
#include "TestJNI.h" 

#ifdef WIN32
       #ifdef _X86_
              #define _T(x) x
       #else
              #ifdef _AMD64_
              #define _T(x) L ## x
              #endif
       #endif
#endif

BOOL APIENTRY DllMain( HMODULE hModule,
                       DWORD  ul_reason_for_call,
                       LPVOID lpReserved
                                    )
{
       switch (ul_reason_for_call)
       {
       case DLL_PROCESS_ATTACH:
       case DLL_THREAD_ATTACH:
       case DLL_THREAD_DETACH:
       case DLL_PROCESS_DETACH:
              break;
       }
       return TRUE;
}


JNIEXPORT jint JNICALL Java_TestJNI_getNumber
(JNIEnv * env, jobject o, jint x, jint y)
{
       typedef int(*ADD)(int, int);//函数指针类型
       HINSTANCE Hint = ::LoadLibrary(_T("Lib4JNI.dll"));//加载我们刚才生成的dll
       ADD add = (ADD)GetProcAddress(Hint, "add");//取得dll导出的add方法
       return add(x, y);

       FreeLibrary(Hint);
}

编译完成后，生成了我们需要的中介（或代理）动态库Lib2Invoke.dll。

第五步： 完善本地Java调用代码。

public class TestJNI {

   public native int getNumber(int a, int b);

   public static void main(String[] args) {
      System.loadLibrary("Lib2Invoke");
      TestJNI p = new TestJNI();
      System.out.println(p.getNumber(100, 100));
   }
}

编译完成后，把生成的class文件，和Lib4JNI.dll、Lib2Invoke.dll放在一个目录下。

第六步：执行 java TestJNI
执行成功后即会输出结果。

另一种可以选择的方法JNative。以程序员特有的本质，少说话，多代码：

import org.xvolks.jnative.JNative;
import org.xvolks.jnative.Type;
import org.xvolks.jnative.exceptions.NativeException;

public class TestJNI {
    static JNative myjnative = null;

     public int getnumber(int a, int b) throws NativeException,
            IllegalAccessException {

        try {
            if (myjnative == null) {
                myjnative = new JNative("Lib4JNI.dll", "add");
                myjnative.setRetVal(Type.INT);
            }

            myjnative.setParameter(0, a);
            myjnative.setParameter(1, b);

            myjnative.invoke();
            return myjnative.getRetValAsInt();
        } finally {
            if (myjnative != null) {
                myjnative.dispose();
            }
        }
    }

    public static void main(String[] args) throws NativeException, IllegalAccessException {
        test uc = new test();
        int result = uc.getnumber(1,100);

        System.err.println("result:" + result);
    }
}

优点是：不用中介dll，不用生成.h中介头文件
缺点是：（缺点不准确，只是为了对齐优点）需要外部包支持。

再来说说Linux平台下JNI的使用方法。基本步骤同上。下面给出主要示例代码。
1、Java调用部分

NativeAgent.java

public class NativeAgent {

    static
    {
        try {
            System.loadLibrary("NativeAgent");
        }
        catch(UnsatisfiedLinkError e) {
            System.err.println(">>> Can not load library: " + e.toString());
        }
    }

    public native int toConsole(String s);

    public static void main(String[] args) {

        NativeAgent na = new NativeAgent();

        na.toConsole("This is a JNI Project test.\n");
    }

}

2、生成动态库部分

NativeAgent.h

/* DO NOT EDIT THIS FILE - it is machine generated */
#include 
/* Header for class NativeAgent */

#ifndef _Included_NativeAgent
#define _Included_NativeAgent
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     NativeAgent
 * Method:    toConsole
 * Signature: (Ljava/lang/String;)I
 */
JNIEXPORT jint JNICALL Java_NativeAgent_toConsole
  (JNIEnv *, jobject, jstring);

#ifdef __cplusplus
}
#endif
#endif

NativeAgent.c

#include 
#include 
#include 

#include "NativeAgent.h"

JNIEXPORT jint JNICALL Java_NativeAgent_toConsole(JNIEnv *pEnv, jobject obj, jstring str) {

    const char* msg = (*pEnv)->GetStringUTFChars(pEnv, str, 0);

    printf("%s", msg);

    return 0;

}

3、编译生成动态库

javac NativeAgent.java

javah NativeAgent

gcc -o libNativeAgent.so -I/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.102-1.b14.el7_2.x86_64/include -I/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.102-1.b14.el7_2.x86_64/include/linux -I. -fPIC -shared NativeAgent.c

java -Djava.library.path=. NativeAgent

这里有二个非常重要的地方，要十分注意：
1、对于System.loadLibrary("NativeAgent");
在Linux下，动态库输出的文件名要是libNativeAgent.so。
也就是说，如果System.loadLibrary("XXX")；那么，在导出动态库时，动态库的名字就要是libXXX。否则，会报错：

java.lang.UnsatisfiedLinkError: no NativeAgent in java.library.path
Exception in thread "main" java.lang.UnsatisfiedLinkError: NativeAgent.toConsole(Ljava/lang/String;)I
        at NativeAgent.toConsole(Native Method)
        at NativeAgent.main(NativeAgent.java:20)

2、Linux一般默认的java.library.path在/usr/lib下。也可以自己通过VM参数-Djava.library.path=/usr/lib来显式的指定；或者通过增加环境变量export LD_LIBRARY_PATH=~/JavaNativeTest:$LD_LIBRARY_PATH

 

1.参考文献：

http://blog.csdn.net/youjianbo_han_87/article/details/2586375

http://blog.csdn.net/yangjiali014/article/details/1633017

http://blog.chinaunix.net/space.php?uid=7437948&do=blog&id=2054823

http://www.iteye.com/topic/72543

http://www.enet.com.cn/article/2007/1029/A20071029886398.shtml

http://blog.csdn.net/heqingrong623/article/details/3906350

参考1:用JNI调用C或C++动态联接库原来如此简单

参考2：JNI技术实践小结

参考3：jni简单实例