在数据库中存储枚举的最佳方法

Question

使用 C# 和 Visual Studio 以及 MySQL 数据连接器在数据库中存储枚举的最佳方法是什么。

我将创建一个包含 100 多个枚举的新项目，其中大部分必须存储在数据库中。为每个转换器创建转换器将是一个漫长的过程，因此我想知道 Visual Studio 或某人是否有任何我没有听说过的方法。

Answer 1

    [Required]
    public virtual int PhoneTypeId
    {
        get
        {
            return (int)this.PhoneType;
        }
        set
        {
            PhoneType = (PhoneTypes)value;
        }
    }
    [EnumDataType(typeof(PhoneTypes))]
    public PhoneTypes PhoneType { get; set; }

public enum PhoneTypes
{
    Mobile = 0,
    Home = 1,
    Work = 2,
    Fax = 3,
    Other = 4
}

效果就像一个魅力！无需在代码中转换 (int)Enum 或 (Enum)int。只需首先使用 enum 和 ef 代码将为您保存 int 。 ps：“[EnumDataType(typeof(PhoneTypes))]”属性不是必需的，如果您需要附加功能，只需额外添加即可。

或者你可以这样做：

[Required]
    public virtual int PhoneTypeId { get; set; }
    [EnumDataType(typeof(PhoneTypes))]
    public PhoneTypes PhoneType
    {
        get
        {
            return (PhoneTypes)this.PhoneTypeId;
        }
        set
        {
            this.PhoneTypeId = (int)value;
        }
    }

Answer 2

我们将其存储为 int 或 long，然后我们可以来回转换它们。可能不是最强大的解决方案，但这就是我们所做的。

我们正在使用类型化数据集，因此，例如：

enum BlockTreatmentType 
{
    All = 0
};

// blockTreatmentType is an int property
blockRow.blockTreatmentType = (int)BlockTreatmentType.All;
BlockTreatmentType btt = (BlockTreatmentType)blockRow.blocktreatmenttype;

Answer 3

如果您需要将枚举字段的字符串值存储在数据库中，最好如下所示。
例如，如果您使用不支持枚举字段的 SQLite，则可能需要它。

[Required]
public string PhoneTypeAsString
{
    get
    {
        return this.PhoneType.ToString();
    }
    set
    {
        PhoneType = (PhoneTypes)Enum.Parse( typeof(PhoneTypes), value, true);
    }
}

public PhoneTypes PhoneType{get; set;};

public enum PhoneTypes
{
    Mobile = 0,
    Home = 1,
    Work = 2,
    Fax = 3,
    Other = 4
}

Answer 4

如果您想要存储所有枚举值，您可以尝试使用下表来存储枚举及其成员，以及添加这些值的代码片段。但是，我只会在安装时执行此操作，因为在重新编译之前这些值永远不会改变！

数据库表：

   create table EnumStore (
    EnumKey int NOT NULL identity primary key,
    EnumName varchar(100)
);
GO

create table EnumMember (
    EnumMemberKey int NOT NULL identity primary key,
    EnumKey int NOT NULL,
    EnumMemberValue int,
    EnumMemberName varchar(100)
);
GO
--add code to create foreign key between tables, and index on EnumName, EnumMemberValue, and EnumMemberName

C# 代码片段：

void StoreEnum<T>() where T: Enum
    {
        Type enumToStore = typeof(T);
        string enumName = enumToStore.Name;

        int enumKey = DataAccessLayer.CreateEnum(enumName);
        foreach (int enumMemberValue in Enum.GetValues(enumToStore))
        {
            string enumMemberName = Enum.GetName(enumToStore, enumMemberValue);
            DataAccessLayer.AddEnumMember(enumKey, enumMemberValue, enumMemberName);
        }
    }

Answer 5

最后，您将需要一种很好的方法来处理重复的编码任务，例如枚举转换器。您可以使用代码生成器，例如 MyGeneration 或 CodeSmith 等等，或者可能是一个 ORM 映射器，例如 nHibernate< /a> 为您处理一切。

至于结构......对于数百个枚举，我首先考虑尝试将数据组织到一个表中，该表可能看起来像这样：（伪sql）

MyEnumTable(
EnumType as int,
EnumId as int PK,
EnumValue as int )

这将允许您将枚举信息存储在单个表中。 EnumType 也可以是定义不同枚举的表的外键。

您的 biz 对象将通过 EnumId 链接到该表。枚举类型仅用于 UI 中的组织和过滤。当然，使用所有这些取决于您的代码结构和问题域。

顺便说一句，在这种情况下，您可能希望在 EnumType 上设置聚集索引，而不是保留在 PKey 上创建的默认集群 idx。

Answer 6

有些事情你应该考虑。

