JNA—JNI終結者

                     JNA—JNI終結者

 

介紹

給大家介紹一個最新的訪問本機代碼的Java框架—JNA。

JNA(Java Native Access)框架是一個開源的Java框架，是SUN公司主導開發的，建立在經典的JNI的基礎之上的一個框架。

JNA項目地址：https://jna.dev.java.net/

 

非常強大、易用，功能上類似與.NET的P/Invoke。

 

 

 

不堪回首的JNI

我們知道，使用JNI調用.dll/.so共享類庫是非常非常麻煩和痛苦的。

如果有一個現有的.dll/.so文件，如果使用JNI技術調用，我們首先需要另外使用C語言寫一個.dll/.so共享庫，使用SUN規定的數據結構替代C語言的數據結構，調用已有的  dll/so中公布的函數。

然后再在Java中載入這個適配器dll/so，再編寫Java   native函數作為dll中函數的代理。

經過2個繁瑣的步驟才能在Java中調用本地代碼。

因此，很少有Java程序員願意編寫調用dll/.so庫中的原生函數的java程序。這也使Java語言在客戶端上乏善可陳。可以說JNI是Java的一大弱點！

 

.NET平台上強大的P/Invoke

而在.NET平台上，強大的P/Invoke技術使我們Java程序員非常羡慕。使用P/Invoke技術，只需要使用編寫一個.NET函數，再加上一個聲明的標注，就可以直接調用dll中的函數。

不需要你再使用C語言編寫dll來適配。

 

 

不遜於P/Invoke的JNA

現在，不需要再羡慕.NET的P/Invoke機制了。JNA把對dll/.so共享庫的調用減少到了和P/Invoke相同的程度。

 

使用JNA，不需要再編寫適配用的.dll/.so，只需要在Java中編寫一個接口和一些代碼，作為.dll/.so的代理，就可以在Java程序中調用dll/so。

 

 

JNA快速啟動

 

     現在讓我們直接進入JNA的世界。

 

你只需要下載一個jar包，就可以使用JNA的強大功能方便地調用動態鏈接庫中的C函數。

1，下載jna.jar。

在這里https://jna.dev.java.net/servlets/ProjectDocumentList?folderID=7408&expandFolder=7408&folderID=0

 

 

2，現在你已經可以使用JNA了。

為了方便你參考JNA的java類庫，我制作了《JNA3.09API參考手冊》，是CHM格式的。你可以到這里下載 http://download.csdn.net/source/900438

 

 

 

 

JNA例子

 

例子1   

現在讓我們運行一個JNA程序，感受它的強大威力。

1，在Java項目中引入jna.jar包。

2，創建一個類：

 

import com.sun.jna.Library;

import com.sun.jna.Native;

import com.sun.jna.Platform;

 

/** Simple example of native library declaration and usage. */

public class HelloWorld {

 

    public interface CLibrary extends Library {

        CLibrary INSTANCE = (CLibrary)

            Native.loadLibrary((Platform.isWindows() ? "msvcrt" : "c"),

                               CLibrary.class);

   

        void printf(String format, Object... args);

    }

 

    public static void main(String[] args) {

        CLibrary.INSTANCE.printf("Hello, World/n");

        for (int i=0;i < args.length;i++) {

            CLibrary.INSTANCE.printf("Argument %d: %s/n", i, args[i]);

        }

    }

}

 

 

 

 

3，執行，可以看到控制台中打印出了

Hello, World

 

    但是，請注意，這個程序實際上是使用msvcrt.dll這個C運行時庫中的printf函數打印出上面這些字符的。

 

    看，多簡單，不需要寫一行C代碼，就可以直接在Java中調用外部動態鏈接庫中的函數！

 

例子2   

 

    上面那個例子使用了操作系統自帶的動態鏈接庫，現在我們再自己寫一個動態鏈接庫試試。

 

 

1，在VS中選擇C++語言，然后選擇創建一個Win32程序。 選擇dll類型。

 

2，發布的C函數是：

 

#define MYLIBAPI  extern   "C"     __declspec( dllexport ) 

 

MYLIBAPI void say(wchar_t* pValue);

 

 

這個函數的實現是：

 

