如何在 EF6代码中创建与枚举相对应的表首先？

小开

最佳答案

由于 EF 不能自动处理它，是的，这是推荐的方法。

我建议对你提供的文章进行一些修改。

重命名您的 enum

public enum FacultyEnum { Eng, Math, Eco }

创建一个表示表的类

public class Faculty
{
private Faculty(FacultyEnum @enum)
{
Id = (int)@enum;
Name = @enum.ToString();
Description = @enum.GetEnumDescription();
}


protected Faculty() { } //For EF


[Key, DatabaseGenerated(DatabaseGeneratedOption.None)]
public int Id { get; set; }


[Required, MaxLength(100)]
public string Name { get; set; }


[MaxLength(100)]
public string Description { get; set; }


public static implicit operator Faculty(FacultyEnum @enum) => new Faculty(@enum);


public static implicit operator FacultyEnum(Faculty faculty) => (FacultyEnum)faculty.Id;
}

你的模型引用了这个类

public class ExampleClass
{
public virtual Faculty Faculty { get; set; }
}

创建一个扩展方法以从枚举值和种子值获取描述

using System;
using System.ComponentModel;
using System.Data.Entity;
using System.Data.Entity.Migrations;
using System.Linq;


public static class Extensions
{
public static string GetEnumDescription<TEnum>(this TEnum item)
=> item.GetType()
.GetField(item.ToString())
.GetCustomAttributes(typeof(DescriptionAttribute), false)
.Cast<DescriptionAttribute>()
.FirstOrDefault()?.Description ?? string.Empty;


public static void SeedEnumValues<T, TEnum>(this IDbSet<T> dbSet, Func<TEnum, T> converter)
where T : class => Enum.GetValues(typeof(TEnum))
.Cast<object>()
.Select(value => converter((TEnum)value))
.ToList()
.ForEach(instance => dbSet.AddOrUpdate(instance));
}

把种子放进 configuration.cs 里

protected override void Seed(Temp.MyClass context)
{
context.Facultys.SeedEnumValues<Faculty, FacultyEnum>(@enum => @enum);
context.SaveChanges();
}

在 DbContext 中添加枚举表

public class MyClass : DbContext
{
public DbSet<ExampleClass> Examples { get; set; }
public DbSet<Faculty> Facultys { get; set; }
}

好好利用

var example = new ExampleClass();
example.Faculty = FacultyEnum.Eng;


if (example.Faculty == FacultyEnum.Math)
{
//code
}

去记住

如果不在 Faculty 属性中添加虚拟，则必须使用来自 DbSet 的 Include 方法来执行 Eager Load

var exampleFromDb = dbContext.Examples.Include(x => x.Faculty).SingleOrDefault(e => e.Id == 1);
if (example.Faculty == FacultyEnum.Math)
{
//code
}

如果教员属性是虚拟的，那么就使用它

var exampleFromDb = dbContext.Examples.Find(1);
if (example.Faculty == FacultyEnum.Math)
{
//code
}

小开

另一种可能性是，如果您想使您的模型更简单，POCO 风格，那么使用枚举作为一个属性，该属性将被实体框架存储为一个整数。

然后，如果希望在数据库中创建和更新“ enum 表”，我建议使用 nuget 包 https://github.com/timabell/ef-enum-to-lookup，并在 EF 迁移种子方法中使用它，例如:

public enum Shape
{
Square,
Round
}


public class Foo
{
public int Id { get; set; }
public Shape Shape { get; set; }
}


public class MyDbContext : DbContext
{
public DbSet<Foo> Foos { get; set; }
}


using(var context = new MyDbContext())
{
var enumToLookup = new EnumToLookup
{
TableNamePrefix = string.Empty,
NameFieldLength = 50,
UseTransaction = true
};
enumToLookup.Apply(context);
}

这将创建带有两行分别命名为 Square 和 Round 的“塑形”表，并在表“ Foo”中使用相关的外键约束

小开

基于@Alberto Monteiro 的回答，我已经创建了泛型类，以防有多个表时使用。这里的注意事项是 Id 是 TEnum 的类型。以这种方式使用它将提供使用 Enum 来声明属性类型的选项。

public class Question
{
public QuestionTypeEnum QuestionTypeId { get; set; } // field property


public QuestionType QuestionType { get; set; } // navigation property
}

默认情况下，Enum 使用整数，因此 db 提供程序将创建“ int”类型的字段。

EnumTable.cs

    public class EnumTable<TEnum>
where TEnum : struct
{
public TEnum Id { get; set; }
public string Name { get; set; }


protected EnumTable() { }


public EnumTable(TEnum enumType)
{
ExceptionHelpers.ThrowIfNotEnum<TEnum>();


Id = enumType;
Name = enumType.ToString();
}


public static implicit operator EnumTable<TEnum>(TEnum enumType) => new EnumTable<TEnum>(enumType);
public static implicit operator TEnum(EnumTable<TEnum> status) => status.Id;
}