枚举列是否将直接由其他应用程序（例如报告）使用。这将限制枚举以整数格式存储的可能性，因为除非报告具有自定义逻辑，否则该值出现在报告中时没有任何意义。

您的应用程序的 i18n 需求是什么？如果它仅支持一种语言，您可以将枚举保存为文本并创建一个辅助方法来从描述字符串进行转换。您可以使用 [DescriptionAttribute] 来实现此目的，并且可以通过搜索 SO 找到转换方法。

另一方面，如果您需要支持多种语言和外部应用程序对数据的访问，您可以开始考虑枚举是否真的是答案。如果场景更复杂，可以考虑其他选项，例如查找表。

当枚举自我包含在代码中时，它们是非常好的......当它们跨越边界时，事情往往会变得有点混乱。

---

更新：

您可以使用Enum.ToObject方法从整数进行转换。这意味着您在转换时知道枚举的类型。如果您想让它完全通用，您需要将枚举的类型与其值一起存储在数据库中。您可以创建数据字典支持表来告诉您哪些列是枚举以及它们的类型。

Answer 7

如果你想存储整数，你不需要做任何事情。只需在 EF 中映射您的财产即可。
如果你想将它们存储为字符串，请使用转换器。

Int（db类型为smallint）：

public override void Configure(EntityTypeBuilder<MyEfEntity> b)
{
    ...
    b.Property(x => x.EnumStatus);
}

String（db类型为varchar（50））：

public override void Configure(EntityTypeBuilder<MyEfEntity> b)
{
    ...
    b.Property(x => x.EnumStatus).HasConversion<EnumToStringConverter>();
}

如果您想保存db数据使用情况，请使用smallint作为db中的列。但是数据不是人类可读的，您应该为每个枚举项设置一个索引，并且永远不要弄乱它们：

public enum EnumStatus
{
    Active = 0, // Never change this index
    Archived = 1, // Never change this index
}

如果您想让数据库中的数据更具可读性，您可以将它们保存为字符串（例如 varchar(50)）。您不必担心索引，只需在更改枚举名称时更新数据库中的字符串即可。缺点：列大小会使数据使用成本更高。这意味着如果您的表的行数在 1,000,000 以内，则可能会对数据库大小和性能产生影响。

另外，作为解决方案，您可以使用短枚举名称：

public enum EnumStatus
{
    [Display(Name = "Active")]
    Act,
    [Display(Name = "Archived")]
    Arc,
}

或者使用您自己的转换器使数据库中的名称更短：

public enum EnumStatus
{
    [Display(Name = "Active", ShortName = "Act")]
    Active,
    [Display(Name = "Archived", ShortName = "Arc")]
    Archived,
}
...
public override void Configure(EntityTypeBuilder<MyEfEntity> b)
{
    ...
    b.Property(x => x.EnumStatus).HasConversion<MyShortEnumsConverter>();
}

可以在此处找到更多信息：

EF5：https://learn.microsoft.com/en-us/ef/ef6/modeling/code-first/data-类型/枚举

EF6：https://learn .microsoft.com/en-us/ef/core/modeling/value-conversions

Answer 8

我不确定它是否是最灵活的，但您可以简单地存储它们的字符串版本。它当然是可读的，但可能难以维护。枚举与字符串之间的转换非常容易：

public enum TestEnum
{
    MyFirstEnum,
    MySecondEnum
}

static void TestEnums()
{
    string str = TestEnum.MyFirstEnum.ToString();
    Console.WriteLine( "Enum = {0}", str );
    TestEnum e = (TestEnum)Enum.Parse( typeof( TestEnum ), "MySecondEnum", true );
    Console.WriteLine( "Enum = {0}", e );
}

Answer 9

可以通过为每个枚举创建一致的表来使用数据库优先方法，其中 Id 列名称与表名称匹配。在数据库中使用枚举值来支持外键约束和视图中的友好列是有利的。目前，我们支持分散在众多版本数据库中的约 100 种枚举类型。

对于代码优先首选项，可以反转下面所示的 T4 策略来写入数据库。

create table SomeSchema.SomeEnumType (
  SomeEnumTypeId smallint NOT NULL primary key,
  Name varchar(100) not null,
  Description nvarchar(1000),
  ModifiedUtc datetime2(7) default(sysutcdatetime()),
  CreatedUtc datetime2(7) default(sysutcdatetime()),
);

每个表都可以使用 T4 模板 (*.tt) 脚本导入到 C# 中。

1. 创建一个“枚举项目”。添加如下所示的 .tt 文件。
2. 为每个数据库架构名称创建一个子文件夹。
3. 对于每个枚举类型，创建一个名称为 SchemaName.TableName.tt 的文件。该文件
   内容始终是同一行：<#@ include
   文件=“..\EnumGenerator.ttinclude”#>
