Visual Studio - 自定义构建验证：能否通过属性实现编译时条件校验报错？

可以通过自定义特性（Attribute）配合编译时分析器实现你要的需求，以下以C#为例给出具体实现方式：

1. 定义自定义特性 #

先创建一个标记用的特性，用来标识需要进行编译时检查的方法：

[AttributeUsage(AttributeTargets.Method, Inherited = false, AllowMultiple = false)]
public sealed class CompileTimeCheckAttribute : Attribute
{
    // 用于传递条件不满足时的错误提示信息
    public string ErrorMessage { get; }

    public CompileTimeCheckAttribute(string errorMessage)
    {
        ErrorMessage = errorMessage;
    }
}

2. 编写Roslyn编译时分析器 #

通过Roslyn分析器在编译阶段扫描带有上述特性的方法，执行自定义检查逻辑，一旦条件不满足就抛出编译错误：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.Diagnostics;
using System.Collections.Immutable;
using System.Linq;

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class CompileTimeCheckAnalyzer : DiagnosticAnalyzer
{
    // 自定义诊断ID，用于标识错误
    public const string DiagnosticId = "CTCHECK001";
    
    private static readonly LocalizableString Title = "编译时条件检查失败";
    private static readonly LocalizableString MessageFormat = "{0}";
    private static readonly LocalizableString Description = "当指定条件未满足时触发编译错误";
    private const string Category = "Compiler";

    private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(
        DiagnosticId, Title, MessageFormat, Category, 
        DiagnosticSeverity.Error, 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.RegisterSymbolAction(AnalyzeTargetMethod, SymbolKind.Method);
    }

    private void AnalyzeTargetMethod(SymbolAnalysisContext context)
    {
        var methodSymbol = (IMethodSymbol)context.Symbol;
        // 查找当前方法是否带有自定义特性
        var checkAttribute = methodSymbol.GetAttributes()
            .FirstOrDefault(attr => attr.AttributeClass.Name == nameof(CompileTimeCheckAttribute));

        if (checkAttribute == null) return;

        // 这里替换为你的实际条件检查逻辑
        // 示例：检查当前编译是否为DEBUG模式
        bool conditionSatisfied = context.Compilation.Options.OptimizationLevel == OptimizationLevel.Debug;
        
        if (!conditionSatisfied)
        {
            // 获取特性中传入的错误信息
            var errorMsg = checkAttribute.ConstructorArguments[0].Value.ToString();
            // 生成并报告编译错误
            var diagnostic = Diagnostic.Create(Rule, methodSymbol.Locations[0], errorMsg);
            context.ReportDiagnostic(diagnostic);
        }
    }
}

3. 使用方式 #

在需要编译时检查的方法上标记自定义特性即可：

[CompileTimeCheck("必须在DEBUG模式下编译此方法")]
public void CriticalDebugMethod()
{
    // 方法逻辑
}

替代简化方案（无需特性） #

如果只是简单的编译符号检查，也可以直接用预处理器指令实现，无需特性：

#if !DEBUG
#error 此代码仅允许在DEBUG模式下编译
#endif

但如果需要更复杂的编译时逻辑检查（比如检查方法签名、引用类型等），自定义特性+分析器的方案更灵活可控。

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