C# 資料操作系列 - 6 EF Core 配置對映關係

月影西下發表於2020-05-15
C#

0. 前言

在《C# 資料操作系列 - 5. EF Core 入門》篇中，我們簡單的通過兩個類演示了一下EF增刪改查等功能。細心的小夥伴可能看了生成的DDL SQL 語句，在裡面發現了些端倪。沒看的小夥伴也不急，這就貼出來。

public class ModelA
{
	public int Id { get; set; }
	public string Name { get; set; }
	public List<ModelB> ModelBs { get; } = new List<ModelB>();
}
public class ModelB
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int ModelAId { get; set; }
    public ModelA modelA { get; set; }
}

DDL SQL：

CREATE TABLE "ModelBs" (
    "Id" INTEGER NOT NULL CONSTRAINT "PK_ModelBs" PRIMARY KEY AUTOINCREMENT,
    "Name" TEXT NULL,
    "ModelAId" INTEGER NOT NULL,
    CONSTRAINT "FK_ModelBs_ModelAs_ModelAId" FOREIGN KEY ("ModelAId") REFERENCES "ModelAs" ("Id") ON DELETE CASCADE
);
-- auto-generated definition
create table ModelAs
(
    Id   INTEGER not null
        constraint PK_ModelAs
            primary key autoincrement,
    Name TEXT
);

1. 對映規則

通過簡單的示例，我們可以看到EF的對映規則是什麼。基於約定由於配置的原則，EF把實體類當做是一個單數形式的型別描述，把表認為是實體類的集合，所以表名為類名的複數形式。

對於主鍵，預設情況下EF會檢索實體類有沒有名為Id或者類名+Id的屬性，如果有EF則認為這個屬性是主鍵，否則會認為該類沒有設定主鍵。EF檢索到主鍵的型別是數字型別的話，會自動新增自增長的約束。

對於其他屬性，EF會自動按照同名的形式對映到資料表中。

對於外來鍵，如果在類裡新增了引用型別，而這個引用型別也在EF的上下文中，EF會把這種屬性稱為導航屬性。EF一旦在類裡檢索到了導航屬性，就會去尋找對應的外來鍵。EF會認為 屬性名+Id或者類名+Id 可能是外來鍵屬性，如果找到名稱一致且型別與導航屬性目標類的主鍵型別一致，則認為是外來鍵。如果型別不一致，EF則認為該類設定有誤。如果沒找到符合名稱要求的屬性，EF會自己新增一個外來鍵屬性。

對於一對一，EF要求導航屬性雙方都應該具有外來鍵配置。

一對多，EF要求多的一方設定外來鍵。同時如果在一方這邊設定了集合型別的導航屬性，那麼EF會自動到目標類裡尋找外來鍵屬性。

說完了一對一和一對多，那麼多對多呢？

如果沒有宣告的話， EF會生成一箇中間表。

2. 修改對映關係

EF允許開發人員指定自己的對映規則或者單個類的對映規則。EF 提供了幾種方式來修改對映關係。

2.1 資料註解

EF允許開發人員通過使用Attribute標記，來約定對映關係。

先引入名稱空間：

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

常見的註解如下：

[Table("ModelA")]

TableAttribute 表示實體對映的哪張表

[Key]

KeyAttribute 用來標記哪個屬性是主鍵

[DatabaseGenerated(DatabaseGeneratedOption.Identity)]

用來表示這個欄位在第一次插入資料庫時，值由資料庫提供

[ForeignKey("ModelAId")]

表示該導航屬性具體值由 名稱為 ModelAId 的屬性維護，如果沒有該屬性，EF則記錄新增但不對外顯示。

[InverseProperty("Author")]

用在集合型別的屬性上，表示該集合屬性是與源類哪一個導航屬性相關。

[Column]

表示列，用來設定一些列的基本引數，比如型別、名稱

[Required]

表示該列在插入資料庫時不能為空

使用註解進行相關配置相當簡單，但是這樣不可避免的需要修改模型類而且需要引入額外的名稱空間，不太符合某些要求嚴格的專案，所以微軟又提供了另外一套寫法。

2.2 Fluent 方式

當我們使用這種方式的時候，會面臨一個問題：是新建一個配置類呢，還是在 EF上下文的OnModelCreating方法裡統一配置呢？

我們先看一下EF上下文的OnModelCreating的宣告是什麼：

protected internal virtual void OnModelCreating(ModelBuilder modelBuilder);

這裡有一個ModelBuilder型別，檢視它的API發現兩個方法：

public virtual Microsoft.EntityFrameworkCore.ModelBuilder ApplyConfiguration<TEntity> (Microsoft.EntityFrameworkCore.IEntityTypeConfiguration<TEntity> configuration) where TEntity : class;

public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder<TEntity> Entity<TEntity> () where TEntity : class;

繼續尋找 IEntityTypeConfiguration，看到這個介面只有一個方法：

void Configure(EntityTypeBuilder<TEntity> builder);

兩個都指向了 EntityTypeBuilder<TEntity> builder，而這個正是Fluent API配置類的關鍵。所以通過分析API，我們可以得到這兩種寫法。

那麼，這兩種的取捨呢？

在專案比較小，資料類很少的時候，可以直接在OnModelCreating裡寫。否則，更建議繼承一個Configuration介面。

那麼，我們就來看看 通過builder怎麼配置對映關係吧：

public class ModelEntityConfig : IEntityTypeConfiguration<ModelA>// 基於 ModelA新建一個配置類
{
    public void Configure(EntityTypeBuilder<ModelA> builder)
    {
    }
}

builder.ToTable("TableName");

設定表名

builder.HasKey(t => t.Id);
//builder.HasKey(t => t.Id).HasName("KeyName");

設定主鍵，如果不寫後面的HasName，則主鍵名稱預設是屬性名；寫了之後EF將使用宣告的名稱作為主鍵在資料庫的名稱。

var property = builder.Property(t => t.Name);

獲取一個與屬性Name相關聯的PropertyBuilder例項，通過這個例項可以配置屬性與資料庫列的關係。

builder.Ignore(t => t.ModelBs);

表示這個屬性不由資料庫維護。

回過頭來，我們看看 PropertyBuilder裡有哪些方法：

// 設定一個最大長度
public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder HasMaxLength (int maxLength);
// 設定一個資料生成規則
public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder HasValueGenerator (Func<Microsoft.EntityFrameworkCore.Metadata.IProperty,Microsoft.EntityFrameworkCore.Metadata.IEntityType,Microsoft.EntityFrameworkCore.ValueGeneration.ValueGenerator> factory);
public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder HasValueGenerator (Type valueGeneratorType);
public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder HasValueGenerator<TGenerator> () where TGenerator : Microsoft.EntityFrameworkCore.ValueGeneration.ValueGenerator;

// 設定在新增時，自動生成一個值
public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder ValueGeneratedOnAdd ();
//設定列名
public static Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder HasColumnName (this Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder propertyBuilder, string name);
// 設定列的資料庫引數型別
public static Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder HasColumnType (this Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder propertyBuilder, string typeName);

3. 總結

在這一篇領著大家看了一下EF Core對於對映關係這一部分的內容，我留下了外來鍵相關的FluentAPI介紹，我打算在下一篇介紹。因為這部分的內容比較麻煩，而且使用率也相當高。

更多內容煩請關注我的部落格《高先生小屋》

file

相關文章