如何开发WinForms .Designer.cs文件排序的Visual Studio扩展？

我太懂这种WinForms Designer.cs合并冲突的痛苦了——多人协作时改个控件位置都可能触发一堆冲突，你的思路完全找对了：借鉴ResXManager通过排序稳定文件内容的策略，确实能从根源减少这类问题。下面是一步步实现这个Visual Studio扩展的具体方案：

首先你需要创建一个VSIX项目（Visual Studio 扩展项目），记得安装Visual Studio SDK（在VS安装器里选「Visual Studio扩展开发」工作负载）。项目创建后，添加以下核心引用：

• EnvDTE 和 EnvDTE80：用于访问VS的开发环境对象
• Microsoft.VisualStudio.Shell.XXX：比如Microsoft.VisualStudio.Shell.Framework、Microsoft.VisualStudio.Shell.17.0（对应你的VS版本）
• Microsoft.CodeAnalysis.CSharp：用Roslyn来安全解析和修改C#代码（避免粗暴文本替换破坏Designer结构）

我们需要监听文件保存后的事件，确保每次Designer文件被设计器自动生成或用户保存后，都能触发排序逻辑。这里推荐用IVsFileChangeService来监听文件变更，比DTE的FileEvents更可靠：

private IVsFileChangeService _fileChangeService;

protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
{
    // 获取VS的文件变更服务
    _fileChangeService = await GetServiceAsync(typeof(SVsFileChangeService)) as IVsFileChangeService;
    if (_fileChangeService != null)
    {
        // 注册文件变更回调：监听文件保存事件
        _fileChangeService.AdviseFileChange(null, (uint)_VSFILECHANGEFLAGS.VSFILECHG_Save, new FileChangeHandler(this));
    }
}

// 实现IVsFileChangeEvents接口的回调类
private class FileChangeHandler : IVsFileChangeEvents
{
    private readonly MyExtensionPackage _package;

    public FileChangeHandler(MyExtensionPackage package)
    {
        _package = package;
    }

    public int FilesChanged(uint cChanges, string[] rgpszFile, uint[] rggrfChange)
    {
        for (int i = 0; i < cChanges; i++)
        {
            string filePath = rgpszFile[i];
            // 筛选WinForms的Designer.cs文件：排除WPF的，只处理关联Form/UserControl的
            if (filePath.EndsWith(".Designer.cs", StringComparison.OrdinalIgnoreCase) && 
                File.Exists(filePath.Replace(".Designer.cs", ".cs")))
            {
                // 触发排序逻辑
                _package.SortDesignerFile(filePath);
            }
        }
        return VSConstants.S_OK;
    }

    // 其他接口方法默认返回S_OK即可
    public int DirectoryChanged(string pszDirectory) => VSConstants.S_OK;
}

Designer.cs的结构是固定的，我们要针对自动生成的部分排序，比如：

1. 控件字段的声明（private System.Windows.Forms.Button button1;）按变量名排序
2. InitializeComponent()方法内的代码，按控件名称分组排序（创建控件→设置属性→添加到容器）
3. 组件容器的资源初始化代码按名称排序

这里必须用Roslyn来解析代码，避免文本替换出错：

public void SortDesignerFile(string filePath)
{
    // 读取文件内容
    string code = File.ReadAllText(filePath);
    var tree = CSharpSyntaxTree.ParseText(code);
    var root = tree.GetRoot();

    // 找到Designer类（比如Form1.Designer.cs里的Form1类）
    var classDecl = root.DescendantNodes().OfType<ClassDeclarationSyntax>().FirstOrDefault();
    if (classDecl == null) return;

    // 1. 排序控件字段声明
    var sortedFields = classDecl.Members
        .OfType<FieldDeclarationSyntax>()
        .Where(f => f.Declaration.Type.ToString().StartsWith("System.Windows.Forms."))
        .OrderBy(f => f.Declaration.Variables.First().Identifier.Text)
        .ToList();
    // 替换原字段集合，保留非控件字段的顺序
    var newMembers = classDecl.Members
        .Where(m => !(m is FieldDeclarationSyntax fd && sortedFields.Contains(fd)))
        .Concat(sortedFields)
        .ToList();
    classDecl = classDecl.WithMembers(SyntaxFactory.List(newMembers));

    // 2. 排序InitializeComponent方法内的代码
    var initMethod = classDecl.DescendantNodes().OfType<MethodDeclarationSyntax>()
        .FirstOrDefault(m => m.Identifier.Text == "InitializeComponent");
    if (initMethod != null)
    {
        // 把方法内的语句按关联控件名称排序（所有同一控件的代码放在一起）
        var sortedStatements = initMethod.Body.Statements
            .OrderBy(s => ExtractControlNameFromStatement(s))
            .ToList();
        initMethod = initMethod.WithBody(initMethod.Body.WithStatements(SyntaxFactory.List(sortedStatements)));
        classDecl = classDecl.ReplaceNode(initMethod, initMethod);
    }

    // 生成修改后的代码并保存
    var newRoot = root.ReplaceNode(classDecl, classDecl);
    File.WriteAllText(filePath, newRoot.ToFullString());
}

// 辅助方法：从语句中提取关联的控件名称（需要根据实际语法完善）
private string ExtractControlNameFromStatement(StatementSyntax stmt)
{
    // 处理this.button1.Location = ...; 提取button1
    var assignment = stmt as ExpressionStatementSyntax;
    if (assignment?.Expression is AssignmentExpressionSyntax assignExpr)
    {
        var left = assignExpr.Left as MemberAccessExpressionSyntax;
        if (left?.Expression is IdentifierNameSyntax id && id.Identifier.Text == "this")
        {
            return left.Name.Identifier.Text;
        }
    }
    // 处理this.Controls.Add(this.button1);
    var invocation = stmt as ExpressionStatementSyntax;
    if (invocation?.Expression is InvocationExpressionSyntax invokeExpr)
    {
        var arg = invokeExpr.ArgumentList.Arguments.FirstOrDefault()?.Expression as MemberAccessExpressionSyntax;
        if (arg?.Expression is IdentifierNameSyntax id && id.Identifier.Text == "this")
        {
            return arg.Name.Identifier.Text;
        }
    }
    return stmt.ToString();
}

• 避免和设计器冲突：一定要在文件保存后再修改，不要在设计器正在编辑时操作。可以在FilesChanged里用DTE.ItemOperations.IsFileOpen(filePath)检查文件是否处于编辑状态，若打开则跳过。
• 兼容不同VS版本：不同版本的WinForms Designer生成的代码结构略有差异，比如.NET Framework和.NET 6+的Designer文件结构不同，需要做适配判断。
• 保留用户手动修改：虽然不建议用户修改Designer.cs，但如果有#region手动代码块，要确保排序逻辑不触碰这些区域（可以通过判断语法节点的位置跳过）。
• 添加Undo支持：修改文件后，要让用户可以通过VS的Undo撤销操作，避免误改无法恢复——可以通过DTE的UndoContext实现。

完成开发后，在VS里右键项目→「打包」生成VSIX文件，让团队全员安装即可。这样每个人修改WinForms界面并保存后，Designer文件都会自动按固定顺序排序，合并冲突的概率会大幅降低。

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