如何从NuGet包调用Roslyn Analyzer分析外部代码并搭建简易工具？

完全可以实现你的需求——通过NuGet导入Roslyn Analyzer，程序化调用它分析任意外部解决方案，最终搭建轻量的代码质量分析UI。核心是利用Roslyn的Workspace API解耦Visual Studio环境，手动加载分析器并执行分析。以下是具体步骤和关键要点：

1. 基础依赖准备 #

首先需要引入Roslyn的核心NuGet包：

• Microsoft.CodeAnalysis.Workspaces.MSBuild：用于加载和解析外部解决方案/项目
• Microsoft.CodeAnalysis.CSharp/Microsoft.CodeAnalysis.VisualBasic：对应你要分析的目标语言
• 目标Roslyn Analyzer的NuGet包（比如StyleCop.Analyzers、Microsoft.CodeAnalysis.FxCopAnalyzers等）

2. 加载外部解决方案 #

使用MSBuildWorkspace可以直接加载磁盘上的解决方案，无需依赖Visual Studio环境：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.MSBuild;

// 初始化MSBuild工作区，需确保MSBuild路径配置正确（可通过环境变量或手动指定）
var workspace = MSBuildWorkspace.Create();
// 加载目标外部解决方案
var solution = await workspace.OpenSolutionAsync(@"D:\ClonedRepo\TargetSolution.sln");

3. 导入并加载Roslyn Analyzer #

从NuGet包中提取分析器的DLL（通常在NuGet包的analyzers目录下），或者直接通过程序集加载已引用的分析器：

using System.Reflection;

// 示例：加载已通过NuGet引用的分析器程序集
var analyzerAssembly = Assembly.Load("StyleCop.Analyzers");
// 筛选出所有DiagnosticAnalyzer类型的实现类
var analyzers = analyzerAssembly.GetTypes()
    .Where(t => typeof(DiagnosticAnalyzer).IsAssignableFrom(t) && !t.IsAbstract)
    .Select(t => (DiagnosticAnalyzer)Activator.CreateInstance(t))
    .ToList();

4. 执行代码分析并收集结果 #

遍历解决方案中的每个项目，生成编译单元并附加分析器，最后获取诊断结果：

foreach (var project in solution.Projects)
{
    // 获取项目的编译对象
    var compilation = await project.GetCompilationAsync();
    if (compilation == null) continue;

    // 将分析器附加到编译单元
    var compilationWithAnalyzers = compilation.WithAnalyzers(analyzers);
    // 获取所有诊断结果（包括分析器生成的自定义规则和编译器原生诊断）
    var diagnostics = await compilationWithAnalyzers.GetAllDiagnosticsAsync();

    // 处理诊断结果：转换为UI展示需要的结构化数据
    foreach (var diag in diagnostics)
    {
        // 可过滤掉编译器原生警告（如CS开头的C#警告），只保留分析器生成的结果
        if (!diag.Id.StartsWith("CS") && !diag.Id.StartsWith("VB"))
        {
            var issue = new
            {
                RuleId = diag.Id,
                Description = diag.GetMessage(),
                Severity = diag.Severity.ToString(),
                FilePath = diag.Location.SourceTree?.FilePath,
                LineNumber = diag.Location.GetLineSpan().StartLinePosition.Line + 1
            };
            // 将issue存入数据集合，用于后续UI渲染
        }
    }
}

5. 搭建轻量UI #

将收集到的诊断结果用你熟悉的框架展示，核心功能参考SonarQube的基础体验：

• 桌面端：用WPF/WinForms的DataGridView或TreeView展示问题列表，支持按严重程度、文件、规则ID筛选
• Web端：用Blazor/ASP.NET Core实现表格+筛选组件，支持规则详情查看、代码位置跳转
• 附加功能：支持结果导出为CSV/JSON，方便后续处理

关键注意事项 #

• 分析器依赖处理：部分分析器依赖额外的辅助DLL，需确保这些DLL和分析器DLL在同一目录下，否则会出现加载失败
• 性能优化：大解决方案分析耗时较长，建议异步处理+进度展示，可考虑增量分析（仅处理变更的项目）
• 规则配置：通过AnalyzerConfigSet类加载.editorconfig文件，实现规则的启用/禁用、严重程度调整，和Visual Studio中的配置保持一致
• 版本兼容性：不同版本的Roslyn分析器可能依赖特定版本的Roslyn SDK，需注意版本匹配避免兼容性问题

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