Entity Framework Code First屬性對映約定

libingql發表於2013-10-05
Framework

　　Entity Framework Code First與資料表之間的對映方式有兩種實現：Data Annotation和Fluent API。本文中採用建立Product類為例來說明tity Framework Code First屬性對映約定的具體方式。

1. 表名及所有者

　　在預設約定的情況下，Entity Framework Code First建立的表名是根據類名的英語複數形式，建立的表所有者為dbo，可以通過重寫約定來指定表名及表的所有者。

1.1 Data Annotation方式

　　在使用Data Annotation方式進行Entity Framework Code First與資料庫對映之前，需要先新增名稱空間引用。

using System.ComponentModel.DataAnnotations.Schema;

　　為類配置對應表名：

[Table("Product")]
public class Product

　　為類配置對應表名並指定表的所有者：

[Table("Product", Schema = "dbo")]
public class Product

1.2 Fluent API方式

　　Fluent API實現配置Entity Framework Code First與資料庫對映關係主要是通過繼承DbContext並重寫其中的OnModelCreating方法來進行的。在本文中新建類檔案PortalContext.cs繼承DbContext。

　　在繼承DbContext之前，新增名稱空間引用。

using System.Data.Entity;

　　重寫OnModelCreating方法，配置類對應於資料庫中的表名：

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>().ToTable("Product");
}

　　重寫OnModelCreating方法，配置類對應於資料庫中的表名，並指定表的所有者：

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>().ToTable("Product", "dbo");
}

　　到此處PortalContext.cs的完整程式碼：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using System.Data.Entity;

using Portal.Entities;

namespace Portal
{
    public class PortalContext : DbContext
    {
        static PortalContext()
        {
            Database.SetInitializer(new DropCreateDatabaseIfModelChanges<PortalContext>());
        }

        public PortalContext()
            : base("name=PortalContext")
        {
        }

        public DbSet<Product> Products { get; set; }

        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            modelBuilder.Entity<Product>().ToTable("Product", "dbo");
        }
    }
}
View Code

2. 欄位名、長度、資料型別及是否可空

　　在預設約定的情況下，Entity Framework Code First建立的列名與類的屬性名相同，可以根據需要進行重新指定類屬性與列名之間的對映關係。

2.1 Data Annotation方式

[Column("ProductID")]
public int ProductID { get; set; }

[MaxLength(100)]
[Required, Column("ProductName")]
public string ProductName { get; set; }

　　在使用Required特性(Attribute)設定欄位不允許為空時，需要新增名稱空間引用：

using System.ComponentModel.DataAnnotations;

1.2 Fluent API方式

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>().Property(t => t.ProductID)
        .HasColumnName("ProductID");
    modelBuilder.Entity<Product>().Property(t => t.ProductName)
        .IsRequired()
        .HasColumnName("ProductName")
　　　　 .HasMaxLength(100);
}

　　在預設情況下，int型別的屬性生成的列名對應SQL SERVER列int型別；而String型別的屬性則對應SQL SERVER列的NVARCHAR型別。若類的字串型別屬性未設定MaxLength，則生成對應的列型別為NVARCHAR(MAX)。

　　為屬性指定對應的SQL SERVER資料型別：

[Column("UnitPrice", TypeName = "MONEY")]
public decimal UnitPrice { get; set; }
modelBuilder.Entity<Product>().Property(t => t.UnitPrice)
    .HasColumnName("UnitPrice")
    .HasColumnType("MONEY");

　　到此步，Product.cs類檔案的完整程式碼如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

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

namespace Portal.Entities
{
    [Table("Product", Schema = "dbo")]
    public class Product
    {
        [Column("ProductID")]
        public int ProductID { get; set; }

        [MaxLength(100)]
        [Required, Column("ProductName")]
        public string ProductName { get; set; }

        [Column("UnitPrice", TypeName = "MONEY")]
        public decimal UnitPrice { get; set; }
    }
}
View Code

　　屬性設定text資料型別：

