如何在C#中阻止特定单词/正则编译？Visual Studio编译拦截设置

你可以通过以下几种方式实现Visual Studio在检测到指定禁止字符串时终止编译：

方法一：自定义MSBuild目标 #

直接在项目文件（.csproj）中添加自定义MSBuild目标，在编译前扫描指定文件中的禁止字符串，若存在则抛出错误终止构建：

<Target Name="CheckForbiddenStrings" BeforeTargets="Compile">
  <!-- 定义禁止字符串列表 -->
  <ItemGroup>
    <ForbiddenStrings Include="API_KEY"/>
    <ForbiddenStrings Include="DB_PASSWORD"/>
    <ForbiddenStrings Include="SECRET_TOKEN"/>
    <!-- 根据需要添加更多禁止字符串 -->
  </ItemGroup>
  
  <!-- 指定需要扫描的文件类型，排除编译输出目录 -->
  <ItemGroup>
    <FilesToCheck Include="**/*.cs;**/*.config;**/*.json;**/*.xml" Exclude="bin/**;obj/**;**/packages/**"/>
  </ItemGroup>

  <!-- 扫描文件中是否存在禁止字符串 -->
  <FindInFiles Files="@(FilesToCheck)" Contains="@(ForbiddenStrings)" >
    <Output TaskParameter="MatchingLines" ItemName="ViolatingLines"/>
  </FindInFiles>

  <!-- 若检测到违规内容，抛出错误终止编译 -->
  <Error Text="检测到禁止字符串: '%(ViolatingLines.Line)'，位于文件: %(ViolatingLines.File)" Condition="'@(ViolatingLines)' != ''"/>
</Target>

将这段代码添加到项目的.csproj文件中，每次编译前都会自动执行扫描，一旦发现禁止字符串就会停止构建并提示具体位置。

方法二：使用Roslyn分析器 #

创建自定义Roslyn分析器，在编译阶段静态检测代码中的禁止字符串，并将其标记为编译错误：

1. 在Visual Studio中创建一个Analyzer with Code Fix项目
2. 编写分析器逻辑，扫描代码中的字符串字面量、注释等内容，匹配禁止字符串
3. 将诊断的严重级别设置为DiagnosticSeverity.Error，这样检测到违规内容时会直接终止编译
4. 将分析器项目引用到你的主项目中，此后编译时自动执行检测

示例分析器核心代码片段：

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

    context.RegisterSyntaxNodeAction(AnalyzeLiteral, SyntaxKind.StringLiteralExpression);
}

private void AnalyzeLiteral(SyntaxNodeAnalysisContext context)
{
    var literal = (LiteralExpressionSyntax)context.Node;
    var stringValue = literal.Token.ValueText;
    
    var forbiddenStrings = new[] { "API_KEY", "DB_PASSWORD" };
    foreach (var str in forbiddenStrings)
    {
        if (stringValue.Contains(str))
        {
            var diagnostic = Diagnostic.Create(Rule, literal.GetLocation(), str);
            context.ReportDiagnostic(diagnostic);
        }
    }
}

方法三：预构建脚本 #

通过项目的预构建事件执行脚本扫描文件，若发现禁止字符串则返回非零退出码终止编译：

1. 创建PowerShell脚本CheckForbiddenStrings.ps1，内容如下：

$forbiddenStrings = @("API_KEY", "DB_PASSWORD", "SECRET_TOKEN")
$scanPath = "$env:ProjectDir"
$excludeDirs = @("bin", "obj", "packages")

$files = Get-ChildItem -Path $scanPath -Include *.cs,*.config,*.json -Recurse | Where-Object {
    $excludeDirs -notcontains $_.Directory.Name
}

foreach ($file in $files) {
    $content = Get-Content $file.FullName -Raw
    foreach ($str in $forbiddenStrings) {
        if ($content -match $str) {
            Write-Error "错误：文件 $($file.FullName) 中检测到禁止字符串 '$str'"
            exit 1
        }
    }
}

2. 在项目属性的生成事件中，设置预构建命令行：

powershell -ExecutionPolicy Bypass -File "$(ProjectDir)CheckForbiddenStrings.ps1"

这样每次编译前都会执行脚本扫描，一旦发现禁止字符串就会终止构建。

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