void  say(wchar_t* pValue){

     std::wcout.imbue(std::locale("chs"));

 

     std::wcout<<L"上帝說："<<pValue<<std::endl;

}

 

它需要傳入一個Unicode編碼的字符數組。然后在控制台上打印出一段中文字符。

 

3，生成dll。然后把生成的dll文件復制到Eclipse項目中，放在項目下面。

4，在Eclipse中編寫以下代碼：

 

import com.sun.jna.Library;

import com.sun.jna.Native;

import com.sun.jna.WString;

 

/**

 * @author 沈東良 Edward Shen [e-mail]

 * 2008-11-23 下午05:07:14

 *TestDll1.dll

 */

public class TestDll1Service {

 

         public interface TestDll1 extends Library {

                   /**

                    * 當前路徑是在項目下，而不是bin輸出目錄下。

                    */

                   TestDll1 INSTANCE = (TestDll1)Native.loadLibrary("TestDll1", TestDll1.class);

                   public void say(WString value);

                  

         }

         /**

          *

          */

         public TestDll1Service() {

                   // TODO Auto-generated constructor stub

         }

 

         /**

          * @param args

          */

         public static void main(String[] args) {

                   // TODO Auto-generated method stub

                  

                   TestDll1.INSTANCE.say(new WString("Hello World!"));

                   System.out.println("HHEEH我我們無法萬惡");

         }

 

}

 

5，執行這個Java類。可以看到控制台下如下輸出：

上帝說：Hello World!

HHEEH我我們無法萬惡

 

6，上面一行是C語言使用C++的std::wcout輸出的。

下面一行是Java語言輸出的。

 

 

 

JNA技術解密

JNA工作原理

JNA是建立在JNI技術基礎之上的一個Java類庫，它使您可以方便地使用java直接訪問動態鏈接庫中的函數。

原來使用JNI，你必須手工用C寫一個動態鏈接庫，在C語言中映射Java的數據類型。

JNA中，它提供了一個動態的C語言編寫的轉發器，可以自動實現Java和C的數據類型映射。你不再需要編寫C動態鏈接庫。

當然，這也意味着，使用JNA技術比使用JNI技術調用動態鏈接庫會有些微的性能損失。可能速度會降低幾倍。但影響不大。

 

JNA技術難點

 

 

1，當前路徑是在項目下，而不是bin輸出目錄下。

2，數據結構的對應關系：

Java—C和操作系統數據類型的對應表

Java Type	C Type	Native Representation
boolean	int	32-bit integer (customizable)
byte	char	8-bit integer
char	wchar_t	platform-dependent
short	short	16-bit integer
int	int	32-bit integer
long	long long, __int64	64-bit integer
float	float	32-bit floating point
double	double	64-bit floating point
Buffer Pointer	pointer	platform-dependent (32- or 64-bit pointer to memory)
<T>[] (array of primitive type)	pointer array	32- or 64-bit pointer to memory (argument/return) contiguous memory (struct member)
除了上面的類型，JNA還支持常見的數據類型的映射。
String	char*	NUL-terminated array (native encoding or jna.encoding)
WString	wchar_t*	NUL-terminated array (unicode)
String[]	char**	NULL-terminated array of C strings
WString[]	wchar_t**	NULL-terminated array of wide C strings
Structure	struct* struct	pointer to struct (argument or return) (or explicitly) struct by value (member of struct) (or explicitly)
Union	union	same as Structure
Structure[]	struct[]	array of structs, contiguous in memory
Callback	<T> (*fp)()	function pointer (Java or native)
NativeMapped	varies	depends on definition
NativeLong	long	platform-dependent (32- or 64-bit integer)
PointerType	pointer	same as Pointer

 

 

JNA編程過程

 

JNA把一個dll/.so文件看做是一個Java接口。

Dll是C函數的集合、容器，這正和接口的概念吻合。

 

    我們定義這樣一個接口，

public interface TestDll1 extends Library {

                   /**

                    * 當前路徑是在項目下，而不是bin輸出目錄下。

                    */

                   TestDll1 INSTANCE = (TestDll1)Native.loadLibrary("TestDll1", TestDll1.class);

