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

時間 2020-03-11

標籤 core x86 x64 程序編寫 anycpu 包裝简体版

原文原文鏈接

前言

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

正文

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

定義程序集載入上下文

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

 1         private class VJoyAssemblyLoadContext : AssemblyLoadContext
 2         {
 3             public VJoyAssemblyLoadContext() : base(isCollectible: true)
 4             {
 5             }
 6 
 7             protected override Assembly Load(AssemblyName name)
 8             {
 9                 return null;
10             }
11         }

定義反射資源管理器

其中 _is64BitRuntime 是關鍵，用 IntPtr.Size == 8 能夠判斷當前進程運行在 x86 仍是 x64 模式，並在以後用於生成程序集加載路徑。由於管理器的定位至關於驅動信息管理，因此只須要一個實例。在這裏使用了私有構造方法加公共靜態的實例獲取方法來管理對象資源。緩存

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

下面的代碼中的 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);

定義示例：ui

 1     public class VJoyControllerManager
 2     {
 3         private static readonly bool _is64BitRuntime = IntPtr.Size == 8;
 4         private static readonly object _locker = new object();
 5         private static VJoyControllerManager _manager = null;
 6 
 7         private VJoyAssemblyLoadContext _vJoyAssemblyLoadContext;
 8         private Assembly _vJoyInterfaceWrapAssembly;
 9         private object _joystick;
10         private Type _vJoyType;
11         //省略類似代碼……
12 
13         private Delegate _getVJDStatusFunc;
14         private Delegate _getVJDAxisExist;
15         private Func<uint, int> _getVJDButtonNumber;
16         //省略類似代碼……
17 
18         public bool IsVJoyEnabled { get; }
19         public bool DriverMatch { get; }
20         public uint DllVer { get; }
21         public uint DrvVer { get; }
22         //省略類似代碼……
23 
24         private VJoyControllerManager()
25         {
26             var path = Process.GetCurrentProcess().MainModule.FileName;
27             var filePath = $@"{path.Substring(0, path.LastIndexOf('\\'))}\{(_is64BitRuntime ? "x64" : "x86")}\vJoyInterfaceWrap.dll";
28 
29             _vJoyAssemblyLoadContext = new VJoyAssemblyLoadContext();
30             _vJoyInterfaceWrapAssembly = _vJoyAssemblyLoadContext.LoadFromAssemblyPath(filePath);
31             _joystick = Activator.CreateInstance(_vJoyInterfaceWrapAssembly.GetTypes().Single(t => t.Name == "vJoy"));
32             _vJoyType = _joystick.GetType();
33 
34             IsVJoyEnabled = (bool)_vJoyType.GetMethod("vJoyEnabled").Invoke(_joystick, null);
35 
36             //省略類似代碼……
37 
38             _getVJDButtonNumber = (Func<uint, int>)_vJoyType.GetMethod("GetVJDButtonNumber").CreateDelegate(typeof(Func<uint, int>), _joystick);
39 
40             var funcType = typeof(Func<,>).MakeGenericType(new Type[] { typeof(uint), _VjdStatEnumType });
41             _getVJDStatusFunc = _vJoyType.GetMethod("GetVJDStatus").CreateDelegate(funcType, _joystick);
42 
43             funcType = typeof(Func<,,>).MakeGenericType(new Type[] { typeof(uint), _hidUsagesEnumType, typeof(bool) });
44             _getVJDAxisExist = _vJoyType.GetMethod("GetVJDAxisExist").CreateDelegate(funcType, _joystick);
45 
46             var args = new object[] { 0u, 0u };
47             DriverMatch = (bool)_vJoyType.GetMethod("DriverMatch").Invoke(_joystick, args);
48             DllVer = (uint)args[0];
49             DrvVer = (uint)args[1];
50         }
51 
52         public static VJoyControllerManager GetManager()
53         {
54             if (_manager == null)
55                 lock (_locker)
56                     if (_manager == null)
57                         _manager = new VJoyControllerManager();
58 
59             return _manager;
60         }
61 
62         public static void ReleaseManager()
63         {
64             if (_manager != null)
65                 lock (_locker)
66                     if (_manager != null)
67                     {
68                         _manager._axisEnumValues = null;
69                         //省略類似代碼……
70                         
71                         _manager.UnLoadContext();
72                         _manager = null;
73                     }
74 
75         }
76 
77         private void UnLoadContext()
78         {
79             _vJoyAssemblyLoadContext.Unload();
80             _vJoyAssemblyLoadContext = null;
81         }
82 
83         public object GetVJDStatus(uint id) => IsVJoyEnabled ? _getVJDStatusFunc.DynamicInvoke(id) : null;
84 
85         public int GetVJDButtonNumber(uint id) => IsVJoyEnabled ? _getVJDButtonNumber(id) : 0;
86 
87         public bool GetVJDAxisExist(uint id, USAGES usages) => IsVJoyEnabled ? (bool)_getVJDAxisExist.DynamicInvoke(new object[] { id, _axisEnumValues[(int)usages] }) : false;
88 
89     //省略類似代碼……
90     }