Entity Framework Code First關係映射約定【l轉寄】

標籤：

本篇隨筆目錄：

　　1、外鍵列名預設約定

　　2、一對多關聯性

　　3、一對一關聯性

　　4、多對多關係

　　5、一對多自反關係

　　6、多對多自反關係

 

　　在關聯式資料庫中，不同表之間往往不是全部都單獨存在，而是相互存在關聯的。兩個不同表之間可以存在外鍵依賴關係，一個表自身也可以有自反關係(表中的一個欄位引用主鍵，從而也是外鍵欄位)。

　　Entity Framework Code First預設多重關係的一些約定規則：

　　一對多關聯性：兩個類中分別包含一個引用和一個集合屬性，也可以是一個類包含另一個類的引用屬性，或一個類包含另一個類的集合屬性。如在本篇接下來用到的例子Category類和Product類，要使得Category與Product之間具有一對多關聯性，Entity Framework Code First可以有3種體現方式：

　　1>、在Category類中定義ICollection<Product> Products集合屬性，同時在Product類中定義Category Category引用屬性。

　　2>、僅在Category類中定義ICollection<Product> Products集合屬性。

　　3>、僅在Product類中定義Category Category引用屬性。

　　多對多關係：兩個類分別包含對方的一個集合屬性。如在本篇接下來用到的例子User類和Role類，要使得User與Role之間具有多對多關係，即一個使用者可以屬於多個角色，一個角色可以有多個使用者，則需要在User類中需要定義一個ICollection<Role> Roles集合屬性，同時在Role類中需要定義一個ICollection<User> Users屬性。

　　一對一關聯性：兩個類分別包含對方的一個引用屬性。如在本篇接下來用到的例子User類和UserProfile類，要使得User與UserProfile之間具有一對一關聯性，則需要在User類中定義一個UserProfile UserProfile的引用屬性，同時在UserProfile類中定義一個User User的引用屬性。

　　下面具體描述Entity Framework Code First產生外鍵的預設約定，並通過執行個體展示Entity Framework Code First處理一個表及多個表之間的關係。

　　1、外鍵列名預設約定

　　Entity Framework Code First在根據預設約定建立外鍵時，外鍵列的名稱存在3種方式。在《Programming Entity Framework Code First》一書中，給出的3種外鍵列名的約定方式是：[Target Type Key Name], [Target Type Name] + [Target Type Key Name], or [Navigation Property Name] + [Target Type Key Name]，對應的中文翻譯為：[目標類型的鍵名]，[目標類型名稱]+[目標類型鍵名稱]，或[引用屬性名稱]+[目標類型鍵名稱]。

　　Entity Framework Code First外鍵預設約束產生的外鍵在分別滿足3種不同的條件下，外鍵列名有3種不同的命名規則。且經過測試這3種不同的外鍵名稱命名之間存在優先順序：[目標類型的鍵名] > [引用屬性名稱]+[目標類型鍵名稱] > [目標類型名稱]+[目標類型鍵名稱]。接下來以Product類及Category類為例，分別測試外鍵列名稱的3中不同產生方式，Category與Product為一對多關聯性。

　　1>、[目標類型的鍵名]

　　這種方式為要求在Product表中外鍵列名與Category表中的主鍵列名相同，所以也就要求在Product類中有定義與Category類中作為主鍵的屬性。如在Category類中主鍵屬性為CategoryID，則需要在Product類中也定義一個CategoryID的屬性。

　　檔案Category.cs：

 View Code

　　檔案Product.cs:

 View Code

　　說明：在Category類及Product類中的引用屬性及集合屬性前加virtual修飾，為的是Entity Framework Code First的消極式載入功能。不使用virtual修飾，在Category類的一個執行個體要查詢包含的Product執行個體時，將不會啟用消極式載入。當然Entity Framework Code First消極式載入並不是必須的，所以virtual修飾符也可以不加。

　　在定義以上兩個類之後，不再添加任何的Entity Framework Code First與資料庫的映射配置，運行之後，產生的資料表結構為：

　　從產生的Categories與Products表結構可以看出，在Products表中的外鍵CategoryID與引用的表Categories主鍵名稱相同。跟蹤Entity Framework Code First產生資料表的執行指令碼可以看到具體產生外鍵的SQL語句。

