掌握 Roslyn 分析器（C#代码分析与自定义规则配置完整教程）

什么是 Roslyn 分析器？

Roslyn 是 .NET 编译器平台，它不仅负责将 C# 代码编译成 IL，还提供了丰富的 API 供开发者进行静态代码分析。Roslyn 分析器就是基于这些 API 构建的诊断工具，可以在你编写代码时实时提示错误、警告或建议。

常见的内置分析器包括：未使用变量警告、空引用检查、命名规范等。而通过自定义分析器，你可以实现团队特定的编码规则，比如“所有公共方法必须有 XML 注释”。

第一步：创建一个分析器项目

首先，确保你已安装 .NET SDK（建议 6.0 或更高版本）和 Visual Studio（或 VS Code）。

在命令行中运行以下命令创建分析器模板：

dotnet new analyzer -n MyCustomAnalyzer

这会生成一个包含分析器、测试和 VSIX 扩展（用于 Visual Studio 插件）的完整解决方案。

第二步：编写自定义分析规则

打开 MyCustomAnalyzer/Analyzers/CSharp/MyCustomAnalyzerAnalyzer.cs 文件。这里定义了你的分析逻辑。

例如，我们创建一个规则：禁止在类中使用 Console.WriteLine。

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 NoConsoleWriteLineAnalyzer : DiagnosticAnalyzer{    public const string DiagnosticId = "NoConsoleWriteLine";    private static readonly LocalizableString Title = "Avoid Console.WriteLine";    private static readonly LocalizableString MessageFormat = "Do not use Console.WriteLine in production code.";    private static readonly LocalizableString Description = "Console.WriteLine should be replaced with proper logging.";    private const string Category = "Usage";    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(AnalyzeInvocation, SyntaxKind.InvocationExpression);    }    private static void AnalyzeInvocation(SyntaxNodeAnalysisContext context)    {        var invocationExpr = (InvocationExpressionSyntax)context.Node;        if (invocationExpr.Expression is MemberAccessExpressionSyntax memberAccess)        {            if (memberAccess.Expression.ToString() == "Console" &&                memberAccess.Name.Identifier.Text == "WriteLine")            {                var diagnostic = Diagnostic.Create(Rule, invocationExpr.GetLocation());                context.ReportDiagnostic(diagnostic);            }        }    }}

第三步：配置规则的严重级别

即使有了分析器，你也可以在项目中灵活控制其行为。在目标项目根目录下创建或编辑 .editorconfig 文件：

[*.cs]# 启用自定义规则并设为错误级别dotnet_diagnostic.NoConsoleWriteLine.severity = error

这样，一旦有人写了 Console.WriteLine，编译就会失败！这是实现团队规范的强力手段。

第四步：打包与分发

将分析器打包为 NuGet 包，方便团队共享：

dotnet pack MyCustomAnalyzer.Analyzers.csproj -c Release

生成的 .nupkg 文件可上传到私有 NuGet 源，其他项目只需添加包引用即可自动启用分析规则。

总结

通过本教程，你已经学会了如何使用 Roslyn 分析器 创建自定义 C# 代码分析规则，并通过 .editorconfig 控制其严重级别。这种.NET 静态分析能力不仅能提升代码质量，还能强制执行团队规范。

记住，好的 自定义分析规则 应该：明确、可操作、不影响正常开发流程。从小规则开始，逐步构建属于你团队的智能代码守护者！

关键词回顾：Roslyn分析器、C#代码分析、.NET静态分析、自定义分析规则