VSIX Roslyn调试出现异常行为：文件保存分析功能遇阻

嘿，我太懂你这种刚摸VS扩展和Roslyn就卡壳的感觉了——毕竟Roslyn的语法分析体系和VS的DTE事件结合起来，确实有不少容易踩的坑。结合你说的「断点能命中，但一启用语法相关代码就出问题」的情况，我整理了几个最常见的解决方案：

1. 先搞对DTE文档和Roslyn文档的转换 #

DTE的Document和Roslyn的Document完全是两个东西，直接拿DTE的文件路径去瞎找Roslyn文档很容易踩空。正确的打开方式是这样的：

private void _dteDocEvents_DocumentSaved(EnvDTE.Document dteDoc)
{
    // 先过滤非文本文件
    if (dteDoc == null || dteDoc.Kind != EnvDTE.vsDocumentKindText)
        return;

    // 获取VS全局的Roslyn Workspace
    var workspace = Microsoft.VisualStudio.Shell.ServiceProvider.GlobalProvider
        .GetService(typeof(Microsoft.CodeAnalysis.Workspace)) as Microsoft.CodeAnalysis.Workspace;
    if (workspace == null)
        return;

    // 通过文件路径匹配到Roslyn的文档
    var filePath = dteDoc.FullName;
    var roslynDocId = workspace.CurrentSolution.GetDocumentIdsWithFilePath(filePath).FirstOrDefault();
    var roslynDoc = roslynDocId != null ? workspace.CurrentSolution.GetDocument(roslynDocId) : null;
    if (roslynDoc == null)
        return;

    // 接下来才是你的语法分析逻辑...
}

2. 绝对别在UI线程硬扛语法分析 #

DTE的事件是在UI线程触发的，如果你的语法分析逻辑稍微复杂点，直接在事件里同步执行会把VS卡得动不了，甚至假死。改成异步处理才是正道：

// 把事件处理改成异步方法
private async void _dteDocEvents_DocumentSaved(EnvDTE.Document dteDoc)
{
    // 前面的文档转换逻辑...
    if (roslynDoc == null) return;

    // 异步获取语法树，不阻塞UI
    var syntaxTree = await roslynDoc.GetSyntaxTreeAsync();
    if (syntaxTree == null) return;

    var root = await syntaxTree.GetRootAsync();
    // 举个例子：查找所有继承自指定基类的类
    var targetClasses = root.DescendantNodes()
        .OfType<ClassDeclarationSyntax>()
        .Where(cls => cls.BaseList?.Types.Any(t => t.Type.ToString() == "YourTargetBaseClass") ?? false);
    
    foreach (var cls in targetClasses)
    {
        // 这里做你的属性检测或其他逻辑
        var properties = cls.Members.OfType<PropertyDeclarationSyntax>();
        // ...
    }
}

另外别忘了给项目装对NuGet包：Microsoft.CodeAnalysis、Microsoft.CodeAnalysis.CSharp（C#项目的话），还有VS Shell相关的Microsoft.VisualStudio.Shell.15.0之类的包。

3. 处理文档未同步的坑 #

有时候DocumentSaved事件触发时，文件内容还没完全同步到Roslyn的Workspace里，这时候拿到的语法树可能是旧的。可以两种方式解决：

• 加个短暂的延迟（不太优雅但应急好用）
• 订阅Workspace的WorkspaceChanged事件，监听文档变更的准确时机：

// 在Package初始化的时候订阅
workspace.WorkspaceChanged += (sender, e) =>
{
    if (e.Kind == WorkspaceChangeKind.DocumentChanged 
        && e.DocumentId?.FilePath == dteDoc.FullName)
    {
        // 这里处理最新的文档内容
    }
};

4. 调试时的小技巧 #

如果断点命中后一跑Roslyn代码就没反应，大概率是这俩问题：

• 没加载Roslyn的调试符号：去VS的「调试选项」里勾选「启用.NET框架源代码步进」，并加载符号
• UI线程被阻塞：切换到「线程」窗口看看后台线程的调用栈，说不定能找到卡壳的地方

要是你有具体的错误提示（比如空引用、无效操作异常），把细节贴出来，能更快定位问题哦~

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