VS2022扩展开发：如何实现Git变更视图式的对比窗口？

核心思路 #

借助Visual Studio SDK提供的差异处理组件，通过MEF依赖注入获取IWpfDifferenceViewerFactoryService等核心服务，构建差异数据源后创建并显示和Git变更视图一致的对比窗口。

具体实现步骤 #

1. 配置MEF依赖注入

在你的命令类中，通过MEF导入所需的核心服务（确保命令类已被MEF导出）：

[Export(typeof(MenuCommand))]
[CommandMethod(YourCommandPackage.CommandSetGuid, YourCommandPackage.YourCompareCommandId)]
public class FileCompareCommand : MenuCommand
{
    [Import]
    private IWpfDifferenceViewerFactoryService _diffViewerFactoryService = null;

    [Import]
    private IDifferenceBufferFactoryService _diffBufferFactoryService = null;

    [Import]
    private ITextBufferFactoryService _textBufferFactoryService = null;

    public FileCompareCommand() : base(Execute, new CommandID(YourCommandPackage.CommandSetGuid, YourCommandPackage.YourCompareCommandId))
    {
        // 触发MEF服务导入
        var componentModel = ServiceProvider.GlobalProvider.GetService(typeof(SComponentModel)) as IComponentModel;
        componentModel?.DefaultCompositionService.SatisfyImportsOnce(this);
    }

    private static void Execute(object sender, EventArgs e)
    {
        var command = sender as FileCompareCommand;
        command?.LaunchCompareWindow();
    }
}

2. 构建差异数据源（IDifferenceBuffer）

准备两个版本的文本内容（例如原始文件和修改后文件），将其转换为ITextBuffer后创建差异缓冲区：

private IDifferenceBuffer BuildDifferenceBuffer(string originalPath, string modifiedPath)
{
    // 读取原始文件内容并创建文本缓冲区
    var originalContent = File.ReadAllText(originalPath);
    var originalBuffer = _textBufferFactoryService.CreateTextBuffer(originalContent, Encoding.UTF8);

    // 读取修改后文件内容并创建文本缓冲区
    var modifiedContent = File.ReadAllText(modifiedPath);
    var modifiedBuffer = _textBufferFactoryService.CreateTextBuffer(modifiedContent, Encoding.UTF8);

    // 创建差异缓冲区，可配置忽略空白等规则
    return _diffBufferFactoryService.CreateDifferenceBuffer(
        originalBuffer,
        modifiedBuffer,
        IgnoreWhiteSpaceMode.None,
        string.Empty);
}

3. 创建并显示差异视图

通过工厂服务创建对比窗口，设置显示模式并展示：

private void LaunchCompareWindow()
{
    // 替换为实际的原始文件和修改后文件路径
    var originalFile = @"C:\example\original.cs";
    var modifiedFile = @"C:\example\modified.cs";

    var diffBuffer = BuildDifferenceBuffer(originalFile, modifiedFile);
    var diffViewer = _diffViewerFactoryService.CreateDifferenceViewer(diffBuffer);

    // 设置对比模式：SideBySide为左右分栏，Inline为行内对比
    diffViewer.ViewMode = DifferenceViewMode.SideBySide;
    // 设置窗口标题
    diffViewer.Title = $"对比: {Path.GetFileName(originalFile)} ↔ {Path.GetFileName(modifiedFile)}";

    // 将对比窗口添加到VS主界面并显示
    var windowFrame = diffViewer.Host.GetFrame();
    windowFrame?.Show();
}

4. 关键注意事项

• 确保扩展项目已引用Microsoft.VisualStudio.Text.UI.Wpf、Microsoft.VisualStudio.Text.Differencing相关NuGet包。
• 处理非UTF-8编码文件时，需调整CreateTextBuffer的编码参数。
• 可监听diffViewer.Closed事件，做视图关闭后的资源清理工作。

内容的提问来源于stack exchange，提问作者blissweb