java高階用法之:在JNA中使用型別對映

flydean發表於2022-04-14
Java型別

簡介

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 TypeNative型別的含義Java Type
char8-bit整型byte
wchar_t和平臺相關char
short16-bit整型short
int32-bit整型int
intboolean flagboolean
enum列舉型別int (usually)
long long, __int6464-bit整型long
float32-bit浮點數float
double64-bit浮點數double
pointer (e.g. void*)平臺相關Buffer Pointer
pointer (e.g. void*), array平臺相關<P>[] (原始型別陣列)

上面的JAVA型別都是JDK自帶的型別（Pointer除外）。

除了JAVA自帶的型別對映，JNA內部也定義了一些資料型別，可以跟native的型別進行對映：

C TypeNative型別的含義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 (<T> *)指標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中的型別對映規則和自定義型別對映的方法。

本文的程式碼：https://github.com/ddean2009/learn-java-base-9-to-20.git

本文已收錄於 www.flydean.com

最通俗的解讀，最深刻的乾貨，最簡潔的教程，眾多你不知道的小技巧等你來發現！

歡迎關注我的公眾號:「程式那些事」,懂技術，更懂你！

相關文章