Code First約定-數據註釋

經過實體框架Code First，可使用您本身的域類表示 EF 執行查詢、更改跟蹤和更新函數所依賴的模型。Code First 利用稱爲「約定先於配置」的編程模式。這就是說，Code First 將假定您的類聽從 EF 所使用的約定。在這種狀況下，EF 將可以找出本身工做所需的詳細信息。可是，若是您的類不遵照這些約定，則能夠向類中添加配置，以向 EF 提供它須要的信息。

Code First 爲您提供了兩種方法來向類中添加這些配置。一種方法是使用名爲 DataAnnotations 的簡單特性，另外一種方法是使用 Code First 的Fluent API，該 API 向您提供了在代碼中以命令方式描述配置的方法。

本文重點介紹如何使用DataAnnotations（在System.ComponentModel.DataAnnotations 命名空間中）對類進行配置，着重講述經常使用的配置。不少 .NET 應用程序（如 ASP.NET MVC）都可以理解DataAnnotations，它容許這些應用程序對客戶端驗證使用相同的註釋。

我將經過Blog 和 Post 這兩個簡單的類來講明 Code First DataAnnotations。

publicclass Blog

{

  public int Id { get; set; }

  public string Title { get; set; }

  public string BloggerName { get;set; }

  public virtual ICollection<Post> Posts { get;set; }

}

publicclass Post

{

  public int Id { get; set; }

  public string Title { get; set; }

  public DateTime DateCreated { get;set; }

  public string Content { get;set; }

  public int BlogId { get; set; }

  public ICollection<Comment>Comments { get; set;}

}

Blog 和 Post 類自己就遵照 Code First 約定，無需調整便可讓EF 與之共同使用。但您也可使用註釋向 EF 提供有關類以及類所映射到的數據庫的更多信息。

鍵

實體框架依賴於每一個具備鍵值的實體，它使用鍵值來跟蹤實體。Code First 依賴的一個約定是它在每個 Code First 類中以何種方式表示哪個屬性是鍵。該約定是查找名爲「Id」或類名與「Id」組合在一塊兒（如「BlogId」）的屬性。該屬性將映射到數據庫中的主鍵列。

Blog 和 Post 類都遵照此約定。但若是它們不遵照呢？若是 Blog 使用名稱 PrimaryTrackingKey，甚至使用 foo 呢？若是Code First 找不到符合此約定的屬性，它將引起異常，由於實體框架要求必需要有一個鍵屬性。您可使用鍵註釋來指定要將哪個屬性用做 EntityKey。

publicclass Blog

{

  [Key]

  public int PrimaryTrackingKey { get;set; }

  public string Title { get; set; }

  public string BloggerName { get;set; }

  public virtual ICollection<Post> Posts { get;set; }

}

若是您在使用Code First 的數據庫生成功能，則Blog 表將具備名爲 PrimaryTrackingKey 的主鍵列，該列默認狀況下還定義爲 Identity。

 

 

必需

Required 註釋告訴 EF 某一個特定屬性是必需的。

在 Title 屬性中添加 Required 將強制 EF（和 MVC）確保該屬性中包含數據。

[Required]

public string Title { get;set; }

Required 特性將使被映射的屬性不可爲空來影響生成的數據庫。請注意，Title 字段已經更改成「not null」。

 

MaxLength 和MinLength

使用MaxLength 和MinLength 特性，您能夠就像對Required 那樣指定其餘屬性驗證。

下面是具備長度要求的BloggerName。該示例也說明如何組合特性。

[MaxLength(10), MinLength(5)]

public string BloggerName { get;set; }

 

MaxLength 註釋將經過把屬性長度設置爲 10 來影響數據庫。MinLength屬性不會對數據庫產生影響。

 

NotMapped

Code First 約定指示具備受支持數據類型的每一個屬性都要在數據庫中有表示。但在您的應用程序中並不老是如此。例如，您能夠在 Blog 類中使用一個屬性來基於 Title 和BloggerName 字段建立代碼。該屬性能夠動態建立，無需存儲。您可使用 NotMapped 註釋來標記不映射到數據庫的全部屬性，以下面的 BlogCode 屬性。

[NotMapped]

publicstring BlogCode

{

  get

  {

    returnTitle.Substring(0, 1) + ":" +BloggerName.Substring(0, 1);

  }

}

ComplexType

跨一組類描述域實體，而後將這些類分層以描述一個完整實體的狀況並很多見。例如，您能夠向模型中添加一個名爲 BlogDetails 的類。

