如何在编译时避免EF Core实体字符串超出数据库列长度？

我定义了一个包含千余条目的Dictionary<string, string>，示例代码如下：

Dictionary<string, string> dic = new Dictionary<string, string>
 {
   ...
   { PlanVariablesDefinitions.Growth_Proposed_Savings_Rate, L.GrowthProposedSavingsRate.ToString("0.00") },
   { PlanVariablesDefinitions.Growth_Proposed_Income_Growth_Rate, L.GrowthProposedIncomeGrowthRate.ToString() },
   { PlanVariablesDefinitions.Growth_Proposed_Portfolio_Growth_Rate, L.GrowthProposedPortfolioGrowthRate.ToString() },
   { PlanVariablesDefinitions.Growth_Proposed_FMVRealEstate_Growth_Rate, L.GrowthProposedFMVRealEstateGrowthRate.ToString() },
    ...
};     

其中常量定义如下：

public const string Growth_Proposed_Savings_Rate = "Growth_Proposed_Savings_Rate";
public const string Growth_Proposed_Income_Growth_Rate = "Growth_Proposed_Income_Growth_Rate";
public const string Growth_Proposed_Portfolio_Growth_Rate = "Growth_Proposed_Portfolio_Growth_Rate";
public const string Growth_Proposed_FMVRealEstate_Growth_Rate = "Growth_Proposed_FMVRealEstate_Growth_Rate";

该字典的Key会存入SQL数据库的nvarchar(50)类型列中。重构时如果把常量值修改为超过50字符的内容（比如把Growth_Proposed_FMVRealEstate_Growth_Rate改成Growth_Proposed_FMVRealEstate_Growth_Rate_from_2023_2024_First_Quater），开发人员往往意识不到这会导致后续数据库保存时系统崩溃。

目前我通过以下代码在运行时提前检测并抛出异常：

foreach (var item in dic)
    if (item.Key.Length > 50)
        throw new Exception($"{item.Key} is over 50 chars and will throw an exception on DB save.");

我想知道：能否通过特性或其他方案在编译时避免此类问题，替代当前的临时解决方案？

方案1：C# 11+常量编译时长度校验 #

如果使用C# 11及以上版本，可以直接在常量定义类中添加静态构造函数，利用const表达式在编译时检查长度：

public static class PlanVariablesDefinitions
{
    private const int MaxKeyLength = 50;

    public const string Growth_Proposed_Savings_Rate = "Growth_Proposed_Savings_Rate";
    public const string Growth_Proposed_Income_Growth_Rate = "Growth_Proposed_Income_Growth_Rate";
    public const string Growth_Proposed_Portfolio_Growth_Rate = "Growth_Proposed_Portfolio_Growth_Rate";
    public const string Growth_Proposed_FMVRealEstate_Growth_Rate = "Growth_Proposed_FMVRealEstate_Growth_Rate";

    static PlanVariablesDefinitions()
    {
        // 编译时验证，长度超标则直接报错
        _ = Growth_Proposed_Savings_Rate.Length <= MaxKeyLength ? true : throw new InvalidOperationException();
        _ = Growth_Proposed_Income_Growth_Rate.Length <= MaxKeyLength ? true : throw new InvalidOperationException();
        _ = Growth_Proposed_Portfolio_Growth_Rate.Length <= MaxKeyLength ? true : throw new InvalidOperationException();
        _ = Growth_Proposed_FMVRealEstate_Growth_Rate.Length <= MaxKeyLength ? true : throw new InvalidOperationException();
        // 其他常量依次添加校验
    }
}

不过这种方式需要手动维护校验代码，对于千余条目的场景，可以结合T4模板自动生成校验逻辑，减少重复工作。

方案2：自定义Roslyn代码分析器 #

这是最适合大量常量场景的方案，通过编写Roslyn分析器，在编译时自动扫描指定类中的字符串常量，一旦长度超标就直接在IDE中提示错误，阻止编译。

核心分析器代码示例 #

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class VariableKeyLengthAnalyzer : DiagnosticAnalyzer
{
    public const string DiagnosticId = "VariableKey001";
    private const string Category = "Usage";
    private static readonly LocalizableString Title = "变量Key长度超过数据库限制";
    private static readonly LocalizableString MessageFormat = "变量 '{0}' 的值长度为 {1}，超过nvarchar(50)的最大长度限制";
    private static readonly LocalizableString Description = "数据库列类型为nvarchar(50)，变量Key长度不能超过50字符";

    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(AnalyzeSymbol, SymbolKind.Field);
    }

    private void AnalyzeSymbol(SymbolAnalysisContext context)
    {
        var fieldSymbol = (IFieldSymbol)context.Symbol;
        // 只处理PlanVariablesDefinitions类中的const string字段
        if (!fieldSymbol.IsConst || fieldSymbol.Type.SpecialType != SpecialType.System_String ||
            fieldSymbol.ContainingType.Name != "PlanVariablesDefinitions")
        {
            return;
        }

        var constantValue = fieldSymbol.ConstantValue as string;
        if (constantValue != null && constantValue.Length > 50)
        {
            var diagnostic = Diagnostic.Create(Rule, fieldSymbol.Locations[0], 
                fieldSymbol.Name, constantValue.Length);
            context.ReportDiagnostic(diagnostic);
        }
    }
}

将分析器打包成NuGet包添加到项目后，只要修改常量值超过50字符，IDE会立即显示错误，编译也会失败，从根源上避免问题。

方案3：强类型枚举+特性校验 #

把字符串常量替换为枚举，用特性指定对应的字符串值，并在特性构造函数中做编译时长度校验（需C# 11+支持）：

1. 定义特性和枚举 #

[AttributeUsage(AttributeTargets.Field)]
public class VariableKeyAttribute : Attribute
{
    public string Key { get; }
    public VariableKeyAttribute(string key)
    {
        // 编译时检查长度，超标则报错
        if (key.Length > 50)
        {
            throw new ArgumentOutOfRangeException(nameof(key), "Key长度不能超过50字符");
        }
        Key = key;
    }
}

public enum PlanVariables
{
    [VariableKey("Growth_Proposed_Savings_Rate")]
    GrowthProposedSavingsRate,
    [VariableKey("Growth_Proposed_Income_Growth_Rate")]
    GrowthProposedIncomeGrowthRate,
    [VariableKey("Growth_Proposed_Portfolio_Growth_Rate")]
    GrowthProposedPortfolioGrowthRate,
    [VariableKey("Growth_Proposed_FMVRealEstate_Growth_Rate")]
    GrowthProposedFMVRealEstateGrowthRate
}

2. 编写扩展方法获取Key #

public static class PlanVariablesExtensions
{
    public static string GetKey(this PlanVariables variable)
    {
        var field = variable.GetType().GetField(variable.ToString());
        var attribute = field.GetCustomAttribute<VariableKeyAttribute>();
        return attribute?.Key ?? throw new InvalidOperationException("未配置VariableKeyAttribute");
    }
}

3. 重构字典初始化代码 #

Dictionary<string, string> dic = new Dictionary<string, string>
{
    { PlanVariables.GrowthProposedSavingsRate.GetKey(), L.GrowthProposedSavingsRate.ToString("0.00") },
    // 其他条目同理
};

这种方式不仅能在编译时检测长度，还能消除魔法字符串，提升代码可维护性。

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