如何保持c#枚举与数据库中的表同步

Question

这是一个稍微简化了的示例(我改变了它的位置以隐藏实际代码)。我有一个数据库驱动的应用程序和一个小工具，正在单独开发，这意味着与应用程序的工作。有一个表，定义了枚举，但它可能会随着时间的推移而改变。假设某个应用程序(医疗?)需要相当精确地跟踪一个人的性别。

select * from sex order by id;

id | mnemonic | description
0  | U        | Unknown sex
1  | M        | Male
2  | F        | Female
3  | T        | Trans-gender

和我的C# enum:

public enum SexType
{
    /// <summary>Unknown sex.</summary>
    [Description("U")]
    Unknown = 0,
    /// <summary>Male sex.</summary>
    [Description("M")]
    Male = 1,
    /// <summary>Female sex.</summary>
    [Description("F")]
    Female = 2
    /// <summary>Trans-gender sex.</summary>
    [Description("T")]
    TransGender = 3,
}

这里我不应该假设id是一个连续序列;这些枚举也不是可以组合的标志，尽管看起来是这样。

一些逻辑是在SQL中完成的;有些是在C#代码中完成的。例如，我可能有一个函数:

// Here we get id for some record from the database.
public static void IsMaleOrFemale(int sexId)
{
    if (!Enum.IsDefined(typeof(SexType), sexId))
    {
        string message = String.Format("There is no sex type with id {0}.", 
            sexId);
        throw new ArgumentException(message, "sexId");
    }
    var sexType = (SexType) sexId;
    return sexType == SexType.Male || sexType == SexType.Female;
}

只要表和枚举的定义都没有改变，就可以很好地工作。但桌子可能会。我不能依赖id列或助记符列来维持它们的值。我认为我能做的最好的就是进行单元测试，以确保表与我对枚举的定义同步。我正在尝试将值与id匹配，并将描述属性与助记符列匹配。

那么，我如何通过查看enum SexType来获得所有对的列表(以编程方式，在C#中):(0, "U"), (1, "M"), (2, "F"), (3, "T") ?

这个想法是将这个有序列表与select id, mnemonic from sex order by is asc;紧密比较。

为什么不改变SexType从enum类(或Struct)和填充列表从您的数据库在运行时?

你的结构(或类)看起来像这样:

public struct SexType
{
  public string Type;
  public string Code;
  public int Value;
}

然后你可以从你的数据库中填充一个List<SexType>(或者，如果你使用EF，你可以拉下一个类型为SexType的实体列表，或任何你的解决方案允许)。

假设您正在使用Linq和EF，在应用程序启动时进行急切加载，那么您应该可以很好地使用

查看Tangible T4Editor

我用它来做这件事。

安装它，然后将这个文件添加到你的项目中(更多信息在这篇博客文章中):

EnumGenerator.ttinclude

<#@ template debug="true" hostSpecific="true" #>
<#@ output extension=".generated.cs" #>
<#@ Assembly Name="System.Data" #>
<#@ import namespace="System.Data" #>
<#@ import namespace="System.Data.SqlClient" #>
<#@ import namespace="System.IO" #>
<#@ import namespace="System.Text.RegularExpressions" #>
<#  
    string tableName = Path.GetFileNameWithoutExtension(Host.TemplateFile);
    string path = Path.GetDirectoryName(Host.TemplateFile);
    string columnId = "ID";
    string columnName = "NAME";
    string connectionString = "[your connection string]";
#>
using System; 
using System.CodeDom.Compiler;  
namespace Your.NameSpace.Enums
{     
    /// <summary>
    /// <#= tableName #> auto generated enumeration
    /// </summary>
    [GeneratedCode("TextTemplatingFileGenerator", "10")]
    public enum <#= tableName #>
    { 
<#
    SqlConnection conn = new SqlConnection(connectionString);
    string command = string.Format("select {0}, {1} from {2} order by {0}", columnId, columnName, tableName);
    SqlCommand comm = new SqlCommand(command, conn);
    conn.Open();
    SqlDataReader reader = comm.ExecuteReader();
    bool loop = reader.Read(); 
    while(loop)
    { 
#>
        /// <summary>
        /// <#= reader[columnName] #> configuration setting.
        /// </summary>
        <#= reader[columnName] #> = <#= reader[columnId] #><# loop = reader.Read(); #><#= loop ? ",rn" : string.Empty #> 
<#  } 
#>  }
} 
<#+     private string Pascalize(object value)
        {
            Regex rx = new Regex(@"(?:^|[^a-zA-Z]+)(?<first>[a-zA-Z])(?<reminder>[a-zA-Z0-9]+)");
            return rx.Replace(value.ToString(), m => m.Groups["first"].ToString().ToUpper() + m.Groups["reminder"].ToString().ToLower());
        }      
        private string GetSubNamespace()
        {
            Regex rx = new Regex(@"(?:.+Servicess)");
            string path = Path.GetDirectoryName(Host.TemplateFile);
            return rx.Replace(path, string.Empty).Replace("\", ".");
        }
#>

(填写类的名称空间和连接字符串)

然后，您可以添加一个空白的TT文件，并使用一行<#@ include file="EnumGenerator "。ttinclude"#>"。该文件的名称应该与表的名称相同，并且该表的列必须命名为"ID"one_answers"name"，除非您在enum生成器类中更改了它。

保存TT文件时，Enum将自动生成

var choices = Enumerable.Zip(
    Enum.GetNames(typeof(SexType)),
    Enum.GetValues(typeof(SexType)).Cast<SexType>(),
    (name, value) => Tuple.Create(name, value));

如果您只是将枚举值命名为U, M, F和t会更容易。如果您这样做，Enum类的静态方法会为您完成所有工作。

除此之外，您需要使用一些反射来挖掘Description属性

public IEnumerable<Tuple<string, int>> GetEnumValuePairs(Type enumType)
{
    if(!enumType.IsEnum)
    {
        throw new ArgumentException();
    }
    List<Tuple<string, int>> result = new List<Tuple<string, int>>();
    foreach (var value in Enum.GetValues(enumType))
    {
        string fieldName = Enum.GetName(enumType, value);
        FieldInfo fieldInfo = enumType.GetField(fieldName);
        var descAttribute = fieldInfo.GetCustomAttributes(false).Where(a => a is DescriptionAttribute).Cast<DescriptionAttribute>().FirstOrDefault();
        // ideally check if descAttribute is null here
        result.Add(Tuple.Create(descAttribute.Description, (int)value));
    }
    return result;
}

我会使用T4文本模板，当模板被处理(保存和/或构建)时，它会动态地为您生成枚举。

然后，这个模板(包括c#代码)将根据数据库的内容为你生成一个。cs文件中的枚举定义。

当然，这意味着您必须在保存/编译时访问数据库，但这是保证这两者在编译时一致的唯一方法。

在运行时，您可能希望对数据库执行一次检查，以确保枚举和数据库中的值一致。

List<Tuple<int, string>> pairs = new List<Tuple<int,string>>();
     Type enumType = typeof(SexType);
     foreach (SexType enumValue in Enum.GetValues(enumType))
     {
        var customAttributes = enumType.GetField(Enum.GetName(enumType, enumValue)).
           GetCustomAttributes(typeof(DescriptionAttribute), false);
        DescriptionAttribute descriptionAttribute = 
           (DescriptionAttribute)customAttributes.FirstOrDefault(attr => 
              attr is DescriptionAttribute);
        if (descriptionAttribute != null)
           pairs.Add(new Tuple<int, string>((int)enumValue, descriptionAttribute.Description));
     }