java高級用法之:在JNA中使用類型映射
簡介
JNA中有很多種映射，library的映射，函數的映射還有函數參數和返回值的映射，libary和函數的映射比較簡單，我們在之前的文章中已經講解過了，對於類型映射來說，因為JAVA中的類型種類比較多，所以這裡我們將JNA的類型映射提取出來單獨講解。
類型映射的本質
我們之前提到在JNA中有兩種方法來映射JAVA中的方法和native libary中的方法，一種方法叫做interface mapping，一種方式叫做direct mapping。
但是我們有沒有考慮過這兩種映射的本質是什麼呢？
比如native有一個方法，我們是如何將JAVA程式碼中的方法參數傳遞給native方法，並且將native方法的返回值轉換成JAVA中函數的返回類型呢？
答案就是序列化。
因為本質上一切的交互都是二進位的交互。JAVA類型和native類型進行轉換，最簡單的情況就是JAVA類型和native類型底層的數據長度保持一致，這樣在進行數據轉換的時候就會更加簡單。
我們看下JAVA類型和native類型的映射和長度關係：
| C Type | Native類型的含義 | Java Type |
|---|---|---|
| char | 8-bit整型 | byte |
| wchar_t | 和平台相關 | char |
| short | 16-bit整型 | short |
| int | 32-bit整型 | int |
| int | boolean flag | boolean |
| enum | 枚舉類型 | int (usually) |
| long long, __int64 | 64-bit整型 | long |
| float | 32-bit浮點數 | float |
| double | 64-bit浮點數 | double |
| pointer (e.g. void*) | 平台相關 | Buffer Pointer |
| pointer (e.g. void*), array | 平台相關 |
[] (原始類型數組) |
上面的JAVA類型都是JDK自帶的類型（Pointer除外）。
除了JAVA自帶的類型映射，JNA內部也定義了一些數據類型，可以跟native的類型進行映射：
| C Type | Native類型的含義 | Java Type |
|---|---|---|
| long | 和平台相關(32- or 64-bit integer) | NativeLong |
| const char* | 字元串 (native encoding or jna.encoding) | String |
| const wchar_t* | 字元串 (unicode) | WString |
| char** | 字元串數組 | String[] |
| wchar_t** | 字元串數組(unicode) | WString[] |
| void** | pointers數組 | Pointer[] |
| struct* struct | 結構體指針和結構體 | Structure |
| union | 結構體 | Union |
| struct[] | 結構體數組 | Structure[] |
| void (*FP)() | 函數指針 (Java or native) | Callback |
| pointer ( |
指針 | PointerType |
| other | 整數類型 | IntegerType |
| other | 自定義映射類型 | NativeMapped |
TypeMapper
除了定義好的映射關係之外，大家也可以使用TypeMapper來對參數類型進行自定義轉換，先來看下TypeMapper的定義：
public interface TypeMapper {
FromNativeConverter getFromNativeConverter(Class<?> javaType);
ToNativeConverter getToNativeConverter(Class<?> javaType);
}
TypeMapper是一個interface，它定義了兩個converter方法，分別是getFromNativeConverter和getToNativeConverter。
如果要使用TypeMapper則需要實現它而這兩個方法即可。我們看一下官方的W32APITypeMapper是怎麼實現的：
TypeConverter stringConverter = new TypeConverter() {
@Override
public Object toNative(Object value, ToNativeContext context) {
if (value == null)
return null;
if (value instanceof String[]) {
return new StringArray((String[])value, true);
}
return new WString(value.toString());
}
@Override
public Object fromNative(Object value, FromNativeContext context) {
if (value == null)
return null;
return value.toString();
}
@Override
public Class<?> nativeType() {
return WString.class;
}
};
addTypeConverter(String.class, stringConverter);
addToNativeConverter(String[].class, stringConverter);
首先定義一個TypeConverter，在TypeConverter中實現了toNative，fromNative和nativeType三個方法。在這個例子中，native type是WString，而JAVA type是String。而這個TypeConverter就是最終要使用的FromNativeConverter和ToNativeConverter。
有了typeMapper，應該怎麼使用呢？最簡單的方法就是將其添加到Native.load的第三個參數中，如下所示：
TestLibrary lib = Native.load("testlib", TestLibrary.class, Collections.singletonMap(Library.OPTION_TYPE_MAPPER, mapper));
NativeMapped
TypeMapper需要在調用Native.load方法的時候傳入，從而提供JAVA類型和native類型的轉換關係。TypeMapper可以看做是類型轉換關係的外部維護者。
可能很多朋友已經想到了，既然能在JAVA類型外部維護轉換關係，那麼可不可以在JAVA類型本身對這個轉換關係進行維護呢？答案是肯定的，我們只需要在要實現轉換類型關係的JAVA類型實現NativeMapped介面即可。
先來看下NativeMapped介面的定義：
public interface NativeMapped {
Object fromNative(Object nativeValue, FromNativeContext context);
Object toNative();
Class<?> nativeType();
}
可以看到NativeMapped中定義要實現的方法基本上和FromNativeConverter、ToNativeConverter中定義的方法一致。
下面舉一個具體的例子來說明一下NativeMapped到底應該怎麼使用。首先我們定義一個enum類實現NativeMapped介面：
public enum TestEnum implements NativeMapped {
VALUE1, VALUE2;
@Override
public Object fromNative(Object nativeValue, FromNativeContext context) {
return values()[(Integer) nativeValue];
}
@Override
public Object toNative() {
return ordinal();
}
@Override
public Class<?> nativeType() {
return Integer.class;
}
}
這個類實現了從Integer到TestEnum枚舉的轉換。
要想使用該TestEnum類的話，需要定義一個interface：
public static interface EnumerationTestLibrary extends Library {
TestEnum returnInt32Argument(TestEnum arg);
}
具體調用邏輯如下：
EnumerationTestLibrary lib = Native.load("testlib", EnumerationTestLibrary.class);
assertEquals("Enumeration improperly converted", TestEnum.VALUE1, lib.returnInt32Argument(TestEnum.VALUE1));
assertEquals("Enumeration improperly converted", TestEnum.VALUE2, lib.returnInt32Argument(TestEnum.VALUE2));
可以看到，因為NativeMapped中已經包含了類型轉換的資訊，所以不需要再指定TypeMapper了。
注意，這裡用到了testlib，這個testlib是從JNA的native模組中編譯出來的，如果你是MAC環境的話可以拷貝JNA程式碼，運行ant native即可得到，編譯完成之後，將這個libtestlib.dylib拷貝到你項目中的resources目錄下面darwin-aarch64或者darwin-x86即可。
有不會的同學，可以聯繫我。
總結
本文講解了JNA中的類型映射規則和自定義類型映射的方法。
本文的程式碼：//github.com/ddean2009/learn-java-base-9-to-20.git
本文已收錄於 www.flydean.com
最通俗的解讀，最深刻的乾貨，最簡潔的教程，眾多你不知道的小技巧等你來發現！
歡迎關注我的公眾號:「程式那些事」,懂技術，更懂你！
