EntityFramework Core 自動綁定模型映射

筆者最近在和同事共同開發項目時，需要從他們提供的包含資料庫實體類型的類庫中讀取實體信息綁定到自己的項目中（但是都在同一個解決方案里），所以很直接的一種方式就是把項目中所有的實體都以的形式加入到自己的 Context 中，但是這顯然十分麻煩，而且如果又新增或減少了實體，每次又得在Context中做修 ...

筆者最近在和同事共同開發項目時，需要從他們提供的包含資料庫實體類型的類庫中讀取實體信息綁定到自己的項目中（但是都在同一個解決方案里），所以很直接的一種方式就是把項目中所有的實體都以 public DbSet<Blog> Blogs { get; set; } 的形式加入到自己的 Context 中，但是這顯然十分麻煩，而且如果又新增或減少了實體，每次又得在Context中做修改。

先放上示例的兩個實體，假設它們都處於Synyi.EntityDemo這個項目類庫中。其實IEntity是一個空介面，起指示作用。

namespace Synyi.EntityDemo
{
    public class Blog : IEntity
    {
        public int BlogId { get; set; }
        public string Url { get; set; }
    
        public List<Post> Posts { get; set; }
    }
    
    public class Post : IEntity
    {
        public int PostId { get; set; }
        public string Title { get; set; }
        public string Content { get; set; }
    
        public int BlogId { get; set; }
        public Blog Blog { get; set; }
    }
}

所以有沒有什麼辦法可以直接讓 EntityFramework Core 來代勞這項工作呢？從這個想法出發，其實我們很自然地就可以想到 Context 中的 OnModelCreating 方法，在傳統的 EF 6中，它也是作為實體模型屬性映射的方法容器存在。如果大家看過筆者之前的那篇《EntityFramework Core 學習掃盲》，就會知道 Fluent Api 的使用都是在這個方法中的。它的方法簽名如下：

protected internal virtual void OnModelCreating(ModelBuilder modelBuilder)
{
}

配置的方法容器找到了，讀取實體信息也是水到渠成的一件事，我們可以直接利用對程式集的反射讀取所有的內部實體信息。代碼如下：

var entityTypes = Assembly.Load(new AssemblyName("存放實體類型的程式集名稱")).GetTypes()
    .Where(type => !string.IsNullOrWhiteSpace(type.Namespace))
    .Where(type => type.GetTypeInfo().IsClass)
    .Where(type => type.GetTypeInfo().BaseType != null)
    .Where(type => typeof(IEntity).IsAssignableFrom(type)).ToList();

其中 typeof(IEntity).IsAssignableFrom(type) 只是為了能獲取到確定的繼承了 IEntity 介面的實體而已。在這一步以後，通過查看 modelBuilder 上的相應方法，我們找到了 FindEntityType 和 AddEntityType 方法。所以最後的代碼如下：


protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    optionsBuilder.UseSqlServer(
        "Server=(localdb)\\MSSQLLocalDB;Database=ExampleDb;Trusted_Connection=True;MultipleActiveResultSets=true");
}

protected override void OnModelCreating(ModelBuilder builder)
{
    var entityTypes = Assembly.Load(new AssemblyName("存放實體類型的程式集名稱")).GetTypes()
        .Where(type => !string.IsNullOrWhiteSpace(type.Namespace))
        .Where(type => type.GetTypeInfo().IsClass)
        .Where(type => type.GetTypeInfo().BaseType != null)
        .Where(type => typeof(IEntity).IsAssignableFrom(type)).ToList();

    foreach (var entityType in entityTypes)
    {
        //  防止重覆附加模型，否則會在生成指令中報錯
        if (builder.Model.FindEntityType(entityType) != null)
            continue;

        builder.Model.AddEntityType(entityType);
    }

    base.OnModelCreating(builder);
}

使用 Add-Migration XX 和 Update-Database 指令後，我們的 ExampleDb 中就生成了相應的資料庫表，一些隱藏的諸如“實體中命名為 Id 或者 ClassName+Id 的屬性將自動設置為主鍵”的規則也會自動生效。假如目標資料庫是類似於 PostgreSql 這種，資料庫的表名和列名都得定義成小寫字母，否則在 sql 時將不得不使用雙引定義，十分的麻煩。所幸我們也可以直接在 OnModelCreating 方法中指定這一項規則。在上述方法末尾加上如下代碼：

foreach (var entity in builder.Model.GetEntityTypes())
{
    var currentTableName = builder.Entity(entity.Name).Metadata.Relational().TableName;
    builder.Entity(entity.Name).ToTable(currentTableName.ToLower());

    var properties = entity.GetProperties();
    foreach (var property in properties)
        builder.Entity(entity.Name).Property(property.Name).HasColumnName(property.Name.ToLower());
}

至於其他的配置，就要靠大家去挖掘了。

消失的 EntityTypeConfiguration

在傳統的 EF 編程中，大家對 EntityTypeConfiguration 應該都十分的熟悉。比如如下的代碼：

public class BlogConfiguration : EntityTypeConfiguration<Blog>
{
    public BlogConfiguration()
    {
        ToTable("Blogs");
        HasKey(x => x.Id);
        Property(x => x.Id).HasDatabaseGeneratedOption(DatabaseGeneratedOption.Identity).HasColumnName("BlogId");
        Property(x => x.Title).HasMaxLength(175);
        HasRequired(x => x.Url).WithRequiredPrincipal();
    }
}

// 在 OnModelCreating 方法中加入以下代碼
modelBuilder.Configurations.Add(new BlogConfiguration());

就是這樣一個好用的東西，卻沒有隨著 EF 的遷移而保留下來，在 EF Core 中，我們已經看不到它的身影了，殘念ですね。不過這也不是多難解決的事情，Github上已經有人給出了相關的解決方案。

做些簡單的分析——一句比較完整的Fluent Api 設置方式形如 builder.Entity<Blog>().ToTable("Blogs"); 所以我們只要抓住 builder.Entity<XXX>()的返回類型 EntityTypeBuilder 做文章即可。筆者在下麵也給出另一種介面+反射方式的實現（第二個參考鏈接中的代碼並不能直接使用）。

public interface IEntityTypeConfiguration
{
}

public class BlogConfiguration : IEntityTypeConfiguration
{
    public BlogConfiguration(ModelBuilder builder)
    {
        builder.Entity<Blog>().ToTable("Blogs");
    }
}

public static class ModelBuilderExtensions
{
    public static void ExecuteConfigurations(this ModelBuilder modelBuilder,string assemblyName)
    {
        var configurationTypes = Assembly.Load(new AssemblyName(assemblyName)).GetTypes()
            .Where(type => !string.IsNullOrWhiteSpace(type.Namespace))
            .Where(type => type.GetTypeInfo().IsClass)
            .Where(type => type.GetTypeInfo().BaseType != null)
            .Where(type => typeof(IEntityTypeConfiguration).IsAssignableFrom(type))
            .ToList();

        foreach (var type in configurationTypes)
            Activator.CreateInstance(type, modelBuilder);
    }
}

// 在 OnModelCreating 方法中加入以下代碼
builder.ExecuteConfigurations("存放實體配置的程式集名稱");
base.OnModelCreating(builder);

至此，Entity Framework Core 中的自動綁定實體映射應該就告一段落了，其他的功能也很容易基於上文擴展。如果大家有更好的想法，也可以在評論中留言（這語氣聽起來就好像自己的文章真的會有很多讀者一樣）。

EntityFramework Core 自動綁定模型映射

消失的 EntityTypeConfiguration

參考資料