[Column("Remark", TypeName = "text")]
public string Remark { get; set; }
modelBuilder.Entity<Category>().Property(t => t.Remark)
    .HasColumnName("Remark")
    .HasColumnType("text");

3. 主鍵

　　Entity Framework Code First的預設主鍵約束：屬性名為[ID]或[類名 + ID]。如在Product類中，Entity Framework Code First會根據預設約定將類中名稱為ID或ProductID的屬性設定為主鍵。Entity Framework Code First主鍵的預設約定也一樣可以進行重寫，重新根據需要進行設定。

3.1 Data Annotation方式

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
[Key]
[Column("ProductID")]
public int ProductID { get; set; }

3.2 Fluent API方式

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>().HasKey(t => t.ProductID);
}

　　若一個表有多個主鍵時：

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>().HasKey(t => new { t.KeyID, t.CandidateID });
}

4、資料庫自動生成欄位值

　　Entity Framework Code First對於int型別的主鍵，會自動的設定其為自動增長列。但有時我們確實不需是自動增長的，可以通過以下方式進行取消自動增長。

4.1 Data Annotation方式

[Key]
[Column("ProductID")]
[DatabaseGenerated(DatabaseGeneratedOption.None)]
public int ProductID { get; set; }
[Key]
[Column("CategoryID")]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int CategoryID { get; set; }

4.2 Fluent API方式

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>().HasKey(t => t.ProductID);
    modelBuilder.Entity<Product>().Property(t => t.ProductID)
        .HasColumnName("ProductID")
        .HasDatabaseGeneratedOption(DatabaseGeneratedOption.None);
}
protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Category>().ToTable("Category", "dbo");
    modelBuilder.Entity<Category>().HasKey(t => t.CategoryID);
    modelBuilder.Entity<Category>().Property(t => t.CategoryID)
        .HasColumnName("CategoryID")
        .HasDatabaseGeneratedOption(DatabaseGeneratedOption.Identity);
}

5. 數字型別長度及精度

　　在Product類中，UnitPrice表示單價，對於價格類的欄位，我們通常會希望其保留2為小數。這時可以使用Fluent API進行設定，且Data Annotation不支援該設定。

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>().Property(t => t.UnitPrice)
        .HasColumnName("UnitPrice")
        .HasPrecision(18, 2);
}

6、非資料庫欄位屬性

　　在類中，如果有一些屬性不需要對映到對應生成的資料表中，可以通過以下方式設定。

6.1 Data Annotation方式

[NotMapped]
public string Remark { get; set; }

6.2 Fluent API方式

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Entity<Product>().Ignore(t => t.Remark);
}

7. Fluent API配置Configuration對映類

　　在使用Fluent API進行Entity Framework Code First資料庫對映時，除了以上的在重寫OnModelCreating方法中直接對Entity進行配置之外，也可以對Configurations進行配置。這時可以先寫一個單獨的類，將資料表的全部對映要求都寫在建構函式中。

　　ProductMap.cs類

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using System.ComponentModel.DataAnnotations.Schema;
using System.Data.Entity.ModelConfiguration;

using Portal.Entities;

namespace Portal.Mapping
{
    public class ProductMap : EntityTypeConfiguration<Product>
    {
        public ProductMap()
        {
            // Primary Key
            this.HasKey(t => t.ProductID);

            // Properties
            this.Property(t => t.ProductID)
                .HasDatabaseGeneratedOption(DatabaseGeneratedOption.None);
            this.Property(t => t.ProductName)
                .IsRequired()
                .HasMaxLength(100);

            // Table & Column Mappings
            this.ToTable("Product");
            this.Property(t => t.ProductID).HasColumnName("ProductID");
            this.Property(t => t.ProductName).HasColumnName("ProductName");
            this.Property(t => t.UnitPrice)
                .HasColumnName("UnitPrice")
                .HasPrecision(18, 2);
        }
    }
}

　　有了上面的對映類之後，在重寫OnModelCreating方法中則可以直接呼叫對映類，從而減少了OnModelCreating方法的複雜度，同時也增強了程式碼維護的可讀性。

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Configurations.Add(new ProductMap());
}

相關文章