.NET Standard 2.0程序集日期属性编译期验证方案问询

背景 #

我想要实现一个可应用于.NET程序集的自定义属性，用于标记预发布测试版本的过期日期（超过该日期开发者将不再支持此版本），且该属性需基于.NET Standard 2.0编写。

由于无法直接传入DateTime类型参数，我采用符合ISO8601标准（YYYY-MM-DD）的字符串作为参数，并通过DateTime.Parse()将其转换为DateTime类型。目前已完成的属性代码如下：

[AttributeUsage(AttributeTargets.Assembly, Inherited = false, AllowMultiple = false)]
public sealed class UnstableReleaseExpiryAttribute : Attribute
{
    public UnstableReleaseExpiryAttribute(string expiryDate)
    {
        ExpiryDate = expiryDate;
    }

    public DateTime Expiry
    {
        get
        {
            if (ExpiryDate != null && DateTime.TryParse(ExpiryDate, out DateTime expiry))
                return expiry;
            return DateTime.MaxValue;
        }
    }

    public string ExpiryDate { get; }
}

使用方式如下：

[assembly: UnstableReleaseExpiry("2018-05-24")]

问题 #

是否可以通过正则表达式等方式验证输入的字符串，在日期无法解析时阻止编译？我原本考虑继承ValidationAttribute，但该类在.NET Standard 2.0中不可用，请问还有其他实现方法吗？

好问题！在.NET Standard 2.0里确实没法直接用ValidationAttribute做编译期验证，但我们可以通过Roslyn分析器来实现这个需求——这是.NET生态中做编译期代码检查的标准方案，完全能满足你的要求。

下面分步骤给你讲怎么做：

1. 创建Roslyn分析器项目 #

首先，你需要新建一个"Analyzer with Code Fix"项目（Visual Studio模板里就能找到），它会帮你搭建好Roslyn分析器的基础框架，而且支持.NET Standard 2.0，能和你的属性库完美兼容。

2. 编写分析逻辑，验证日期格式 #

在分析器类里，我们要找到所有应用了UnstableReleaseExpiryAttribute的程序集级别特性，然后检查传入的字符串参数是否符合ISO8601的YYYY-MM-DD格式，甚至可以进一步验证日期的有效性（比如拒绝"2024-02-30"这种无效日期）。

核心代码示例如下：

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class UnstableReleaseExpiryAnalyzer : DiagnosticAnalyzer
{
    // 定义诊断规则的ID、标题等信息
    public const string DiagnosticId = "UnstableReleaseExpiry_InvalidDate";
    private static readonly LocalizableString Title = new LocalizableResourceString(nameof(Resources.AnalyzerTitle), Resources.ResourceManager, typeof(Resources));
    private static readonly LocalizableString MessageFormat = new LocalizableResourceString(nameof(Resources.AnalyzerMessageFormat), Resources.ResourceManager, typeof(Resources));
    private static readonly LocalizableString Description = new LocalizableResourceString(nameof(Resources.AnalyzerDescription), Resources.ResourceManager, typeof(Resources));
    private const string Category = "Usage";

    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(AnalyzeAssembly, SymbolKind.Assembly);
    }

    private void AnalyzeAssembly(SymbolAnalysisContext context)
    {
        var assemblySymbol = (IAssemblySymbol)context.Symbol;
        // 找到所有UnstableReleaseExpiryAttribute的应用
        var expiryAttributes = assemblySymbol.GetAttributes()
            .Where(attr => attr.AttributeClass?.Name == nameof(UnstableReleaseExpiryAttribute))
            .ToList();

        foreach (var attr in expiryAttributes)
        {
            // 获取传入的日期字符串参数
            if (attr.ConstructorArguments.Length == 0 || attr.ConstructorArguments[0].Value is not string dateStr)
            {
                context.ReportDiagnostic(Diagnostic.Create(Rule, attr.ApplicationSyntaxReference?.GetSyntax().GetLocation(), "缺少有效的日期参数"));
                continue;
            }

            // 第一步：用正则验证格式是否为YYYY-MM-DD
            var dateRegex = new Regex(@"^\d{4}-\d{2}-\d{2}$", RegexOptions.Compiled);
            if (!dateRegex.IsMatch(dateStr))
            {
                context.ReportDiagnostic(Diagnostic.Create(Rule, attr.ApplicationSyntaxReference?.GetSyntax().GetLocation(), $"日期格式无效：{dateStr}，请使用YYYY-MM-DD格式"));
                continue;
            }

            // 第二步：验证日期是否有效（比如2月30日这种无效日期）
            if (!DateTime.TryParseExact(dateStr, "yyyy-MM-dd", CultureInfo.InvariantCulture, DateTimeStyles.None, out _))
            {
                context.ReportDiagnostic(Diagnostic.Create(Rule, attr.ApplicationSyntaxReference?.GetSyntax().GetLocation(), $"日期无效：{dateStr}"));
            }
        }
    }
}

3. 关联分析器和你的属性库 #

把分析器项目和你的自定义属性项目关联起来，或者将分析器打包成NuGet包，这样在使用你的属性时，分析器会自动生效——只要开发者写了不符合要求的日期字符串，编译时就会直接抛出错误，阻止编译。

为什么这个方案可行？ #

• Roslyn分析器是在编译期运行的，能在代码编译前就检查出问题，完全符合你"阻止编译"的需求；
• 它支持.NET Standard 2.0，和你的属性目标框架一致；
• 不仅能验证格式，还能验证日期的实际有效性，比单纯的正则更可靠。

另外，如果你不想写完整的Roslyn分析器，还有一个轻量替代方案：在属性的构造函数里抛出异常，但注意这个异常是在运行时触发的，只有当程序访问这个属性时才会报错，没法在编译阶段阻止，所以还是Roslyn分析器的方案更贴合你的需求。

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