如何调试 C# Emit 生成的动态代码?("调试技巧：如何高效处理C# Emit生成的动态代码？")

原创

ithorizon 6个月前 (10-21) 阅读数 25 #后端开发

调试技巧：怎样高效处理C# Emit生成的动态代码？

在C#编程中，Emit技术允许开发者在运行时动态生成和执行代码。虽然这种技术提供了极大的灵活性和强劲的功能，但同时也带来了调试上的挑战。由于生成的代码是动态的，并不在源代码中直接可见，于是调试起来相对棘手。以下是一些高效处理C# Emit生成的动态代码的调试技巧。

1. 使用Debuggable属性

Emit生成代码时，可以设置Debuggable属性，以便生成的代码包含调试信息。这可以通过设置DebuggableAttribute来实现。


using System;
using System.Reflection;
using System.Reflection.Emit;
public class DynamicCodeGenerator
{
    public static void GenerateDynamicMethod()
    {
        var assemblyName = new AssemblyName("DynamicAssembly");
        var assemblyBuilder = AssemblyBuilder.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndCollect);
        var moduleBuilder = assemblyBuilder.DefineDynamicModule("DynamicModule", true);
        var methodBuilder = moduleBuilder.DefineGlobalMethod("DynamicMethod", MethodAttributes.Public | MethodAttributes.Static, typeof(void), Type.EmptyTypes);
        var ilGenerator = methodBuilder.GetILGenerator();
        ilGenerator.Emit(OpCodes.Ret);
        // 设置Debuggable属性
        var debuggableAttributeBuilder = new CustomAttributeBuilder(
            typeof(DebuggableAttribute).GetConstructor(new Type[] { typeof(DebuggingModes) }),
            new object[] { DebuggingModes.Default | DebuggingModes.EnableEditAndContinue });
        methodBuilder.SetCustomAttribute(debuggableAttributeBuilder);
    }
}

2. 使用SymbolWriter生成符号文件

在Emit生成代码时，可以同时生成符号文件（PDB），这样可以在调试器中查看局部变量和执行流程。


using System;
using System.Diagnostics;
using System.Reflection;
using System.Reflection.Emit;
public class DynamicCodeGenerator
{
    public static void GenerateDynamicMethod()
    {
        var assemblyName = new AssemblyName("DynamicAssembly");
        var assemblyBuilder = AssemblyBuilder.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndCollect);
        var moduleBuilder = assemblyBuilder.DefineDynamicModule("DynamicModule", "DynamicModule.pdb");
        var methodBuilder = moduleBuilder.DefineGlobalMethod("DynamicMethod", MethodAttributes.Public | MethodAttributes.Static, typeof(void), Type.EmptyTypes);
        var ilGenerator = methodBuilder.GetILGenerator();
        ilGenerator.Emit(OpCodes.Ret);
        // 生成符号文件
        var symbolWriter = new SymbolWriter(moduleBuilder, true, "DynamicModule.pdb");
        methodBuilder.SetSymbolWriter(symbolWriter);
    }
}

3. 使用日志记录和跟踪

在生成的代码中插入日志记录语句，可以帮助追踪代码的执行流程和状态。


using System;
using System.Diagnostics;
using System.Reflection;
using System.Reflection.Emit;
public class DynamicCodeGenerator
{
    public static void GenerateDynamicMethod()
    {
        var assemblyName = new AssemblyName("DynamicAssembly");
        var assemblyBuilder = AssemblyBuilder.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndCollect);
        var moduleBuilder = assemblyBuilder.DefineDynamicModule("DynamicModule");
        var methodBuilder = moduleBuilder.DefineGlobalMethod("DynamicMethod", MethodAttributes.Public | MethodAttributes.Static, typeof(void), Type.EmptyTypes);
        var ilGenerator = methodBuilder.GetILGenerator();
        // 插入日志记录
        ilGenerator.Emit(OpCodes.Ldstr, "Method started");
        ilGenerator.Emit(OpCodes.Call, typeof(Console).GetMethod("WriteLine", new Type[] { typeof(string) }));
        ilGenerator.Emit(OpCodes.Ret);
        // 执行方法
        methodBuilder.Invoke(null, null);
    }
}

4. 使用调试器附加到进程

如果无法直接在代码中设置断点，可以尝试使用调试器附加到正在运行的进程。这可以通过Visual Studio或其他调试器完成。

运行应用程序，但不立即执行动态生成的代码。

在Visual Studio中，打开“调试”菜单，选择“附加到进程”。

选择运行的应用程序进程，点击“附加”。

在代码中设置断点，然后继续执行程序。

5. 使用动态调试代理

可以使用动态调试代理（如System.Diagnostics.Debugger）在运行时动态地启动调试器。


using System;
using System.Diagnostics;
using System.Reflection;
using System.Reflection.Emit;
public class DynamicCodeGenerator
{
    public static void GenerateDynamicMethod()
    {
        var assemblyName = new AssemblyName("DynamicAssembly");
        var assemblyBuilder = AssemblyBuilder.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndCollect);
        var moduleBuilder = assemblyBuilder.DefineDynamicModule("DynamicModule");
        var methodBuilder = moduleBuilder.DefineGlobalMethod("DynamicMethod", MethodAttributes.Public | MethodAttributes.Static, typeof(void), Type.EmptyTypes);
        var ilGenerator = methodBuilder.GetILGenerator();
        // 启动调试器
        Debugger.Launch();
        ilGenerator.Emit(OpCodes.Ret);
        // 执行方法
        methodBuilder.Invoke(null, null);
    }
}

6. 分析生成的IL代码

通过分析Emit生成的IL代码，可以更好地懂得代码的执行流程和行为。可以使用ILDasm工具或其他反汇编工具来查看生成的IL代码。

7. 使用调试器友好的高级API

如果大概，使用一些高级API，如Expression、Lambda表达式等，这些API在生成代码的同时，也提供了更好的调试拥护。


using System;
using System.Linq.Expressions;
public class DynamicCodeGenerator
{
    public static void GenerateDynamicMethod()
    {
        var method = Expression.Lambda(() =>
        {
            Console.WriteLine("Hello, World!");
        }).Compile();
        method.Invoke();
    }
}