.Net Core 為 x86 和 x64 程序集編寫 AnyCPU 包裝

前言

       這幾天研究了一下 vJoy 這個虛擬游戲手柄驅動，感覺挺好玩的。但是使用時發現一個問題，C# SDK 中的程序集被分為 x86 和 x64 兩個版本，如果直接在 AnyCPU 平台編譯運行就有隱患，在32位系統中運行程序時會因為程序集版本不兼容而崩潰。這個 SDK 的兩個版本文件名完全相同，根據 .Net 程序集的加載規則，我們是無法在不做任何工作的情況下實現共存的。對於平台特定程序集，目前的主流做法是把程序集放到以平台名稱命名的文件夾中。通過一個包裝程序集完成載入和調用。

正文

       我這里的包裝使用了 .Net Core 的 AssemblyLoadContext 為中介完成 SDK 的動態加載。不過這種包裝方式也有個很麻煩的地方，不能像正常引用的程序集那樣享受各種智能提示，只能使用反射的方式調用實際庫中的各種功能。為方便使用，包裝庫需要在內部完成反射處理並對外公開一套 API 方便使用。

定義程序集載入上下文

       因為資源由內部管理，不需要對外暴露，我這里的上下文是公開 API 的私有內部類，加載上下文的可重寫方法中還有一個是用於非托管程序集的。這個上下文很智能，會自動查找被加載程序集的相同文件夾，所以無需重寫，如果依賴程序集在其他位置，需要重寫加載方法。

        private class VJoyAssemblyLoadContext : AssemblyLoadContext
        {
            public VJoyAssemblyLoadContext() : base(isCollectible: true)
            {
            }

            protected override Assembly Load(AssemblyName name)
            {
                return null;
            }
        }

定義反射資源管理器

       其中 _is64BitRuntime 是關鍵，用 IntPtr.Size == 8 可以判斷當前進程運行在 x86 還是 x64 模式，並在之后用於生成程序集加載路徑。因為管理器的定位相當於驅動信息管理，所以只需要一個實例。在這里使用了私有構造方法加公共靜態的實例獲取方法來管理對象資源。

       程序集載入后使用 Activator.CreateInstance 創建實例，然后使用 GetMethod 獲取方法成員后就可以反射調用實例方法了。不過一直反射調用可能會造成巨大的性能損失，粗略估計最高可以達到上百倍，如果條件允許，最好能把方法緩存起來，以后調用既方便又高效。具體就是下面代碼中定義的 Delegate 和 Fun<> 型變量，用於緩存方法信息。反射獲取方法信息后可以調用 CreateDelegate 方法生成委托，靜態方法和實例方法都可以。對於 Func<> 和 Action<> 來說需要進行強制類型轉換。實際使用時盡量使用 Func<> 和 Action<>，如果方法的參數或返回值類型定義在動態加載的程序集中就只能使用 Delegate 來緩存了，同時也只能使用 DynamicInvoke 方法來調用。

       下面的代碼中的 DriverMatch 方法的參數有 ref 修飾符，對於這種參數類型，內置的 Func<> 無法封裝，需要自行定義委托類型，我這里因為只用一次，所以就沒管了，Invoke 調用的時候 .Net 會負責處理 ref、out、in 修飾符，相應地調用方法修改后的對象也會反映到傳入的參數對象中。如果要定義相應的委托，看起來應該長這樣：

