Harmony库在Godot导出构建中的动态模块加载问题解析

问题背景

在使用Harmony库（版本2.3.3）与Godot引擎（4.3.stable.mono版本）结合开发时，开发者遇到了一个特殊问题：当项目在Godot编辑器中运行时一切正常，但在导出构建后，使用Harmony进行方法补丁（如prefix、postfix或finalizer方法）时会抛出异常。

问题现象

在导出的Godot构建中，当尝试通过Harmony对方法进行补丁操作时，系统会抛出以下异常：

System.ArgumentException: GenericArguments[0], 'MonoMod.Utils.Cil.CecilILGenerator', on 'MonoMod.Utils.Cil.ILGeneratorProxy[TTarget]' violates the constraint of type 'TTarget'.

根本原因分析

经过深入分析，发现问题的根源在于Godot导出构建的特殊模块加载机制：

1. 加载上下文差异：与编辑器环境不同，导出的Godot构建会将程序集加载到一个隔离的加载上下文中（Isolated Load Context）。

2. 动态模块生成机制：Harmony底层依赖的MonoMod.Utils库在执行Hook/Detour/HarmonyPatch操作时，会动态生成一个名为MonoMod.Utils.Cil.ILGeneratorProxy的模块。

3. 加载方式不兼容：当前MonoMod.Utils使用Assembly.Load方法加载动态生成的模块，这种方式无法将模块正确加载到Godot的隔离加载上下文中，导致后续的类型操作失败。

技术细节

具体来看，问题发生在以下两个关键环节：

1. 模块加载环节：在MonoMod.Utils.ReflectionHelper.Load方法中，当前实现使用Assembly.Load加载动态生成的程序集：

if (stream is MemoryStream ms) {
    asm = Assembly.Load(ms.GetBuffer());
} else {
    using (var copy = new MemoryStream()) {
        stream.CopyTo(copy);
        copy.Seek(0, SeekOrigin.Begin);
        asm = Assembly.Load(copy.GetBuffer());
    }
}

2. 代理生成环节：在MonoMod.Utils.Cil.ILGeneratorShim.GetProxy方法中尝试创建泛型实例时，由于模块未正确加载到同一上下文中，导致类型约束违反异常：

public ILGenerator GetProxy() {
    return (ILGenerator)ILGeneratorBuilder.GenerateProxy()
        .MakeGenericType(GetType()).GetConstructors()[0].Invoke(new object[1] { this });
}

解决方案

针对这个问题，可以采用以下改进方案：

#if NET5_0_OR_GREATER
    if (AssemblyLoadContext.GetLoadContext(Assembly.GetExecutingAssembly()) is AssemblyLoadContext alc) {
        asm = alc.LoadFromStream(stream);
    }
    else
#endif
    {
        if (stream is MemoryStream ms) {
            asm = Assembly.Load(ms.GetBuffer());
        } else {
            using (var copy = new MemoryStream()) {
                stream.CopyTo(copy);
                copy.Seek(0, SeekOrigin.Begin);
                asm = Assembly.Load(copy.GetBuffer());
            }
        }
    }

这个改进方案的核心要点是：

1. 对于.NET 5及以上版本，首先尝试获取当前执行程序集的加载上下文
2. 如果存在有效的加载上下文（如Godot的隔离上下文），则使用LoadFromStream方法在该上下文中加载程序集
3. 否则回退到原有的加载逻辑

兼容性考虑

该解决方案：

• 在.NET 5+环境下能正确处理隔离加载上下文的情况
• 在旧版.NET环境中保持原有行为
• 不会影响非Godot环境下的正常使用

总结

这个问题展示了在复杂运行时环境下动态代码生成和加载的挑战。通过理解Godot的特殊加载机制和.NET的AssemblyLoadContext特性，我们能够找到既保持兼容性又解决问题的方案。对于需要在Godot等特殊环境中使用Harmony的开发者，理解这些底层机制将有助于解决类似问题。