Exceptionhelpers.cs

static class ExceptionHelpers
{
public static void ThrowIfNotEnum<TEnum>()
where TEnum : struct
{
if (!typeof(TEnum).IsEnum)
{
throw new Exception($"Invalid generic method argument of type {typeof(TEnum)}");
}
}
}

现在可以继承 EnumTable 了

public enum QuestionTypeEnum
{
Closed = 0,
Open = 1
}


public class QuestionType : EnumTable<QuestionTypeEnum>
{
public QuestionType(QuestionTypeEnum enumType) : base(enumType)
{
}


public QuestionType() : base() { } // should excplicitly define for EF!
}

播种价值观

context.QuestionTypes.SeedEnumValues<QuestionType, QuestionTypeEnum>(e => new QuestionType(e));

小开

你应该在 enum声明前面加上 : byte:

enum MyFieldEnum : byte{
one = 1,
two = 2,
three = 4
}

在数据库中，您应该看到 TINYINT，不需要铸造！

小开

更新: 我在 EntityFrameworkCore5.0.8中找到了一种更好的工作方式

将 JsonConverter 属性添加到枚举中

[Newtonsoft.Json.JsonConverter(typeof(StringEnumConverter))]
public enum FacultyEnum
{
[EnumMember(Value = "English Professor")]
Eng,
[EnumMember(Value = "Math Professor")]
Math,
[EnumMember(Value = "Economics Professor")]
Eco
}

创建一个表示表的类

public class Faculty
{
public int Id { get; set; }


public string Name { get; set; }


public FacultyEnum Description { get; set; }
}

在 DbContext 中的 OnModelCreate 中使用 FluentAPI 来使用枚举字符串并设置检查约束

        var enumToString = new EnumToStringConverter<FacultyEnum>();
modelBuilder.Entity<Faculty>(entity =>
{
entity.ToTable(nameof(FacultyMembers));
//convert enums to string
entity.Property(e => e.Description).HasConversion(enumToString);
//build check constraint from enum
var allowedEnumStrings = string.Join(',',
typeof(Faculty).GetMembers()
.Select(x => x.GetCustomAttribute(typeof(EnumMemberAttribute), false)).Where(x => x != null)
.Select(x => $"'{((EnumMemberAttribute)x).Value}'"));
entity.HasCheckConstraint($"CK_{nameof(FacultyMembers)}_{nameof(Faculty.Description)}", $"{nameof(Faculty.Description)} in ({allowedEnumStrings})");
});

老方法

阿尔贝托 · 蒙泰罗回答得很好。我不得不做一些调整，使它与 EF 核心工作。

重命名枚举并添加描述修饰符

public enum FacultyEnum
{
[Description("English Professor")]
Eng,
[Description("Math Professor")]
Math,
[Description("Economics Professor")]
Eco
}

创建一个表示表的类

public class Faculty
{
private Faculty(FacultyEnum @enum)
{
Id = (int)@enum;
Name = @enum.ToString();
Description = @enum.GetEnumDescription();
}


protected Faculty() { } //For EF


[Key, DatabaseGenerated(DatabaseGeneratedOption.None)]
public int Id { get; set; }


[Required, MaxLength(100)]
public string Name { get; set; }


[MaxLength(100)]
public string Description { get; set; }


public static implicit operator Faculty(FacultyEnum @enum) => new Faculty(@enum);


public static implicit operator FacultyEnum(Faculty faculty) => (FacultyEnum)faculty.Id;
}

你的模型引用了这个类

public class ExampleClass
{
public virtual Faculty Faculty { get; set; }
}

创建一个扩展方法以从枚举值和种子值获取描述

using System;
using System.ComponentModel;
using System.Data.Entity;
using System.Data.Entity.Migrations;
using System.Linq;


public static class Extensions
{
public static string GetEnumDescription<TEnum>(this TEnum item)
=> item.GetType()
.GetField(item.ToString())
.GetCustomAttributes(typeof(DescriptionAttribute), false)
.Cast<DescriptionAttribute>()
.FirstOrDefault()?.Description ?? string.Empty;
}

把种子放进 yourdbcontext.cs 里

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Faculty>().HasData(FacultyEnum.Eng, FacultyEnum.Math, FacultyEnum.Eco);
}

在 DbContext 中添加枚举表

public class MyClass : DbContext
{
public DbSet<ExampleClass> Examples { get; set; }
public DbSet<Faculty> Facultys { get; set; }
}

好好利用

var example = new ExampleClass();
example.Faculty = FacultyEnum.Eng;


if (example.Faculty == FacultyEnum.Math)
{
//code
}

去记住

如果不在 Faculty 属性中添加虚拟，则必须使用来自 DbSet 的 Include 方法来执行 Eager Load