                   public void say(WString value);

                  

         }

 

 

如果dll是以stdcall方式輸出函數，那么就繼承StdCallLibrary。否則就繼承默認的Library接口。

 

接口內部需要一個公共靜態常量：instance。

 

TestDll1 INSTANCE = (TestDll1)Native.loadLibrary("TestDll1", TestDll1.class);

 

通過這個常量，就可以獲得這個接口的實例，從而使用接口的方法。也就是調用外部dll的函數！

 

注意：

1，Native.loadLibrary()函數有2個參數：

    1，dll或者.so文件的名字，但不帶后綴名。這符合JNI的規范，因為帶了后綴名就不可以跨操作系統平台了。

搜索dll的路徑是：

1）項目的根路徑

2）操作系統的全局路徑、

3）path指定的路徑。

 

2，第二個參數是本接口的Class類型。

 

JNA通過這個Class類型，根據指定的dll/.so文件，動態創建接口的實例。

 

2，接口中你只需要定義你需要的函數或者公共變量，不需要的可以不定義。

public void say(WString value);

 

參數和返回值的類型，應該和dll中的C函數的類型一致。

這是JNA，甚至所有跨平台調用的難點。

 

這里，C語言的函數參數是：wchar_t*。

JNA中對應的Java類型是WStirng。

 

 

所有跨平台、跨語言調用的難點

有過跨語言、跨平台開發的程序員都知道，跨平台、語言調用的難點，就是不同語言之間數據類型不一致造成的問題。絕大部分跨平台調用的失敗，都是這個問題造成的。

關於這一點，不論何種語言，何種技術方案，都無法解決這個問題。

這需要程序員的仔細開發和設計。這是程序員的責任。

 

常見的跨平台調用有：

1，Java調用C語言編寫的dll、.so動態鏈接庫中的函數。

2，.NET通過P/Invoke調用C語言編寫的dll、.so動態鏈接庫中的函數。

3，通過WEBService，在C,C++,Java,.NET等種種語言間調用。

    WebService傳遞的是xml格式的數據。

 

即使是強大的P/Invoke或者WebService，在遇到復雜的數據類型和大數據量的傳遞時，還是會碰到很大的困難。

 

因為，一種語言的復雜的數據類型，很難用另一種語言來表示。這就是跨平台調用問題的本質。

如，WEBService調用中，很多語言，如Java，.NET都有自動實現的Java/.NET類型和XML類型之間的映射的類庫或者工具。

但是，在現實的編程環境中，如果類型非常復雜，那么這些自動轉換工具常常力不從心。

要么Object-XML映射錯誤。

要么映射掉大量的內存。

 

因此，我個人對這些Object-XML映射框架相當不感冒。

我現在使用WEBService，都是直接手工使用xml處理工具提取xml中的數據構建對象。或者反過來，手工根據Object中的屬性值構建xml數據。

 

 

Java和C語言之間的調用問題，也是如此。

Java要調用C語言的函數，那么就必須嚴格按照C語言要求的內存數量提供Java格式的數據。要用Java的數據類型完美模擬C語言的數據類型。

JNA已經提供了大量的類型匹配C語言的數據類型。

 

 

 

跨平台、跨語言調用的第一原則：就是盡量使用基本、簡單的數據類型，盡量少跨語言、平台傳遞數據！

只有你才能拯救你自己。

如果在你的程序中，有復雜的數據類型和龐大的跨平台數據傳遞。那么你必須另外寫一些Façade接口，把需要傳遞的數據類型簡化，把需要傳遞的數據量簡化。

否則，不論是實現的難度還是程序的性能都很難提高。

 

 

 

 

JNI還是不能廢

我們已經見識了JNA的強大。JNI和它相比是多么的簡陋啊！

但是，有些需求還是必須求助於JNI。

JNA是建立在JNI技術基礎之上的一個框架。

使用JNI技術，不僅可以實現Java訪問C函數，也可以實現C語言調用Java代碼。

而JNA只能實現Java訪問C函數，作為一個Java框架，自然不能實現C語言調用Java代碼。此時，你還是需要使用JNI技術。

JNI是JNA的基礎。是Java和C互操作的技術基礎。