public delegate TResult Func<T1, T2, T3, out TResult>(in T1 arg1, out T2 arg2, ref T3 arg3);

       定義示例：

    public class VJoyControllerManager
    {
        private static readonly bool _is64BitRuntime = IntPtr.Size == 8;
        private static readonly object _locker = new object();
        private static VJoyControllerManager _manager = null;

        private VJoyAssemblyLoadContext _vJoyAssemblyLoadContext;
        private Assembly _vJoyInterfaceWrapAssembly;
        private object _joystick;
        private Type _vJoyType;
        //省略相似代碼……

        private Delegate _getVJDStatusFunc;
        private Delegate _getVJDAxisExist;
        private Func<uint, int> _getVJDButtonNumber;
        //省略相似代碼……

        public bool IsVJoyEnabled { get; }
        public bool DriverMatch { get; }
        public uint DllVer { get; }
        public uint DrvVer { get; }
        //省略相似代碼……

        private VJoyControllerManager()
        {
            var path = Process.GetCurrentProcess().MainModule.FileName;
            var filePath = $@"{path.Substring(0, path.LastIndexOf('\\'))}\{(_is64BitRuntime ? "x64" : "x86")}\vJoyInterfaceWrap.dll";

            _vJoyAssemblyLoadContext = new VJoyAssemblyLoadContext();
            _vJoyInterfaceWrapAssembly = _vJoyAssemblyLoadContext.LoadFromAssemblyPath(filePath);
            _joystick = Activator.CreateInstance(_vJoyInterfaceWrapAssembly.GetTypes().Single(t => t.Name == "vJoy"));
            _vJoyType = _joystick.GetType();

            IsVJoyEnabled = (bool)_vJoyType.GetMethod("vJoyEnabled").Invoke(_joystick, null);

            //省略相似代碼……

            _getVJDButtonNumber = (Func<uint, int>)_vJoyType.GetMethod("GetVJDButtonNumber").CreateDelegate(typeof(Func<uint, int>), _joystick);

            var funcType = typeof(Func<,>).MakeGenericType(new Type[] { typeof(uint), _VjdStatEnumType });
            _getVJDStatusFunc = _vJoyType.GetMethod("GetVJDStatus").CreateDelegate(funcType, _joystick);

            funcType = typeof(Func<,,>).MakeGenericType(new Type[] { typeof(uint), _hidUsagesEnumType, typeof(bool) });
            _getVJDAxisExist = _vJoyType.GetMethod("GetVJDAxisExist").CreateDelegate(funcType, _joystick);

            var args = new object[] { 0u, 0u };
            DriverMatch = (bool)_vJoyType.GetMethod("DriverMatch").Invoke(_joystick, args);
            DllVer = (uint)args[0];
            DrvVer = (uint)args[1];
        }

        public static VJoyControllerManager GetManager()
        {
            if (_manager == null)
                lock (_locker)
                    if (_manager == null)
                        _manager = new VJoyControllerManager();

            return _manager;
        }

        public static void ReleaseManager()
        {
            if (_manager != null)
                lock (_locker)
                    if (_manager != null)
                    {
                        _manager._axisEnumValues = null;
                        //省略相似代碼……
                        
                        _manager.UnLoadContext();
                        _manager = null;
                    }

        }

        private void UnLoadContext()
        {
            _vJoyAssemblyLoadContext.Unload();
            _vJoyAssemblyLoadContext = null;
        }

        public object GetVJDStatus(uint id) => IsVJoyEnabled ? _getVJDStatusFunc.DynamicInvoke(id) : null;

        public int GetVJDButtonNumber(uint id) => IsVJoyEnabled ? _getVJDButtonNumber(id) : 0;

        public bool GetVJDAxisExist(uint id, USAGES usages) => IsVJoyEnabled ? (bool)_getVJDAxisExist.DynamicInvoke(new object[] { id, _axisEnumValues[(int)usages] }) : false;

    //省略相似代碼……
    }

       剩下的部分基本就是用這個套路把剩下要用的東西封裝緩存后供外界使用。感興趣的話，完整代碼可以在文章末尾到我的 GitHub 項目中查看。

結語

       用這個方法可以把分開的平台綁定程序集封裝到一個 AnyCPU 程序集里。對於要與原生 dll 交互的項目，在原生封裝時就完成這一步最好。如果封裝也是分開的，這個辦法就可以再封裝一次，用來適配 AnyCPU 平台。

       在我的 GitHub 項目中有個 vJoyDemo 項目，是使用示例。

 

       轉載請完整保留以下內容並在顯眼位置標注，未經授權刪除以下內容進行轉載盜用的，保留追究法律責任的權利！

　　本文地址：https://www.cnblogs.com/coredx/p/12455761.html

　　完整源代碼：Github

　　里面有各種小東西，這只是其中之一，不嫌棄的話可以Star一下。