如何为VS2022解决方案自动管控Nullable Reference Type设置？

针对团队不同解决方案的Nullable配置规范需求，以下是比单元测试读取csproj更健壮的实现方案：

一、Roslyn分析器（首推，开发+CI双阶段管控） #

Roslyn分析器能在开发阶段实时在VS中给出警告，同时在CI编译时阻断不符合规范的构建，完全贴合需求：

1. 创建自定义分析器

   • 用VS2022新建「Analyzer with Code Fix (.NET Standard)」项目
   • 核心逻辑是对比项目实际Nullable设置与解决方案级的预期值：
     • 从解决方案根目录的.editorconfig读取预期配置（比如dotnet_nullable=enable或disable）
     • 通过Compilation.Options.NullableContextOptions获取当前项目的实际Nullable状态
     • 不匹配时抛出警告，还可添加代码修复快速修正配置

2. 核心代码示例

public override void Initialize(AnalysisContext context)
{
    context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
    context.EnableConcurrentExecution();

    context.RegisterCompilationAction(compilationCtx =>
    {
        // 从.editorconfig全局配置读取预期Nullable规则
        compilationCtx.Options.AnalyzerConfigOptions.GlobalOptions.TryGetValue("dotnet_nullable", out var expectedNullable);
        expectedNullable ??= "enable"; // 可设置团队默认规则

        var actualNullable = compilationCtx.Compilation.Options.NullableContextOptions.ToString();
        
        if (!actualNullable.Equals(expectedNullable, StringComparison.OrdinalIgnoreCase))
        {
            var diag = Diagnostic.Create(
                new DiagnosticDescriptor(
                    "NULLABLE001",
                    "Nullable配置不符合规范",
                    "当前项目Nullable设置为 '{0}'，预期为 '{1}'",
                    "Compliance",
                    DiagnosticSeverity.Warning,
                    isEnabledByDefault: true),
                Location.None,
                actualNullable,
                expectedNullable);
            
            compilationCtx.ReportDiagnostic(diag);
        }
    });
}

3. 部署与集成
   • 将分析器打包为NuGet包，通过Directory.Build.props全局引用到整个解决方案（避免逐个项目添加）
   • 在CI（如Jenkins）中开启TreatWarningsAsErrors，确保警告触发构建失败

二、.NET分析器+EditorConfig（轻量配置方案） #

原生.NET分析器（原FxCop）本身没有检查Nullable设置的规则，但可结合自定义Roslyn分析器+EditorConfig实现管控：

• 在每个解决方案根目录创建.editorconfig，明确dotnet_nullable的预期值
• 配合上面的自定义Roslyn分析器，自动校验所有项目的Nullable设置是否匹配

三、Jenkins脚本校验（无侵入式CI方案） #

如果不想引入分析器依赖，可在Jenkins构建流程中添加脚本校验：

PowerShell脚本示例（Windows节点） #

# 读取解决方案根目录的规则配置文件（比如nullable-rule.txt，内容为enable或disable）
$expectedNullable = Get-Content "$env:WORKSPACE/nullable-rule.txt" -Raw | Trim

# 遍历所有csproj文件检查
Get-ChildItem "$env:WORKSPACE" -Filter *.csproj -Recurse | ForEach-Object {
    $projContent = Get-Content $_.FullName -Raw
    if ($projContent -match '<Nullable>(.*?)</Nullable>') {
        $actualNullable = $matches[1].Trim()
        if ($actualNullable -ne $expectedNullable) {
            Write-Error "项目 [$($_.FullName)] 的Nullable设置为 '$actualNullable'，不符合预期的 '$expectedNullable'"
            exit 1
        }
    } else {
        Write-Error "项目 [$($_.FullName)] 未配置Nullable Reference Type，不符合规范"
        exit 1
    }
}

• 将脚本加入Jenkins构建的前置步骤，脚本失败则终止构建

方案对比 #

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