ALTER TABLE [dbo].[Products] ADD CONSTRAINT [FK_dbo.Products_dbo.Categories_CategoryID] FOREIGN KEY ([CategoryID]) REFERENCES [dbo].[Categories] ([CategoryID]) ON DELETE CASCADE

　　同時，從產生外鍵的指令碼還能看出一點，Entity Framework Code First產生外鍵是啟用串聯刪除功能的。即當刪除Categories表中一條記錄時，資料庫會自動聯帶刪除Products表中屬於該類別的記錄。

　　在資料庫中產生的Products表，查看外鍵FK_dbo.Products_dbo.Categories_CategoryID屬性，其的確有啟用串聯刪除功能。

　　2>、[目標類型名稱]+[目標類型鍵名稱]

　　這種方式要求在Product表中外鍵列名為Category類名+Category類中鍵名稱，即在Products表中產生的外鍵名稱為Category_CategoryID。樣本：在Category類中添加ICollection<Product> Products的集合屬性，而在Product類中不做任何與Category關聯的代碼，也不定義CategoryID屬性。

　　檔案Category.cs：

 View Code

　　檔案Product.cs：

 View Code

　　在定義以上兩個類之後，不再添加任何的Entity Framework Code First與資料庫的映射配置，運行之後，產生的資料表結構為：

 　　3>、[引用屬性名稱]+[目標類型鍵名稱]

　　這種方式為要求在Product表中外鍵列名為在Product類中引用Category的屬性名稱 + Category類的主鍵名稱。如：在Product類中定義一個Category屬性Cat，則產生的外鍵名稱為Cat_CategoryID。

　　檔案Category.cs：

 View Code

　　檔案Product.cs：

 View Code

　　在定義以上兩個類之後，不再添加任何的Entity Framework Code First與資料庫的映射配置，運行之後，產生的資料表結構為：

　　關於3種不同的外鍵名稱命名之間存在優先順序：[目標類型的鍵名] > [引用屬性名稱]+[目標類型鍵名稱] > [目標類型名稱]+[目標類型鍵名稱]的測試方法：

　　[目標類型的鍵名]的最高優先順序：只要在Product類中定義了CategoryID的屬性，在Products表中產生的外鍵列名都只會為CategoryID。

　　[引用屬性名稱]+[目標類型鍵名稱] > [目標類型名稱]+[目標類型鍵名稱]：只要在Product類中定義Cat屬性，不管Category類中是否定義Products屬性，產生的Products表中外鍵都只會是Cat_CategoryID。

　　2、一對多關聯性

　　Entity Framework Code First在根據定義的類產生資料表時，資料表之間的外鍵關係及所產生的外鍵列名有預設的約定。但這種約定同樣可以進行修改，如將不滿足預設外鍵約定的屬性來作為產生表的外鍵。樣本：Category類與Product類，在Product類中定義一個屬性CatID，要將CatID屬性作為Product的引用Category的外鍵，而按照Entity Framework Code First的預設約定是不會的。要做到需要的CatID作為外鍵，同樣可以使用Data Annotations和Fluent API兩種方式實現。

　　1>、Data Annotations方式

　　檔案類Category.cs:

 View Code

　　檔案類Product.cs：

 View Code

　　在定義以上兩個類之後，不再添加任何的Entity Framework Code First與資料庫的映射配置，運行之後，產生的資料表結構為：

　　查看Products表的外鍵咧CatID參考關聯性：

　　其中，在Product類中，為設定CatID屬性為外鍵的代碼為：

public int CatID { get; set; }[ForeignKey("CatID")]public virtual Category Category { get; set; }

　　該段實現方式還可以改為：

[ForeignKey("Category")]public int CatID { get; set; }public virtual Category Category { get; set; }

　　2>、Fluent API方式

　　檔案類Category.cs：

 View Code

　　檔案類Product.cs：

 View Code

　　檔案類PortalContext.cs：

 View Code