4. 然后要创建/更新枚举，请右键单击 1 个或多个文件并
   “运行自定义工具”（我们还没有自动更新）。它将向项目添加/更新 .cs 文件：

using System.CodeDom.Compiler;
namespace TheCompanyNamespace.Enumerations.Config
{
    [GeneratedCode("Auto Enum from DB Generator", "10")]
    public enum DatabasePushJobState
    {     
          Undefined = 0,
          Created = 1,        
    } 
    public partial class EnumDescription
    {
       public static string Description(DatabasePushJobState enumeration)
       {
          string description = "Unknown";
          switch (enumeration)
          {                   
              case DatabasePushJobState.Undefined:
                  description = "Undefined";
                  break;

              case DatabasePushJobState.Created:
                  description = "Created";
                  break;                 
           }
           return description;
       }
    }
    // select DatabasePushJobStateId, Name, coalesce(Description,Name) as Description
    //    from TheDefaultDatabase.[SchName].[DatabasePushJobState]
    //   where 1=1 order by DatabasePushJobStateId 
 }

最后是有点粗糙的 T4 脚本（通过众多解决方法进行简化）。它需要根据您的环境进行定制。调试标志可以将消息输出到 C# 中。右键单击 .tt 文件时还有一个“调试 T4 模板”选项。
EnumGenerator.ttinclude：

<#@ template debug="true" hostSpecific="true" #>
<#@ output extension=".generated.cs" #>
<#@ Assembly Name="EnvDTE" #>
<#@ Assembly Name="System.Core" #>
<#@ Assembly Name="System.Data" #>
<#@ assembly name="$(TargetPath)" #>
<#@ import namespace="EnvDTE" #>
<#@ import namespace="System" #>
<#@ import namespace="System.Collections" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="System.Data" #>
<#@ import namespace="System.Data.SqlClient" #>
<#@ import namespace="System.IO" #>
<#@ import namespace="System.Text.RegularExpressions" #>
<#  
    bool doDebug = false;   // include debug statements to appear in generated output    

    string schemaTableName = Path.GetFileNameWithoutExtension(Host.TemplateFile);
    string schema = schemaTableName.Split('.')[0];
    string tableName = schemaTableName.Split('.')[1];

    string path = Path.GetDirectoryName(Host.TemplateFile);    
    string enumName = tableName;
    string columnId = enumName + "Id";
    string columnName = "Name"; 
    string columnDescription = "Description";

    string currentVersion = CompanyNamespace.Enumerations.Constants.Constants.DefaultDatabaseVersionSuffix;

    // Determine Database Name using Schema Name
    //
    Dictionary<string, string> schemaToDatabaseNameMap = new Dictionary<string, string> {
        { "Cfg",        "SomeDbName" + currentVersion },
        { "Common",     "SomeOtherDbName" + currentVersion }
        // etc.     
    };

    string databaseName;
    if (!schemaToDatabaseNameMap.TryGetValue(schema, out databaseName))
    {
        databaseName = "TheDefaultDatabase"; // default if not in map
    }

    string connectionString = @"Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=" + databaseName + @";Data Source=Machine\Instance";

    schema = "[" + schema + "]";
    tableName = "[" + tableName + "]";

    string whereConstraint = "1=1";  // adjust if needed for specific tables

  // Get containing project
  IServiceProvider serviceProvider = (IServiceProvider)Host;
  DTE dte = (DTE)serviceProvider.GetService(typeof(DTE));
  Project project = dte.Solution.FindProjectItem(Host.TemplateFile).ContainingProject;
#>
using System;
using System.CodeDom.Compiler;

namespace <#= project.Properties.Item("DefaultNamespace").Value #><#= Path.GetDirectoryName(Host.TemplateFile).Remove(0, Path.GetDirectoryName(project.FileName).Length).Replace("\\", ".") #>
{
    /// <summary>
    /// Auto-generated Enumeration from Source Table <#= databaseName + "." + schema + "." + tableName #>.  Refer to end of file for SQL.
    /// Please do not modify, your changes will be lost!
    /// </summary>
    [GeneratedCode("Auto Enum from DB Generator", "10")]
    public enum <#= enumName #>
    {       
<#
        SqlConnection conn = new SqlConnection(connectionString);
        // Description is optional, uses name if null
        string command = string.Format(
            "select {0}, {1}, coalesce({2},{1}) as {2}" + "\n  from {3}.{4}.{5}\n where {6} order by {0}", 
                columnId,           // 0
                columnName,         // 1
                columnDescription,  // 2
                databaseName,       // 3
                schema,             // 4
                tableName,          // 5
                whereConstraint);   // 6
        #><#= DebugCommand(databaseName, command, doDebug) #><#

        SqlCommand comm = new SqlCommand(command, conn);

        conn.Open();

        SqlDataReader reader = comm.ExecuteReader();
        bool loop = reader.Read();

