EF6 Code Firstのenumに対応するテーブルを作成するにはどうすればよいですか？

Question

EF6のCode Firstで列挙を処理する方法について MSDN に従いました。 が想定されていたように機能しましたが、列挙子を参照する作成済みテーブルのフィールドは単純なintです。

2番目のテーブルを作成し、その値はC＃コードの列挙子の定義に従うことをお勧めします。そのため、MSDNの例でDepartmentに対応するテーブルだけを取得する代わりに、Facultyからの項目が入力された2番目のテーブルを見たいと思います。

public enum Faculty { Eng, Math, Eco }     

public partial class Department 
{ 
  [Key] public Guid ID { get; set; } 
  [Required] public Faculty Name { get; set; } 
}

問題を調査して、私は solution を見つけました。これは、列挙用のテーブルを作成し、シードによって明示的にデータを取り込むことを示唆しています。

面倒なアプローチであり、自動で処理する必要がある多くの作業のように見えます。結局、システムは列挙を構成する実際の値を知っています。 DBの観点から見ると、それはまだデータ行です。作成するエンティティと同様に、OOアスペクトからは、実際にはデータではなく、有限で事前に既知の数を想定できるタイプ（緩やかに表現）です状態の。

テーブルに「手動で」データを入力するアプローチは推奨されますか？

Answer 1

EFはyesを自動的に処理しないため、これが推奨される方法です。

あなたが提供した記事のいくつかの修正をお勧めします。

列挙型の名前を変更します

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
}

覚えて

ファカルティプロパティに仮想を追加しない場合は、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
}

Answer 2

@Alberto Monteiroの回答に基づいて、複数のテーブルがある場合に備えて汎用クラスを作成しました。ここでの注意点は、IdがTEnumのタイプであることです。このような方法で使用すると、Enumを使用してプロパティタイプを宣言するオプションが提供されます。

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

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

デフォルトでは整数を使用する列挙型なので、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));

Answer 3

別の可能性として、モデルをよりシンプルなPOCOスタイルに保ちたい場合は、エンティティフレームワークによって整数として格納されるプロパティとして列挙型を使用します。

次に、DBで「enumテーブル」を作成および更新する場合は、nugetパッケージを使用することをお勧めします https://github.com/timabell/ef-enum-to-lookup およびたとえば、EF Migration Seedメソッドで使用します。

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という名前の2つの行を持つ「Shape」テーブルが作成され、テーブル「Foo」に関連する外部キー制約が設定されます。

Answer 4

素晴らしい@AlbertoMonterio！これを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);
}

Answer 5

enum宣言の前に: byteを追加する必要があります。

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

データベースでは、TINYINTが表示され、キャストする必要はありません！

Answer 6

EF Coreで機能する（そして私にとってはよりシンプルに感じる）別のアプローチ：

あなたの列挙

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

Dbテーブル

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'テーブルがあることは、まだ素晴らしいことです。

Answer 7

アルベルトモンテイロは非常によく答えました。 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
}

覚えて

ファカルティプロパティに仮想を追加しない場合は、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
}