Java JNI調用本地動態庫使用詳解

java native方法與JNI實現

native方法定義:        php

      簡單地講,一個Native Method就是一個java調用非java代碼的接口。一個Native Method是這樣一個java的方法:該方法的實現由非java語言實現,好比C。這個特徵並不是java所特有,不少其它的編程語言都有這一機制,好比在C++中,你能夠用extern "C"告知C++編譯器去調用一個C的函數。html

VM怎樣使Native Method跑起來:
    咱們知道,當一個類第一次被使用到時,這個類的字節碼會被加載到內存,而且只會回載一次。在這個被加載的字節碼的入口維持着一個該類全部方法描述符的list,這些方法描述符包含這樣一些信息:方法代碼存於何處,它有哪些參數,方法的描述符(public之類)等等。
    若是一個方法描述符內有native,這個描述符塊將有一個指向該方法的實現的指針。這些實如今一些DLL文件內,可是它們會被操做系統加載到java程序的地址空間。當一個帶有本地方法的類被加載時,其相關的DLL並未被加載,所以指向方法實現的指針並不會被設置。當本地方法被調用以前,這些DLL纔會被加載,這是經過調用java.system.loadLibrary()實現的。java

 

2.概述

今天在看Java多線程編程的時候,發現Thread這個類中有多個native方法,之前歷來沒有見過這種方法,所以對於比較好奇,查閱了一些資料,如今整理一下,以做備忘。linux

 

2.1.native關鍵字用法

native是與C++聯合開發的時候用的!使用native關鍵字說明這個方法是原生函數,也就是這個方法是用C/C++語言實現的,而且被編譯成了DLL,由java去調用。 這些函數的實現體在DLL中,JDK的源代碼中並不包含,你應該是看不到的。對於不一樣的平臺它們也是不一樣的。這也是java的底層機制,實際上java就是在不一樣的平臺上調用不一樣的native方法實現對操做系統的訪問的。總而言之:c++

  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。windows

Jvm封裝了各類操做系統實際的差別性的同時,提供了jni技術,使得開發者能夠經過java程序(代碼)調用到操做系統相關的技術實現的庫函數,從而與其餘技術和系統交互,使用其餘技術實現的系統的功能;同時其餘技術和系統也能夠經過jni提供的相應原生接口開調用java應用系統內部實現的功能。多線程

在windows系統上,通常可執行的應用程序都是基於native的PE結構,windows上的jvm也是基於native結構實現的。Java應用體系都是構建於jvm之上。app

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 <jni.h>  
/* 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 <stdio.h>  
#include <jni.h>  
/* 
 * 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.hD:\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 <jni.h>
/* 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的使用方法。基本步驟同上。下面給出主要示例代碼。
一、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");
    }

}

二、生成動態庫部分

NativeAgent.h

/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* 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 <stdio.h>
#include <stdlib.h>
#include <jni.h>

#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;

}

三、編譯生成動態庫

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

這裏有二個很是重要的地方,要十分注意:
一、對於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)

二、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簡單實例

相關文章
相關標籤/搜索