補習知識:Entity Framework Code First屬性映射約定

  Entity Framework Code First與數據表之間的映射方式有兩種實現:Data Annotation和Fluent API。本文中採用建立Product類爲例來講明tity Framework Code First屬性映射約定的具體方式。html

1. 表名及全部者

  在默認約定的狀況下,Entity Framework Code First建立的表名是根據類名的英語複數形式,建立的表全部者爲dbo,能夠經過重寫約定來指定表名及表的全部者。數據庫

1.1 Data Annotation方式

  在使用Data Annotation方式進行Entity Framework Code First與數據庫映射以前,須要先添加命名空間引用。app

using System.ComponentModel.DataAnnotations.Schema;

  爲類配置對應表名:ide

[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。post

  在繼承DbContext以前,添加命名空間引用。ui

using System.Data.Entity;

  重寫OnModelCreating方法,配置類對應於數據庫中的表名:this

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

  重寫OnModelCreating方法,配置類對應於數據庫中的表名,並指定表的全部者:spa

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

  到此處PortalContext.cs的完整代碼:code

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 });
}

四、數據庫自動生成字段值

  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.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());
}
 
來自:http://www.cnblogs.com/libingql/p/3352058.html
相關文章
相關標籤/搜索