1. 程式人生 > >Java中使用JNI呼叫本地動態庫的方法

Java中使用JNI呼叫本地動態庫的方法


在Java中,要使用動態庫,就要使用到 JNI。首先來看看百度百科對JNI的描述:從Java1.1開始,Java Native Interface(JNI)標準成為Java平臺的一部分,它允許Java程式碼和其他語言寫的程式碼進行互動。JNI一開始是為了本地已編譯語言,尤其是C和C++而設計的,但是它並不妨礙你使用其他語言,只要呼叫約定受支援就可以了。
使用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的使用方法。基本步驟同上。下面給出主要示例程式碼。
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 <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;

}

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