深入掌握C#代码分析器（Roslyn教程：从零开始构建静态代码分析工具）

准备工作：安装必要工具

在开始之前，请确保你已安装以下工具：

• Visual Studio 2022（或更高版本）
• .NET SDK 6.0 或更高版本
• “.NET Compiler Platform SDK”（可在 Visual Studio 安装器中勾选）

第一步：创建分析器项目

打开 Visual Studio，选择“创建新项目”，然后搜索并选择 “Analyzer with Code Fix (.NET Standard)” 模板。这个模板会自动生成三个项目：

1. MyAnalyzer：包含诊断规则（Diagnostic）和分析逻辑
2. MyAnalyzer.Test：单元测试项目
3. MyAnalyzer.Vsix：用于在 Visual Studio 中安装插件（可选）

第二步：编写一个简单的命名规范分析器

假设我们希望强制要求所有类名必须以大写字母开头。我们来实现这个规则。

首先，在 MyAnalyzer 项目中找到 DiagnosticAnalyzer.cs 文件，并替换为以下代码：

using Microsoft.CodeAnalysis;using Microsoft.CodeAnalysis.CSharp;using Microsoft.CodeAnalysis.CSharp.Syntax;using Microsoft.CodeAnalysis.Diagnostics;using System.Collections.Immutable;[DiagnosticAnalyzer(LanguageNames.CSharp)]public class ClassNameMustBePascalCaseAnalyzer : DiagnosticAnalyzer{    public const string DiagnosticId = "ClassNamePascalCase";    private static readonly LocalizableString Title = "Class name should be PascalCase";    private static readonly LocalizableString MessageFormat = "Class '{0}' should start with an uppercase letter.";    private static readonly LocalizableString Description = "All class names must begin with an uppercase letter.";    private const string Category = "Naming";    private static readonly DiagnosticDescriptor Rule = new(        DiagnosticId,        Title,        MessageFormat,        Category,        DiagnosticSeverity.Warning,        isEnabledByDefault: true,        description: Description);    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);    public override void Initialize(AnalysisContext context)    {        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);        context.EnableConcurrentExecution();        context.RegisterSyntaxNodeAction(AnalyzeClassDeclaration, SyntaxKind.ClassDeclaration);    }    private static void AnalyzeClassDeclaration(SyntaxNodeAnalysisContext context)    {        var classDeclaration = (ClassDeclarationSyntax)context.Node;        var className = classDeclaration.Identifier.Text;        if (!string.IsNullOrEmpty(className) && !char.IsUpper(className[0]))        {            var diagnostic = Diagnostic.Create(Rule, classDeclaration.Identifier.GetLocation(), className);            context.ReportDiagnostic(diagnostic);        }    }}

第三步：理解代码关键点

上述代码中，有几个关键部分需要理解：

• [DiagnosticAnalyzer]：标记这是一个分析器，并指定支持的语言。
• DiagnosticDescriptor：定义警告的 ID、标题、消息格式等元数据。
• Initialize 方法：注册要监听的语法节点类型（这里是 ClassDeclaration）。
• AnalyzeClassDeclaration：实际分析逻辑，检查类名首字母是否大写。

第四步：测试你的分析器

将 MyAnalyzer.Test 设为启动项目，运行测试。你也可以在另一个控制台项目中引用该分析器 DLL，直接在编辑器中看到警告提示。

例如，当你写下如下代码时：

class myClass{    // 这里会触发警告：Class 'myClass' should start with an uppercase letter.}

进阶：添加自动修复（Code Fix）

Roslyn 还支持提供“快速修复”功能。你可以在 CodeFixProvider.cs 中实现将 myClass 自动改为 MyClass 的逻辑。这超出了本入门教程范围，但官方文档提供了详细指南。

总结

通过本教程，你已经学会了如何使用 Roslyn 创建一个简单的 C#代码分析器。这项技能不仅能帮助你实施团队编码规范，还能显著提升项目的 .NET代码分析 能力。随着你对 静态代码分析 理解的深入，你可以构建更复杂的规则，甚至集成到 CI/CD 流程中，实现自动化代码质量门禁。

小提示：多参考 Roslyn 官方 GitHub 仓库中的示例项目，是学习高级用法的最佳途径。