　　說明：在PortalContext.cs的OnModelCreating方法中，對兩個實體類Category及Product均添加了Fluent API形式的關係配置。對於Entity Framework Code First而言，兩個實體類之間的關係，可以兩個類中均添加關係映射配置，也可以只對其中任意一個實體類添加關係映射配置。即在PortalContext.cs的OnModelCreating方法中可以只包含Category或只包含Product類的關係映射配置。這裡從Entity Framework Code First的使用經驗及技巧，建議將實體類之間關係映射配置在包含外鍵的類中。即OnModelCreating中只添加對Product實體類的關係映射配置，這樣做有一個好處，當Category有多個表引用它時，可以將外鍵均配置在引用它的實體類中，從而降低Category類的複雜度，同時也有益於代碼的維護。

　　即在PortalContext.cs的OnModelCreating方法只需下面的定義即可：

protected override void OnModelCreating(DbModelBuilder modelBuilder){    modelBuilder.Entity<Product>()        .HasRequired(t => t.Category)        .WithMany(t => t.Products)        .HasForeignKey(d => d.CatID);}

　　Entity Framework Code First根據一對多關聯性關係產生的外鍵參考條件約束預設是有串聯刪除的，可以通過以下方式禁用Category與Product之間的串聯刪除。

protected override void OnModelCreating(DbModelBuilder modelBuilder){    modelBuilder.Entity<Product>()        .HasRequired(t => t.Category)        .WithMany(t => t.Products)        .HasForeignKey(d => d.CatID)        .WillCascadeOnDelete(false);}

　　也可以在Entity Framework Code First產生的全部表中都統一設定禁用一對多串聯刪除。

protected override void OnModelCreating(DbModelBuilder modelBuilder){    modelBuilder.Conventions.Remove<OneToManyCascadeDeleteConvention>();}

　　雖然Entity Framework Code First是可以支援外鍵列名自訂的，但在實際的項目中，更多的外鍵列名稱還是與所參考資料表的主鍵列名相同。即在Category表中主鍵為CategoryID，在Product表中外鍵列名稱還是為CategoryID。

　　Entity Framework Code First的Fluent API配置實體類與表的映射關係，還可以將所有的實體類與表的映射全部寫在一個類中，這樣可以方便代碼的維護。

　　檔案類Category.cs：

 View Code

　　檔案類CategoryMap.cs，用於描述Category類與產生的表之間的映射關係：

 View Code

　　檔案類Product.cs：

 View Code

　　檔案類ProductMap.cs，用於描述Product類與產生的表之間的映射關係：

 View Code

　　PortalContext.cs的OnModelCreating方法：

 View Code

　　3、一對一關聯性

 　　在一對一關聯性中，兩個表均有各自的主鍵，但要看哪個表的主鍵同時作為外鍵引用另一個表的主鍵。樣本以User類與UserProfile類作為兩個具有一對一關聯性的類，其中User類包含作為主鍵的UserID屬性，UserProfile類包含作為主鍵的ProfileID的屬性。

　　1>、Data Annotations方式

　　檔案類User.cs：

 View Code

　　檔案類UserProfile.cs：

 View Code

　　在定義以上兩個類之後，不再添加任何的Entity Framework Code First與資料庫的映射配置，運行之後，產生的資料表結構為：

　　在產生的資料表中，UserProfile表中的主鍵ProfileID同時也作為外鍵引用User表中的主鍵UserID。

　　修改檔案類User.cs：

 View Code

　　修改檔案類UserProfile.cs：

 View Code

　　則實體類執行之後產生的資料表User主鍵UserID將同時作為外鍵引用UserProfile表的主鍵ProfileID。

　　2>、Fluent API方式

　　Fluent API設定實體類產生的表引用與被引用通過WithRequiredPrincipal、WithRequiredDependent及WithOptionalPrincipal、WithOptionalDependent來設定，使用Principal屬性的實體類將被另外的實體類產生的表引用，使用Dependent屬性的實體類將引用另外的實體類。

　　檔案類User.cs：

 View Code

　　對應檔類UserMap.cs：

 View Code

　　檔案類UserProfile.cs：

 View Code

　　對應檔類UserProfileMap.cs：

 View Code

　　在以上實體類及實體映射類執行以後，產生的資料表結構如下：

