.Net Core 为 x86 和 x64 程序集编写 AnyCPU 包装
- 2020 年 3 月 10 日
- 笔记
前言
这几天研究了一下 vJoy 这个虚拟游戏手柄驱动，感觉挺好玩的。但是使用时发现一个问题，C# SDK 中的程序集被分为 x86 和 x64 两个版本，如果直接在 AnyCPU 平台编译运行就有隐患，在32位系统中运行程序时会因为程序集版本不兼容而崩溃。这个 SDK 的两个版本文件名完全相同，根据 .Net 程序集的加载规则，我们是无法在不做任何工作的情况下实现共存的。对于平台特定程序集，目前的主流做法是把程序集放到以平台名称命名的文件夹中。通过一个包装程序集完成载入和调用。
正文
我这里的包装使用了 .Net Core 的 AssemblyLoadContext 为中介完成 SDK 的动态加载。不过这种包装方式也有个很麻烦的地方，不能像正常引用的程序集那样享受各种智能提示，只能使用反射的方式调用实际库中的各种功能。为方便使用，包装库需要在内部完成反射处理并对外公开一套 API 方便使用。
定义程序集载入上下文
因为资源由内部管理，不需要对外暴露，我这里的上下文是公开 API 的私有内部类，加载上下文的可重写方法中还有一个是用于非托管程序集的。这个上下文很智能，会自动查找被加载程序集的相同文件夹，所以无需重写，如果依赖程序集在其他位置，需要重写加载方法。
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 方法来调用。
下面的代码中的 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);
定义示例：
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 }
剩下的部分基本就是用这个套路把剩下要用的东西封装缓存后供外界使用。感兴趣的话，完整代码可以在文章末尾到我的 GitHub 项目中查看。
结语
用这个方法可以把分开的平台绑定程序集封装到一个 AnyCPU 程序集里。对于要与原生 dll 交互的项目，在原生封装时就完成这一步最好。如果封装也是分开的，这个办法就可以再封装一次，用来适配 AnyCPU 平台。
在我的 GitHub 项目中有个 vJoyDemo 项目，是使用示例。
转载请完整保留以下内容并在显眼位置标注，未经授权删除以下内容进行转载盗用的，保留追究法律责任的权利！
本文地址：https://www.cnblogs.com/coredx/p/12455761.html
完整源代码：Github
里面有各种小东西，这只是其中之一，不嫌弃的话可以Star一下。