publicclass BlogDetails

{

  public DateTime? DateCreated { get;set; }

 

  [MaxLength(250)]

  public string Description { get;set; }

}

請注意，BlogDetails 沒有任何鍵屬性類型。在域驅動的設計中，BlogDetails 稱爲值對象。實體框架將值對象稱爲複雜類型。複雜類型不能自行跟蹤。

 

可是 BlogDetails 做爲 Blog 類中的一個屬性，將做爲 Blog 對象的一部分被跟蹤。爲了讓 Code First 認識到這一點，您必須將 BlogDetails 類標記爲 ComplexType。

[ComplexType]

publicclass BlogDetails

{

  public DateTime? DateCreated { get;set; }

  [MaxLength(250)]

  public string Description { get;set; }

}

如今，您能夠在Blog 類中添加一個屬性來表示該博客的 BlogDetails。

    public BlogDetails BlogDetail { get; set; }

在數據庫中，Blog表將包含該博客的全部屬性，包括在其 BlogDetail 屬性中所含的屬性。默認狀況下，每一個屬性都將添加複雜類型名稱前綴 BlogDetail。

 

另外，有趣的是，雖然DateCreated 屬性在類中定義爲不可爲空的 DateTime，但相關數據庫字段是可爲空的。若是想影響數據庫架構，則必須使用 Required 註釋。

ConcurrencyCheck

ConcurrencyCheck 註釋 可用於標記要在用戶編輯或刪除實體時用於在數據庫中進行併發檢查的一個或多個屬性。若是以前使用 EF 設計器，則這等同於將屬性的 ConcurrencyMode 設置爲 Fixed。

如今讓咱們將ConcurrencyCheck 添加到BloggerName 屬性，看看它如何工做。

[ConcurrencyCheck, MaxLength(10),MinLength(5)]   

public  string BloggerName { get;set; }

調用SaveChanges 時，由於BloggerName 字段上具備ConcurrencyCheck 註釋，因此在更新中將使用該屬性的初始值。該命令將嘗試經過同時依據鍵值和 BloggerName 的初始值進行篩選來查找正確的行。下面是發送到數據庫的 UPDATE 命令的關鍵部分，在其中您能夠看到該命令將更新 PrimaryTrackingKey 爲 1 且BloggerName 爲「Julie」（這是從數據庫中檢索到該博客時的初始值）的行。

where (([PrimaryTrackingKey]= @4) and([BloggerName] = @5))

@4=1,@5=N'Julie'

若是在此期間有人更改了該博客的博主姓名，則此更新將失敗，並引起 DbUpdateConcurrencyException 而且須要處理該異常。

TimeStamp

使用rowversion 或timestamp 字段來進行併發檢查更爲常見。可是比起使用 ConcurrencyCheck 註釋，只要屬性類型爲字節數組，則不如使用更爲具體的 TimeStamp 註釋。Code First 將Timestamp 屬性與ConcurrencyCheck 屬性同等對待，但它還將確保 Code First 生成的數據庫字段是不可爲空的。在一個指定類中，只能有一個 timestamp 屬性。

將如下屬性添加到Blog 類：

[Timestamp]

publicByte[] TimeStamp { get;set; }

這樣，CodeFirst 將在數據庫表中建立一個不可爲空的 Timestamp 列。

 

表和列

若是您讓Code First 建立數據庫，則可能但願更改它建立的表和列的名稱。也能夠將 Code First 用於現有數據庫。可是域中的類和屬性的名稱並不老是與數據庫中表和列的名稱相匹配。

個人類名爲Blog，按照約定，Code First 將假定此類映射到名爲 Blogs 的表。若是不是這樣，您能夠用 Table 特性指定該表的名稱。舉例來講，下面的註釋指定表名稱爲 InternalBlogs，同時指定了schema，默認的schema就是dbo。

[Table("InternalBlogs",Schema="dbo")]

public class Blog

 

Column 註釋更適於用來指定被映射列的特性。您能夠規定名稱、數據類型甚至列出如今表中的順序。下面是 Column 特性的示例。

[Column("BlogDescription",TypeName = "ntext")]

public String Description { get; set; }

 

下面是從新生成後的表。表名稱已更改成 InternalBlogs，複雜類型的 Description 列如今是BlogDescription。由於該名稱在註釋中指定，Code First 不會使用以複雜類型名稱做爲列名開頭的約定。

 