　　在產生的表結構中，UserProfile表中的主鍵UserID同時也作為外鍵引用User表的主鍵UserID。若修改UserProfileMap.cs如下，則產生的表結構User表的主鍵UserID將作為你外鍵引用UserProfile表的主鍵UserID。

 View Code

　　4、多對多關係

　　Entity Framework Code First在根據定義的多對多關係的類產生資料表時，除了產生實體類定義的屬性工作表之外，還會產生一個中間表。用於體現兩個實體表之間的多對多的關係。樣本實體類User與Role為多對多關係，一個使用者可以屬於多個角色，一個角色可以包含多個使用者。

　　檔案類User.cs：

 View Code

　　檔案類Role.cs：

 View Code

　　在定義以上兩個類之後，不再添加任何的Entity Framework Code First與資料庫的映射配置，運行之後，產生的資料表結構為：

　　從以上的表結構中，可以看出，實體類運行之後，除了產生Users表和Roles表之外，還產生了RoleUsers表作為中介表，體現Users表和Roles表之間的多對多關聯關係。中介表RoleUsers的欄位建置規則按照 [目標類型名稱]+[目標類型鍵名稱] 的約定。

　　Entity Framework Code First根據預設約定產生的多對多關聯關係的表時，預設啟用多對多的資料串聯刪除，可以添加代碼進行禁用。

protected override void OnModelCreating(DbModelBuilder modelBuilder){    // 禁用多對多關係表的串聯刪除    modelBuilder.Conventions.Remove<ManyToManyCascadeDeleteConvention>();}

　　FluentAPI實現方式：

　　檔案類User.cs：

 View Code

　　對應檔類UserMap.cs：

 View Code

　　檔案類Role.cs：

 View Code

　　對應檔類RoleMap.cs：

 View Code

　　運行之後產生的表結構：

　　5、一對多自反關係

　　一對多自反關係，即一個表存在一個外鍵列引用自身的主鍵。在項目中，最常見的一對多自反關係為分類表，分類表通過一個ParentID列儲存引用主鍵，已實現無限級遞迴。

　　Fluent API實現方式：

　　檔案類Category.cs：

using System;using System.Collections.Generic;namespace Portal.Entities{    public class Category    {        public int CategoryID { get; set; }        public int CategoryNo { get; set; }        public string CategoryName { get; set; }        public Nullable<int> ParentID { get; set; }        public virtual Category Parent { get; set; }        public virtual ICollection<Category> Children { get; set; }    }}

　　對應檔類CategoryMap.cs：

using System.ComponentModel.DataAnnotations.Schema;using System.Data.Entity.ModelConfiguration;using Portal.Entities;namespace Portal.Mapping{    public class CategoryMap : EntityTypeConfiguration<Category>    {        public CategoryMap()        {            // Primary Key            this.HasKey(t => t.CategoryID);            // Properties            this.Property(t => t.CategoryName)                .IsRequired()                .HasMaxLength(50);            // Table & Column Mappings            this.ToTable("Category");            this.Property(t => t.CategoryID).HasColumnName("CategoryID");            this.Property(t => t.CategoryNo).HasColumnName("CategoryNo");            this.Property(t => t.CategoryName).HasColumnName("CategoryName");            this.Property(t => t.ParentID).HasColumnName("ParentID");            // Relationships            this.HasOptional(t => t.Parent)                .WithMany(t => t.Children)                .HasForeignKey(d => d.ParentID);        }    }}

　　以上代碼在運行之後，產生的資料表：

　　6、多對多自反關係

　　多對多關係樣本：Family中一條記錄可能有多個Parents，也可能有多個Children。

　　檔案類Family.cs：

 View Code

　　對應檔類FamilyMap.cs：

 View Code

　　Family類及映射配置類，在運行之後產生的資料表結構：

　　在上面的表結構中，指定Family之間的中介表為FamilyRelationship，其中FamilyRelationship的兩個欄位ParentID及ChildID均引用Familyi表中的FamilyID作為外鍵。可能在實際的項目過程中，出現這種多對多自反參考關聯性的情況比較少見。

 

http://www.cnblogs.com/libingql/p/3353112.html

Entity Framework Code First關係映射約定【l轉寄】