java高級用法之JNA中使用類型映射

更新時間：2022年03月30日 10:58:47 作者：程序那些事

JNA中有很多種映射，本文主要介紹了java高級用法之JNA中使用類型映射，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

簡介

JNA中有很多種映射，library的映射，函數(shù)的映射還有函數(shù)參數(shù)和返回值的映射，libary和函數(shù)的映射比較簡單，我們在之前的文章中已經(jīng)講解過了，對于類型映射來說，因為JAVA中的類型種類比較多，所以這里我們將JNA的類型映射提取出來單獨講解。

類型映射的本質(zhì)

我們之前提到在JNA中有兩種方法來映射JAVA中的方法和native libary中的方法，一種方法叫做interface mapping，一種方式叫做direct mapping。

但是我們有沒有考慮過這兩種映射的本質(zhì)是什么呢？

比如native有一個方法，我們是如何將JAVA代碼中的方法參數(shù)傳遞給native方法，并且將native方法的返回值轉(zhuǎn)換成JAVA中函數(shù)的返回類型呢？

答案就是序列化。

因為本質(zhì)上一切的交互都是二進制的交互。JAVA類型和native類型進行轉(zhuǎn)換，最簡單的情況就是JAVA類型和native類型底層的數(shù)據(jù)長度保持一致，這樣在進行數(shù)據(jù)轉(zhuǎn)換的時候就會更加簡單。

我們看下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浮點數(shù)	float
double	64-bit浮點數(shù)	double
pointer (e.g. void*)	平臺相關	Buffer Pointer
pointer (e.g. void*), array	平臺相關	[] (原始類型數(shù)組)

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

除了JAVA自帶的類型映射，JNA內(nèi)部也定義了一些數(shù)據(jù)類型，可以跟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**	字符串數(shù)組	String[]
wchar_t**	字符串數(shù)組(unicode)	WString[]
void**	pointers數(shù)組	Pointer[]
struct* struct	結(jié)構(gòu)體指針和結(jié)構(gòu)體	Structure
union	結(jié)構(gòu)體	Union
struct[]	結(jié)構(gòu)體數(shù)組	Structure[]
void (*FP)()	函數(shù)指針 (Java or native)	Callback
pointer ( *)	指針	PointerType
other	整數(shù)類型	IntegerType
other	自定義映射類型	NativeMapped

TypeMapper

除了定義好的映射關系之外，大家也可以使用TypeMapper來對參數(shù)類型進行自定義轉(zhuǎn)換，先來看下TypeMapper的定義：

public interface TypeMapper {

    FromNativeConverter getFromNativeConverter(Class<?> javaType);

    ToNativeConverter getToNativeConverter(Class<?> javaType);
}

TypeMapper是一個interface，它定義了兩個converter方法，分別是getFromNativeConverter和getToNativeConverter。

如果要使用TypeMapper則需要實現(xiàn)它而這兩個方法即可。我們看一下官方的W32APITypeMapper是怎么實現(xiàn)的：

 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中實現(xiàn)了toNative，fromNative和nativeType三個方法。在這個例子中，native type是WString，而JAVA type是String。而這個TypeConverter就是最終要使用的FromNativeConverter和ToNativeConverter。

有了typeMapper，應該怎么使用呢？最簡單的方法就是將其添加到Native.load的第三個參數(shù)中，如下所示：

 TestLibrary lib = Native.load("testlib", TestLibrary.class, Collections.singletonMap(Library.OPTION_TYPE_MAPPER, mapper));

NativeMapped

TypeMapper需要在調(diào)用Native.load方法的時候傳入，從而提供JAVA類型和native類型的轉(zhuǎn)換關系。TypeMapper可以看做是類型轉(zhuǎn)換關系的外部維護者。

可能很多朋友已經(jīng)想到了，既然能在JAVA類型外部維護轉(zhuǎn)換關系，那么可不可以在JAVA類型本身對這個轉(zhuǎn)換關系進行維護呢？答案是肯定的，我們只需要在要實現(xiàn)轉(zhuǎn)換類型關系的JAVA類型實現(xiàn)NativeMapped接口即可。

先來看下NativeMapped接口的定義：

public interface NativeMapped {

    Object fromNative(Object nativeValue, FromNativeContext context);

    Object toNative();

    Class<?> nativeType();
}

可以看到NativeMapped中定義要實現(xiàn)的方法基本上和FromNativeConverter、ToNativeConverter中定義的方法一致。

下面舉一個具體的例子來說明一下NativeMapped到底應該怎么使用。首先我們定義一個enum類實現(xiàn)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;
        }
    }

這個類實現(xiàn)了從Integer到TestEnum枚舉的轉(zhuǎn)換。

要想使用該TestEnum類的話，需要定義一個interface：

    public static interface EnumerationTestLibrary extends Library {
        TestEnum returnInt32Argument(TestEnum arg);
    }

具體調(diào)用邏輯如下：

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中已經(jīng)包含了類型轉(zhuǎn)換的信息，所以不需要再指定TypeMapper了。

注意，這里用到了testlib，這個testlib是從JNA的native模塊中編譯出來的，如果你是MAC環(huán)境的話可以拷貝JNA代碼，運行ant native即可得到，編譯完成之后，將這個libtestlib.dylib拷貝到你項目中的resources目錄下面darwin-aarch64或者darwin-x86即可。

有不會的同學，可以聯(lián)系我。