DatabaseGenerated

一個重要的數據庫功能是可使用計算屬性。若是您將 Code First 類映射到包含計算列的表，則您可能不想讓實體框架嘗試更新這些列。可是在插入或更新數據後，您的確須要 EF 從數據庫中返回這些值。您可使用 DatabaseGenerated 註釋與 Computed 枚舉一塊兒在您的類中標註這些屬性。其餘枚舉爲 None 和Identity。

[DatabaseGenerated(DatabaseGeneratedOption.Computed)]

public DateTime DateCreated { get; set; }

當 Code First生成數據庫時，您能夠對 byte 或timestamp 列使用此標記，不然您只應該在指向現有數據庫時使用，由於 Code First 將不能肯定計算列的公式。

您閱讀過以上內容，知道默認狀況下，整數鍵屬性將成爲數據庫中的標識鍵。這與將 DatabaseGenerated 設置爲 DatabaseGenerationOption.Identity 是同樣的。若是不但願它成爲標識鍵，則能夠將該值設置爲 DatabaseGenerationOption.None。

關係特性：InverseProperty和ForeignKey

Code First 約定將在您的模型中處理最經常使用的關係，可是在某些狀況下它須要幫助。

在 Blog 類中更改鍵屬性的名稱形成它與 Post 的關係出現問題。

生成數據庫時，CodeFirst 會在 Post 類中看到 BlogId 屬性並識別出該屬性，按照約定，它與類名加「Id」匹配，並做爲 Blog 類的外鍵。可是在此Blog 類中沒有 BlogId 屬性。解決方法是，在 Post 中建立一個導航屬性，並使用 Foreign DataAnnotation 來幫助 CodeFirst 瞭解如何在兩個類之間建立關係（那就是使用 Post.BlogId 屬性）以及如何在數據庫中指定約束。

publicclass Post

{

  public int Id { get; set; }

  public string Title { get; set; }

  public DateTime DateCreated { get;set; }

  public string Content { get;set; }

  public int BlogId { get; set; }

  [ForeignKey("BlogId")]

  public Blog Blog { get; set; }

}

數據庫中的約束顯示InternalBlogs.PrimaryTrackingKey 與Posts.BlogId 之間的關係。

 

 

類之間存在多個關係時，將使用 InverseProperty。

在 Post 類中，您可能須要跟蹤是誰撰寫了博客文章以及誰編輯了它。下面是 Post 類的兩個新的導航屬性。

public Person CreatedBy { get;set; }

public Person UpdatedBy { get;set; }

您還須要在這些屬性引用的 Person 類中添加內容。Person類具備返回到 Post 的導航屬性，一個屬性指向該用戶撰寫的全部文章，一個屬性指向該用戶更新的全部文章。

publicclass Person

{

  public int Id { get; set; }

  public string Name { get; set; }

  public List<Post>PostsWritten { get; set;}

  public List<Post>PostsUpdated { get; set;}

}

Code First 不能自行使這兩個類中的屬性匹配。Posts 的數據庫表應該有一個表示 CreatedBy 人員的外鍵，有一個表示 UpdatedBy 人員的外鍵，可是 Code First 將建立四個外鍵屬性：Person_Id、Person_Id一、CreatedBy_Id 和UpdatedBy_Id。(針對每一個導航屬性建立一個外鍵)

 

要解決這些問題，您可使用 InverseProperty 註釋來指定這些屬性的匹配。

[InverseProperty("CreatedBy")]

publicList<Post>PostsWritten { get; set;}

 

[InverseProperty("UpdatedBy")]

publicList<Post>PostsUpdated { get; set;}

 

由於Person 中的PostsWritten 屬性知道這指的是Post 類型，因此它將與 Post.CreatedBy 創建關係。一樣，PostsUpdated 也將與 Post.UpdatedBy 創建關係。Code First 不會建立額外的外鍵。

 

總結

DataAnnotations 不只可用於在 Code First 類中描述客戶端和服務器端驗證，還讓您可以增強甚至更正 Code First 將基於其約定對您的類所做的假設。使用 DataAnnotations，您不只可以推進數據庫架構生成，還能將 Code First 類映射到預先存在的數據庫。

雖然它們都很是靈活，但請記住，DataAnnotations 只提供您常常須要對 Code First 類進行的配置更改。要爲一些邊緣狀況配置類，則應該採用另外一種替代配置機制，那就是 Code First 的Fluent API。