var exampleFromDb = dbContext.Examples.Include(x => x.Faculty).SingleOrDefault(e => e.Id == 1);
if (example.Faculty == FacultyEnum.Math)
{
//code
}

如果教员属性是虚拟的，那么就使用它

var exampleFromDb = dbContext.Examples.Find(1);
if (example.Faculty == FacultyEnum.Math)
{
//code
}

小开

太好了@Alberto Monterio！为了让它与 ASP.NET CORE/EF CORE 一起工作，我对 Alberto 的解决方案做了一些调整。

为简洁起见，只有下面列出了修改内容:

创建一个扩展方法以从枚举值和种子值获取描述

using System;
using System.ComponentModel;
using System.Data.Entity;
using System.Data.Entity.Migrations;
using System.Linq;
using Microsoft.EntityFrameworkCore; //added
using Microsoft.EntityFrameworkCore.Metadata.Builders; //added


public static class Extensions
{
//unchanged from alberto answer
public static string GetEnumDescription<TEnum>(this TEnum item)
=> item.GetType()
.GetField(item.ToString())
.GetCustomAttributes(typeof(DescriptionAttribute), false)
.Cast<DescriptionAttribute>()
.FirstOrDefault()?.Description ?? string.Empty;


//changed
public static void SeedEnumValues<T, TEnum>(this ModelBuilder mb, Func<TEnum, T> converter)
where T : class => Enum.GetValues(typeof(TEnum))
.Cast<object>()
.Select(value => converter((TEnum)value))
.ToList()
.ForEach(instance => mb.Entity<T>().HasData(instance));
}

把种子放进 configuration.cs 里

向 DataContext 的 `OnModelCreating`添加种子

protected override void OnModelCreating(ModelBuilder builder)
{
builder.SeedEnumValues<Faculty, EnumEntityRole>(e => e);
}

小开

另一种在 EF Core 中有效的方法(我觉得更简单)是:

你的 Enum

public enum Color
{
Red = 1,
Blue = 2,
Green = 3,
}

数据库表

public class CustomObjectDto
{
public int ID { get; set; }


// ... other props


public Color ColorID { get; set; }
public ColorDto ColorDto { get; set; }
}


public class ColorDto
{
public Color ID { get; set; }
public string Name { get; set; }
}

您的 DbContext

public class Db : DbContext
{
public Db(DbContextOptions<Db> options) : base(options) { }


public DbSet<CustomObjectDto> CustomObjects { get; set; }
public DbSet<ColorDto> Colors { get; set; }


protected override void OnModelCreating(ModelBuilder modelBuilder)
{
// Seed database with all Colors
foreach (Color color in Enum.GetValues(typeof(Color)).Cast<Color>())
{
ColorDto colorDto = new ColorDto
{
ID = color,
Name = color.ToString(),
};


modelBuilder.Entity<ColorDto>().HasData(colorDto);
}
}
}

在代码中，我基本上只使用枚举 Color (从不使用 ColorDto)。但是在 sql 查询和视图的“ CustomObjects”表中有一个带 FK 的“ Colors”表仍然很不错。

小开

我可能有点晚了，但我没有找到我在这里寻找的答案。

我在 EntityFramework 文档中找到了这个解决方案，它是值转换中的第一个示例

如果您愿意的话，可以使用这个扩展方法。

public static void HasEnum<TEntity, TProperty>(this EntityTypeBuilder<TEntity> entityBuilder, Expression<Func<TEntity, TProperty>> propertyExpression)
where TEntity : class
where TProperty : Enum
{
entityBuilder.Property(propertyExpression)
.HasConversion(
v => v.ToString(),
v => (TProperty)Enum.Parse(typeof(TProperty), v)
);
}

然后在你的 OnModelCreating 中使用它:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<YourEntity>()
.HasEnum(e => e.YourProperty);
}

如何在 EF6代码中创建与枚举相对应的表首先？

重命名您的 enum

创建一个表示表的类

你的模型引用了这个类

创建一个扩展方法以从枚举值和种子值获取描述

把种子放进 configuration.cs 里

在 DbContext 中添加枚举表

好好利用

去记住

更新: 我在 EntityFrameworkCore5.0.8中找到了一种更好的工作方式

将 JsonConverter 属性添加到枚举中

创建一个表示表的类

在 DbContext 中的 OnModelCreate 中使用 FluentAPI 来使用枚举字符串并设置检查约束

老方法

重命名枚举并添加描述修饰符

创建一个表示表的类

你的模型引用了这个类

创建一个扩展方法以从枚举值和种子值获取描述

把种子放进 yourdbcontext.cs 里

在 DbContext 中添加枚举表

好好利用

去记住

创建一个扩展方法以从枚举值和种子值获取描述

把种子放进 configuration.cs 里

向 DataContext 的 OnModelCreating添加种子

你的 Enum

数据库表

您的 DbContext

向 DataContext 的 `OnModelCreating`添加种子