        while(loop)
        {
#>      /// <summary>
        /// <#= reader[columnDescription] #>
        /// </summary>
        <#= Pascalize(reader[columnName]) #> = <#= reader[columnId] #><# loop = reader.Read(); #><#= loop ? ",\r\n" : string.Empty #>
<#
        }
#>    }


    /// <summary>
    /// A helper class to return the Description for each enumeration value
    /// </summary>
    public partial class EnumDescription
    {
        public static string Description(<#= enumName #> enumeration)
        {
            string description = "Unknown";

            switch (enumeration)
            {<#
    conn.Close();
    conn.Open();
    reader = comm.ExecuteReader();
    loop = reader.Read();

    while(loop)
    {#>                 
                    case <#= enumName #>.<#= Pascalize(reader[columnName]) #>:
                        description = "<#= reader[columnDescription].ToString().Replace("\"", "\\\"") #>";
                        break;
                    <# loop = reader.Read(); #>
<#
      }
      conn.Close();
#> 
            }

            return description;
        }
    }
    /*
        <#= command.Replace("\n", "\r\n        ") #>
    */
}
<#+     
    private string Pascalize(object value)
    {
        Regex rxStartsWithKeyWord = new Regex(@"^[0-9]|^abstract$|^as$|^base$|^bool$|^break$|^byte$|^case$|^catch$|^char$|^checked$|^class$|^const$|^continue$|^decimal$|^default$|^delegate$|^do$|^double$|^else$|^enum$|^event$|^explicit$|^extern$|^$false|^finally$|^fixed$|^float$|^for$|^foreach$|^goto$|^if$|^implicit$|^in$|^int$|^interface$|^internal$|^is$|^lock$|^long$|^namespace$|^new$|^null$|^object$|^operator$|^out$|^overrride$|^params$|^private$|^protected$|^public$|^readonly$|^ref$|^return$|^sbyte$|^sealed$|^short$|^sizeof$|^stackalloc$|^static$|^string$|^struct$|^switch$|^this$|^thorw$|^true$|^try$|^typeof$|^uint$|^ulong$|^unchecked$|^unsafe$|^ushort$|^using$|^virtual$|^volatile$|^void$|^while$", RegexOptions.Compiled);

        Regex rx = new Regex(@"(?:[^a-zA-Z0-9]*)(?<first>[a-zA-Z0-9])(?<reminder>[a-zA-Z0-9]*)(?:[^a-zA-Z0-9]*)");
        string rawName = rx.Replace(value.ToString(), m => m.Groups["first"].ToString().ToUpper() + m.Groups["reminder"].ToString());

        if (rxStartsWithKeyWord.Match(rawName).Success)
            rawName =  "_" + rawName;

        return rawName;    
    }

    private string DebugCommand(string databaseName, string command, bool doDebug)
    {       
        return doDebug
            ? "        // use " + databaseName + ";  " + command + ";\r\n\r\n"
            : "";
    }   
#>

希望实体框架有一天能够支持这些答案的组合，以在记录和值的数据库镜像中提供 C# 枚举强类型。

Answer 10

如果您使用的是 EntityFrameworkCore。 （我的版本是5.0.10），而不是像这样直接使用Fluent API：（这将在数据库中保存Home/Other。在数据库中创建Type列作为varchar/nvarchar）

在您的上下文文件中，您继承 DbContext

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
            modelBuilder
                .Entity<StudentAddress>()
                .Property(address => address.Type)
                .HasConversion(
                    value => value.ToString(),
                    value => (AddressType)Enum.Parse(typeof(AddressType), value));
}    

我的实体：

[Table("Student", Schema = "Student")]
public class Student 
{
    //...
    public AddressType Type { get; set; }
}

我的枚举：

    public enum AddressType
    {
        Home,
        Other
    }

额外注释，不是强制性的，与上面的示例无关： 在我的这个场景中，这不是必需的。但只要需要，您始终可以在数据库级别创建约束。

    ALTER TABLE [Document].[Document] WITH CHECK ADD  CONSTRAINT [CHK_DocumentType] CHECK  (([DocumentType]="DOC" OR [DocumentType]="PDF" OR [DocumentType]="IMAGE" OR [DocumentType]="OTHER"))

    ALTER TABLE [Document].[Document] CHECK CONSTRAINT [CHK_DocumentType]

Answer 11

为什么不尝试将枚举与数据库完全分离呢？我发现这篇文章在处理类似的事情时是一个很好的参考：

http://stevesmithblog.com/blog/reducing-sql-lookup-tables-and-function-properties-in-nhibernate/

无论您使用什么数据库，其中的想法都应该适用。例如，在 MySQL 中，您可以使用“enum”数据类型来强制遵守编码枚举：

http://dev.mysql.com/doc/refman/5.0/en/enum.html