告别千篇一律：dnSpy代码生成插件开发指南——让反编译格式随心定制

还在为反编译输出格式单一而困扰？当默认的C#/VB输出无法满足文档生成、代码分析或二次开发需求时，dnSpy的插件系统能帮你突破限制。本文将手把手教你开发自定义代码生成插件，将反编译结果导出为Markdown、JSON甚至自定义格式，让逆向工程工作流效率倍增。

插件开发基础：从示例到实战

dnSpy插件系统基于MEF（Managed Extensibility Framework）设计，通过实现IExtension接口即可扩展功能。官方提供的示例插件展示了基础架构：

[ExportExtension]
sealed class TheExtension : IExtension {
    public IEnumerable<string> MergedResourceDictionaries {
        get { yield break; }
    }
    public ExtensionInfo ExtensionInfo => new ExtensionInfo {
        ShortDescription = "自定义代码生成插件",
    };
    public void OnEvent(ExtensionEvent @event, object? obj) {
        // 初始化逻辑
    }
}

示例插件完整代码：Example1.Extension/TheExtension.cs

核心开发文件结构

每个插件需包含以下关键文件：

• 清单文件：Example1.Extension.csproj - 定义插件元数据与依赖
• 设置界面：MySettingsControl.xaml - 提供用户配置选项
• 主逻辑：TheExtension.cs - 实现核心扩展功能

反编译格式扩展原理

dnSpy的反编译流程由Decompiler模块控制，通过扩展IDecompiler接口可实现自定义输出格式。尽管直接修改反编译核心需深入dnSpy.Decompiler/模块，但插件可通过以下两种方式实现格式转换：

方式一：后处理转换

利用反编译完成事件，对默认输出进行二次处理。通过订阅DecompilationCompleted事件，获取原始代码并转换格式：

public void OnEvent(ExtensionEvent @event, object? obj) {
    if (@event == ExtensionEvent.DecompilationCompleted) {
        var result = obj as DecompilationResult;
        var transformedCode = ConvertToMarkdown(result.Code);
        result.UpdateCode(transformedCode);
    }
}

方式二：自定义输出器

实现ICodeOutput接口，直接控制代码生成过程。需引用反编译核心模块：dnSpy.Decompiler/

开发步骤：Markdown输出插件实战

1. 创建项目结构

CustomDecompilerExtension/
├─ CustomDecompilerExtension.csproj
├─ TheExtension.cs
├─ MarkdownOutput.cs
└─ Settings/
   ├─ MySettings.cs
   └─ MySettingsControl.xaml

2. 实现配置保存

使用dnSpy的设置服务持久化用户选项，参考示例：

static readonly Guid SETTINGS_GUID = new Guid("A308405D-0DF5-4C56-8B1E-8CE7BA6365E1");

[ImportingConstructor]
MySettingsImpl(ISettingsService settingsService) {
    var sect = settingsService.GetOrCreateSection(SETTINGS_GUID);
    IncludeLineNumbers = sect.Attribute<bool?>(nameof(IncludeLineNumbers)) ?? true;
}

完整设置实现：MySettings.cs

3. 开发格式转换逻辑

核心转换代码示例（Markdown格式）：

public string ConvertToMarkdown(string code) {
    var lines = code.Split('\n');
    var md = new StringBuilder();
    md.AppendLine("```csharp");
    for (int i = 0; i < lines.Length; i++) {
        if (settings.IncludeLineNumbers)
            md.AppendLine($"{i+1:000} {lines[i]}");
        else
            md.AppendLine(lines[i]);
    }
    md.AppendLine("```");
    return md.ToString();
}

集成与调试

插件部署路径

编译后的插件需放置在dnSpy的Extensions目录，调试时可通过项目属性设置输出路径：

<OutputPath>..\..\..\dnSpy\bin\Debug\net6.0\Extensions\</OutputPath>

调试技巧

利用dnSpy自身调试插件：

1. 打开dnSpy主程序
2. 通过文件 > 打开加载插件项目
3. 在调试 > 附加到进程中选择dnSpy进程
4. 设置断点并测试功能

高级应用：自定义元数据导出

通过扩展IMetadataService，可将程序集元数据导出为JSON格式：

public string ExportMetadata(ModuleDef module) {
    var metadata = new {
        Name = module.Name,
        Types = module.Types.Count,
        References = module.AssemblyReferences.Select(a => a.Name)
    };
    return JsonSerializer.Serialize(metadata, new JsonSerializerOptions { WriteIndented = true });
}

相关元数据处理模块：dnSpy/Metadata/

插件开发资源

• 官方文档：docs/dnspy-tutorial.md
• 示例插件：Extensions/Examples/
• 构建工具：Build/
• 许可证信息：dnSpy/LicenseInfo/

总结与扩展思路

本文介绍的插件开发框架不仅可用于格式转换，还能实现：

• 代码注释自动生成
• 跨语言反编译（如C#转Java）
• 代码复杂度分析报告
• 自定义语法高亮规则

通过dnSpy的插件生态，逆向工程不再受限于工具默认功能。立即克隆项目开始开发：

git clone https://gitcode.com/gh_mirrors/dns/dnSpy.git
cd dnSpy
dotnet build dnSpy.sln

点赞收藏本文，下期将带来《dnSpy调试插件开发：动态修改程序执行流程》。需要更多格式模板？请在评论区留下你的需求！