Code First 約定

借助 CodeFirst，可通過使用 C# 或Visual Basic .NET 類來描述模型。模型的基本形狀可通過約定來檢測。約定是規(guī)則集，用于在使用 Code First 時基于類定義自動配置概念模型。約定是在 System.Data.Entity.ModelConfiguration.Conventions 命名空間中定義的。

可通過使用數(shù)據(jù)注釋或Fluent API 進一步配置模型。優(yōu)先級是通過 Fluent API 進行配置，然后是通過數(shù)據(jù)注釋，再次是通過約定。

API 文檔中提供了 Code First 約定的詳細列表。本主題概述 Code First 使用的約定。

類型發(fā)現(xiàn)

當(dāng)使用 CodeFirst 開發(fā)時，通常是從編寫用來定義概念(域)模型的 .NET類開始。除了定義類之外，還需要讓 DbContext 知道模型中要包含哪些類。為此，需要定義一個上下文類，此類派生自 DbContext 并公開需要成為模型一部分的類型的 DbSet 屬性。Code First 將包含這些類型，還將包含任何引用類型，即使這些引用類型是在不同的程序集中定義的也是如此。

如果類型存在于繼承層次結(jié)構(gòu)中，則為基類定義 DbSet 屬性就足夠了，如果派生類型位于與基類相同的程序集中，則自動包含這些派生類型。

在下面的示例中，僅對SchoolEntities 類定義一個DbSet 屬性 (Departments)。CodeFirst 使用此屬性來發(fā)現(xiàn)并包含任何引用類型。

publicclass?SchoolEntities:?DbContext

{

??public?DbSet<Department>Departments {?get;?set;}

}

publicclass?Department

{

??// Primary key

??public?int?DepartmentID {?get;set; }

??public?string?Name {?get;?set; }

??// Navigationproperty

??public?virtual?ICollection<Course> Courses {?get;set; }

}

publicclass?Course

{

??// Primary key

??public?int?CourseID {?get;?set; }

??public?string?Title {?get;?set; }

??public?int?Credits {?get;?set; }

??// Foreign key

??public?int?DepartmentID {?get;set; }

??// Navigationproperties

??public?virtual?DepartmentDepartment {?get;?set;}

}

publicpartial?class?OnlineCourse?:?Course

{

??public?string?URL {?get;?set; }

}

publicpartial?class?OnsiteCourse?:?Course

{

??public?string?Location {?get;set; }

??public?string?Days {?get;?set; }

??publicSystem.DateTime?Time {?get;?set; }

}

如果要從模型排除類型，請使用 NotMapped 特性或DbModelBuilder.Ignore

主鍵約定

如果類的屬性名為“ID”(不區(qū)分大小寫)或類名的后面跟有“ID”，則 Code First 會推斷該屬性是主鍵。如果主鍵屬性的類型為數(shù)值或 GUID，則將其配置為標(biāo)識列。

publicclass?Department

{

??// Primary key

??public?int?DepartmentID {?get;set; }

}

關(guān)系約定

實體框架中的導(dǎo)航屬性提供了一種在兩個實體類型之間導(dǎo)航關(guān)系的方法。針對對象參與到其中的每個關(guān)系，各對象均可以具有導(dǎo)航屬性。使用導(dǎo)航屬性，可以在兩個方向上導(dǎo)航和管理關(guān)系，返回引用對象(如果多重性為一或者零或一)或集合(如果多重性為多)。Code First 根據(jù)針對類型定義的導(dǎo)航屬性來推斷關(guān)系。

除導(dǎo)航屬性外，建議還要包括表示依賴對象的類型的外鍵屬性。任何數(shù)據(jù)類型與主體主鍵屬性相同、遵循以下一種格式的屬性都表示關(guān)系的外鍵：“<導(dǎo)航屬性名稱><主體主鍵屬性>”、“<主體類名><主鍵屬性名稱>”或“<主體主鍵屬性名稱>”。如果找到多個匹配項，則優(yōu)先級符合上面列出的順序。外鍵檢測不區(qū)分大小寫。在檢測外鍵屬性時，Code First 基于外鍵的可空性推斷關(guān)系的多重性。如果屬性可以為 Null，則將關(guān)系注冊為可選關(guān)系；否則，將關(guān)系注冊為必需關(guān)系。

如果依賴實體上的外鍵不能為 Null，則 CodeFirst 對關(guān)系設(shè)置級聯(lián)刪除。如果依賴實體上的外鍵可以為 Null，則Code First 不對關(guān)系設(shè)置級聯(lián)刪除，并且在刪除主體時，會將該外鍵設(shè)置為 Null。通過使用 Fluent API，可以覆蓋由約定檢測的多重性和級聯(lián)刪除行為。

publicclass?Department

{

??// Primary key

??public?int?DepartmentID {?get;set; }

??public?string?Name {?get;?set; }

??// Navigationproperty

??public?virtual?ICollection<Course> Courses {?get;set; }

}

publicclass?Course

{

??// Primary key

??public?int?CourseID {?get;?set; }

??public?string?Title {?get;?set; }

??public?int?Credits {?get;?set; }

??// Foreign key

??public?int?DepartmentID {?get;set; }

??// Navigationproperties

??public?virtual?DepartmentDepartment {?get;?set;}

}

在下面的示例中，導(dǎo)航屬性和外鍵用于定義 Department 類與Course 類之間的關(guān)系。

注意：如果相同類型間有多個關(guān)系(例如，假設(shè)定義 Person 和Book 類，其中，Person 包含ReviewedBooks 和AuthoredBooks 導(dǎo)航屬性，而Book 類包含 Author 和Reviewer 導(dǎo)航屬性)，則需要使用數(shù)據(jù)注釋或 Fluent API 手動配置關(guān)系。

復(fù)雜類型約定

當(dāng) CodeFirst 發(fā)現(xiàn)無法推斷主鍵以及未通過數(shù)據(jù)注釋或 Fluent API 注冊主鍵的類時，類型會自動注冊為復(fù)雜類型。復(fù)雜類型檢測還要求類型不具有引用實體類型的屬性，并且未被其他類型的集合屬性引用。對于以下類定義，Code First 推斷Details 是復(fù)雜類型，因為它沒有主鍵。

publicpartial?class?OnsiteCourse?:?Course

{

??publicOnsiteCourse()

? {

??? Details =?newDetails();

? }

??public?Details?Details {?get;set; }

}

publicclass?Details

{

??publicSystem.DateTime?Time {?get;?set; }

??public?string?Location {?get;set; }

??public?string?Days {?get;?set; }

}

?

連接字符串約定

默認配置

如果您還沒有在應(yīng)用程序中進行任何其他配置，則對 DbContext 調(diào)用無參數(shù)構(gòu)造函數(shù)將會導(dǎo)致 DbContext 使用按約定創(chuàng)建的數(shù)據(jù)庫連接在 Code First 模式下運行。例如：

namespaceDemo.EF

{

??public?class?BloggingContext:?DbContext

? {

????publicBloggingContext()

????// C# will callbase class parameterless constructor by default

??? {

??? }

? }

}

在此示例中，DbContext使用派生上下文類 Demo.EF.BloggingContext 的命名空間限定名稱作為數(shù)據(jù)庫名稱，并使用 SQL Express 或 LocalDb 為此數(shù)據(jù)庫創(chuàng)建連接字符串。如果同時安裝了這兩個數(shù)據(jù)庫，將使用 SQL Express。

默認情況下，VisualStudio 2010 包含 SQLExpress，VisualStudio 2012 包含LocalDb。安裝期間，EntityFrameworkNuGet 包會檢查哪個數(shù)據(jù)庫服務(wù)器可用。隨后 NuGet 包將設(shè)置按約定創(chuàng)建連接時 Code First 所使用的默認數(shù)據(jù)庫服務(wù)器，以此更新配置文件。如果 SQL Express 正在運行，將使用它。如果 SQL Express 不可用，則 LocalDb 將注冊為默認數(shù)據(jù)庫。如果配置文件已包含默認連接工廠設(shè)置，則不會更改該文件。

指定數(shù)據(jù)庫名稱

如果您尚未在應(yīng)用程序中進行任何其他配置，在通過要使用的數(shù)據(jù)庫名稱對 DbContext 調(diào)用字符串構(gòu)造函數(shù)時，將會導(dǎo)致 DbContext 使用按約定創(chuàng)建的與該名稱數(shù)據(jù)庫的連接在 Code First 模式下運行。例如：

namespaceDemo.EF

{

??public?class?BloggingContext:?DbContext

? {

????public?BloggingContext()

????? :?base("BloggingDatabase")

??? {

??? }

? }

}

在此示例中，DbContext使用“BloggingDatabase”作為數(shù)據(jù)庫名稱，并使用 SQL Express(隨Visual Studio 2010 安裝)或LocalDb(隨Visual Studio 2012 安裝)為此數(shù)據(jù)庫創(chuàng)建連接字符串。如果同時安裝了這兩個數(shù)據(jù)庫，將使用 SQL Express。

指定連接字符串

可以選擇將連接字符串放入 app.config 或web.config 文件中。例如：

<configuration>

? <connectionStrings>

??? <addname="BloggingCompactDatabase"

?????????providerName="System.Data.SqlServerCe.4.0"

?????????connectionString="Data Source=Blogging.sdf"/>

? </connectionStrings>

</configuration>

這是一種指示 DbContext 使用數(shù)據(jù)庫服務(wù)器而非 SQL Express 或LocalDb 的簡單方法 — 上例指定了 SQL Server Compact Edition 數(shù)據(jù)庫。

如果連接字符串的名稱與上下文的名稱(帶或不帶命名空間限定)相同，則使用無參數(shù)構(gòu)造函數(shù)時 DbContext 會找到該連接字符串。如果連接字符串名稱與上下文名稱不同，則可通過將連接字符串名稱傳遞給 DbContext 構(gòu)造函數(shù)，指示 DbContext 在 CodeFirst 模式下使用此連接。例如：

publicclass?BloggingContext:?DbContext

{

??publicBloggingContext()

??? :?base("BloggingCompactDatabase")

? {

? }

}

或者，也可以對傳遞給DbContext 構(gòu)造函數(shù)的字符串使用 “name=<連接字符串名稱>”格式。例如：

publicclass?BloggingContext:?DbContext

{

??publicBloggingContext()

??? :?base("name=BloggingCompactDatabase")

? {

? }

}

使用此形式可以明確要求在配置文件中查找連接字符串。如果未找到具有給定名稱的連接字符串，則將引發(fā)異常。

數(shù)據(jù)庫初始化策略：

數(shù)據(jù)庫創(chuàng)建是由策略來控制的，有如下四種策略：

1.???????CreateDatabaseIfNotExists：這是默認的策略。如果數(shù)據(jù)庫不存在，那么就創(chuàng)建數(shù)據(jù)庫。但是如果數(shù)據(jù)庫存在了，而且實體發(fā)生了變化，就會出現(xiàn)異常。

2.???????DropCreateDatabaseIfModelChanges：此策略表明，如果模型變化了，數(shù)據(jù)庫就會被重新創(chuàng)建，原來的數(shù)據(jù)庫被刪除掉了。

3.???????DropCreateDatabaseAlways：此策略表示，每次運行程序都會重新創(chuàng)建數(shù)據(jù)庫，這在開發(fā)和調(diào)試的時候非常有用。

4.???????自定制數(shù)據(jù)庫策略：可以自己實現(xiàn)IDatabaseInitializer來創(chuàng)建自己的策略。或者從已有的實現(xiàn)了IDatabaseInitializer接口的類派生。

如下示例顯示了如何應(yīng)用數(shù)據(jù)庫創(chuàng)建策略：

public?class?UserManContext?:?DbContext

{

????public?UserManContext()

??????? :?base("USMDBConnectionString")

??? {???????????

????????Database.SetInitializer<UserManContext>(new?CreateDatabaseIfNotExists<UserManContext>());

??? }???

}

下面的代碼創(chuàng)建了一個自定義策略，什么也沒有做，但是我們可以在Seed方法里添加我們的種子數(shù)據(jù)。

public?class?USMDBInitializer?:?DropCreateDatabaseAlways<UserManContext>

{

????protected?override?void?Seed(UserManContext?context)

??? {

????????base.Seed(context);

??? }

}

雖然EF提供了在配置文件中配置策略的方法，如下所示：

<appSettings>

??? <addkey="DatabaseInitializerForType?EFCodeFirstSample.UserManContext, EFCodeFirstSample"

????????value="System.Data.Entity.DropCreateDatabaseAlways`1[[EFCodeFirstSample.UserManContext,EFCodeFirstSample]], EntityFramework"?/>

? </appSettings>

Key必須以DatabaseInitializerForType開始，后邊加空格，之后是context類的全名稱，包括帶命名空間的類名和所在的程序集名。Value是策略的全名稱。可以看見key和value都非常難讀，還不如自己寫配置來的好。

如果不想使用策略，就可以關(guān)閉策略，特別是默認策略。關(guān)閉策略的代碼如下：

public?class?UserManContext?:?DbContext

{

????public?UserManContext()

??????? :?base("USMDBConnectionString")

??? {???????????

????????Database.SetInitializer<UserManContext>(null);

??? }

}

還可以在配置文件中關(guān)閉策略，如下：

<addkey="DatabaseInitializerForTypeEFCodeFirstSample.UserManContext, EFCodeFirstSample"

????????value="Disabled"?/>

為數(shù)據(jù)庫添加種子數(shù)據(jù)

上面提高可以在自定義數(shù)據(jù)庫初始化策略中添加種子數(shù)據(jù)，下面的示例說明如何添加種子數(shù)據(jù)：

public?class?USMDBInitializer?:?DropCreateDatabaseAlways<UserManContext>

{

????protected?override?void?Seed(UserManContext?context)

??? {

????????User?admin =?new?User();

??????? admin.Name =?"admin";

??????? admin.DisplayName =?"Administrator";

??????? admin.Status = 1;

??????? admin.LastModDate=?DateTime.Now;

??????? context.Users.Add(admin);

????????base.Seed(context);

??? }

}

需要注意的是日期字段，數(shù)據(jù)庫中的日期范圍小于.NET中的日期范圍，所以必須給一個合適的值，像DateTime.MinValue這樣的值無法存儲到數(shù)據(jù)庫中。可以參考SqlDateTime類型來確定Sql數(shù)據(jù)庫支持的時間范圍。

移除約定

可以移除在System.Data.Entity.ModelConfiguration.Conventions 命名空間中定義的任何約定。下面的示例移除 PluralizingTableNameConvention。

publicclass?SchoolEntities:?DbContext

{

??protected?override?voidOnModelCreating(DbModelBuilder?modelBuilder)

? {

????// Configure CodeFirst to ignore PluralizingTableName convention

????// If you keepthis convention, the generated tables

????// will havepluralized names.

??? modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();

? }

}

可插入約定

可插入(自定義)約定目前不受支持，正在針對 EF6 進行開發(fā)。

Code First 數(shù)據(jù)注釋

通過實體框架Code First，可以使用您自己的域類表示 EF 執(zhí)行查詢、更改跟蹤和更新函數(shù)所依賴的模型。Code First 利用稱為“約定先于配置”的編程模式。這就是說，Code First 將假定您的類遵從 EF 所使用的約定。在這種情況下，EF 將能夠找出自己工作所需的詳細信息。但是，如果您的類不遵守這些約定，則可以向類中添加配置，以向 EF 提供它需要的信息。

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

本文重點介紹如何使用DataAnnotations(在System.ComponentModel.DataAnnotations 命名空間中)對類進行配置，著重講述常用的配置。很多 .NET 應(yīng)用程序(如 ASP.NET MVC)都能夠理解DataAnnotations，它允許這些應(yīng)用程序?qū)蛻舳蓑炞C使用相同的注釋。

我將通過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 約定，無需調(diào)整即可讓EF 與之共同使用。但您也可以使用注釋向 EF 提供有關(guān)類以及類所映射到的數(shù)據(jù)庫的更多信息。

鍵

實體框架依賴于每個具有鍵值的實體，它使用鍵值來跟蹤實體。Code First 依賴的一個約定是它在每一個 Code First 類中以何種方式表示哪一個屬性是鍵。該約定是查找名為“Id”或類名與“Id”組合在一起(如“BlogId”)的屬性。該屬性將映射到數(shù)據(jù)庫中的主鍵列。

Blog 和 Post 類都遵守此約定。但如果它們不遵守呢？如果 Blog 使用名稱 PrimaryTrackingKey，甚至使用 foo 呢？如果Code First 找不到符合此約定的屬性，它將引發(fā)異常，因為實體框架要求必須要有一個鍵屬性。您可以使用鍵注釋來指定要將哪一個屬性用作 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 的數(shù)據(jù)庫生成功能，則Blog 表將具有名為 PrimaryTrackingKey 的主鍵列，該列默認情況下還定義為 Identity。

必需

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

在 Title 屬性中添加 Required 將強制 EF(和 MVC)確保該屬性中包含數(shù)據(jù)。

[Required]

publicstring?Title {?get;set; }

Required 特性將使被映射的屬性不可為空來影響生成的數(shù)據(jù)庫。請注意，Title 字段已經(jīng)更改為“not null”。

MaxLength 和MinLength

使用MaxLength 和MinLength 特性，您可以就像對Required 那樣指定其他屬性驗證。

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

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

publicstring?BloggerName {?get;set; }

MaxLength 注釋將通過把屬性長度設(shè)置為 10 來影響數(shù)據(jù)庫。MinLength屬性不會對數(shù)據(jù)庫產(chǎn)生影響。

NotMapped

Code First 約定指示具有受支持?jǐn)?shù)據(jù)類型的每個屬性都要在數(shù)據(jù)庫中有表示。但在您的應(yīng)用程序中并不總是如此。例如，您可以在 Blog 類中使用一個屬性來基于 Title 和BloggerName 字段創(chuàng)建代碼。該屬性可以動態(tài)創(chuàng)建，無需存儲。您可以使用 NotMapped 注釋來標(biāo)記不映射到數(shù)據(jù)庫的所有屬性，如下面的 BlogCode 屬性。

[NotMapped]

publicstring?BlogCode

{

??get

? {

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

? }

}

ComplexType

跨一組類描述域?qū)嶓w，然后將這些類分層以描述一個完整實體的情況并不少見。例如，您可以向模型中添加一個名為 BlogDetails 的類。

publicclass?BlogDetails

{

??public?DateTime? DateCreated {?get;set; }

? [MaxLength(250)]

??public?string?Description {?get;set; }

}

請注意，BlogDetails 沒有任何鍵屬性類型。在域驅(qū)動的設(shè)計中，BlogDetails 稱為值對象。實體框架將值對象稱為復(fù)雜類型。復(fù)雜類型不能自行跟蹤。

但是 BlogDetails 作為 Blog 類中的一個屬性，將作為 Blog 對象的一部分被跟蹤。為了讓 Code First 認識到這一點，您必須將 BlogDetails 類標(biāo)記為 ComplexType。

[ComplexType]

publicclass?BlogDetails

{

??public?DateTime? DateCreated {?get;set; }

? [MaxLength(250)]

??public?string?Description {?get;set; }

}

現(xiàn)在，您可以在Blog 類中添加一個屬性來表示該博客的 BlogDetails。

??? public BlogDetails BlogDetail { get; set; }

在數(shù)據(jù)庫中，Blog表將包含該博客的所有屬性，包括在其 BlogDetail 屬性中所含的屬性。默認情況下，每個屬性都將添加復(fù)雜類型名稱前綴 BlogDetail。

另外，有趣的是，雖然DateCreated 屬性在類中定義為不可為空的 DateTime，但相關(guān)數(shù)據(jù)庫字段是可為空的。如果想影響數(shù)據(jù)庫架構(gòu)，則必須使用 Required 注釋。

ConcurrencyCheck

ConcurrencyCheck 注釋可用于標(biāo)記要在用戶編輯或刪除實體時用于在數(shù)據(jù)庫中進行并發(fā)檢查的一個或多個屬性。如果之前使用 EF 設(shè)計器，則這等同于將屬性的 ConcurrencyMode 設(shè)置為 Fixed。

現(xiàn)在讓我們將ConcurrencyCheck 添加到BloggerName 屬性，看看它如何工作。

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

publicstring?BloggerName {?get;set; }

調(diào)用SaveChanges 時，因為BloggerName 字段上具有ConcurrencyCheck 注釋，所以在更新中將使用該屬性的初始值。該命令將嘗試通過同時依據(jù)鍵值和 BloggerName 的初始值進行篩選來查找正確的行。下面是發(fā)送到數(shù)據(jù)庫的 UPDATE 命令的關(guān)鍵部分，在其中您可以看到該命令將更新 PrimaryTrackingKey 為 1 且BloggerName 為“Julie”(這是從數(shù)據(jù)庫中檢索到該博客時的初始值)的行。

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

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

如果在此期間有人更改了該博客的博主姓名，則此更新將失敗，并引發(fā) DbUpdateConcurrencyException 并且需要處理該異常。

TimeStamp

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

將以下屬性添加到Blog 類：

1726835644

publicByte[] TimeStamp {?get;set; }

這樣，CodeFirst 將在數(shù)據(jù)庫表中創(chuàng)建一個不可為空的 Timestamp 列。

表和列

如果您讓Code First 創(chuàng)建數(shù)據(jù)庫，則可能希望更改它創(chuàng)建的表和列的名稱。也可以將 Code First 用于現(xiàn)有數(shù)據(jù)庫。但是域中的類和屬性的名稱并不總是與數(shù)據(jù)庫中表和列的名稱相匹配。

我的類名為Blog，按照約定，Code First 將假定此類映射到名為 Blogs 的表。如果不是這樣，您可以用 Table 特性指定該表的名稱。舉例來說，下面的注釋指定表名稱為 InternalBlogs，同時指定了schema，默認的schema就是dbo。

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

publicclass?Blog

Column 注釋更適于用來指定被映射列的特性。您可以規(guī)定名稱、數(shù)據(jù)類型甚至列出現(xiàn)在表中的順序。下面是 Column 特性的示例。

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

publicString?Description {?get;?set; }

下面是重新生成后的表。表名稱已更改為 InternalBlogs，復(fù)雜類型的 Description 列現(xiàn)在是BlogDescription。因為該名稱在注釋中指定，Code First 不會使用以復(fù)雜類型名稱作為列名開頭的約定。

DatabaseGenerated

一個重要的數(shù)據(jù)庫功能是可以使用計算屬性。如果您將 Code First 類映射到包含計算列的表，則您可能不想讓實體框架嘗試更新這些列。但是在插入或更新數(shù)據(jù)后，您的確需要 EF 從數(shù)據(jù)庫中返回這些值。您可以使用 DatabaseGenerated 注釋與 Computed 枚舉一起在您的類中標(biāo)注這些屬性。其他枚舉為 None 和Identity。

[DatabaseGenerated(DatabaseGeneratedOption.Computed)]

publicDateTime?DateCreated {?get;?set; }

當(dāng) Code First生成數(shù)據(jù)庫時，您可以對 byte 或timestamp 列使用此標(biāo)記，否則您只應(yīng)該在指向現(xiàn)有數(shù)據(jù)庫時使用，因為 Code First 將不能確定計算列的公式。

您閱讀過以上內(nèi)容，知道默認情況下，整數(shù)鍵屬性將成為數(shù)據(jù)庫中的標(biāo)識鍵。這與將 DatabaseGenerated 設(shè)置為 DatabaseGenerationOption.Identity 是一樣的。如果不希望它成為標(biāo)識鍵，則可以將該值設(shè)置為 DatabaseGenerationOption.None。

關(guān)系特性：InverseProperty和ForeignKey

Code First 約定將在您的模型中處理最常用的關(guān)系，但是在某些情況下它需要幫助。

在 Blog 類中更改鍵屬性的名稱造成它與 Post 的關(guān)系出現(xiàn)問題。

生成數(shù)據(jù)庫時，CodeFirst 會在 Post 類中看到 BlogId 屬性并識別出該屬性，按照約定，它與類名加“Id”匹配，并作為 Blog 類的外鍵。但是在此Blog 類中沒有 BlogId 屬性。解決方法是，在 Post 中創(chuàng)建一個導(dǎo)航屬性，并使用 Foreign DataAnnotation 來幫助 CodeFirst 了解如何在兩個類之間創(chuàng)建關(guān)系(那就是使用 Post.BlogId 屬性)以及如何在數(shù)據(jù)庫中指定約束。

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

}

數(shù)據(jù)庫中的約束顯示InternalBlogs.PrimaryTrackingKey 與Posts.BlogId 之間的關(guān)系。

類之間存在多個關(guān)系時，將使用 InverseProperty。

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

publicPerson?CreatedBy {?get;set; }

publicPerson?UpdatedBy {?get;set; }

您還需要在這些屬性引用的 Person 類中添加內(nèi)容。Person類具有返回到 Post 的導(dǎo)航屬性，一個屬性指向該用戶撰寫的所有文章，一個屬性指向該用戶更新的所有文章。

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 的數(shù)據(jù)庫表應(yīng)該有一個表示 CreatedBy 人員的外鍵，有一個表示 UpdatedBy 人員的外鍵，但是 Code First 將創(chuàng)建四個外鍵屬性：Person_Id、Person_Id1、CreatedBy_Id 和UpdatedBy_Id。(針對每個導(dǎo)航屬性創(chuàng)建一個外鍵)

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

[InverseProperty("CreatedBy")]

publicList<Post>PostsWritten {?get;?set;}

[InverseProperty("UpdatedBy")]

publicList<Post>PostsUpdated {?get;?set;}

因為Person 中的PostsWritten 屬性知道這指的是Post 類型，所以它將與 Post.CreatedBy 建立關(guān)系。同樣，PostsUpdated 也將與 Post.UpdatedBy 建立關(guān)系。Code First 不會創(chuàng)建額外的外鍵。

總結(jié)

DataAnnotations 不僅可用于在 Code First 類中描述客戶端和服務(wù)器端驗證，還讓您能夠加強甚至更正 Code First 將基于其約定對您的類所作的假設(shè)。使用 DataAnnotations，您不僅能夠推動數(shù)據(jù)庫架構(gòu)生成，還能將 Code First 類映射到預(yù)先存在的數(shù)據(jù)庫。

雖然它們都非常靈活，但請記住，DataAnnotations 只提供您經(jīng)常需要對 Code First 類進行的配置更改。要為一些邊緣情況配置類，則應(yīng)該采用另一種替代配置機制，那就是 Code First 的Fluent API。

使用Fluent API 配置/映射屬性和類型

簡介

通常通過重寫派生DbContext 上的OnModelCreating 方法來訪問Code First Fluent API。以下示例旨在顯示如何使用 Fluent API 執(zhí)行各種任務(wù)，您可以將代碼復(fù)制出來并進行自定義，使之適用于您的模型。

屬性映射

Property 方法用于為每個屬于實體或復(fù)雜類型的屬性配置特性。Property 方法用于獲取給定屬性的配置對象。配置對象上的選項特定于要配置的類型；例如，IsUnicode 只能用于字符串屬性。

配置主鍵

要顯式將某個屬性設(shè)置為主鍵，可使用 HasKey 方法。在以下示例中，使用了 HasKey 方法對 OfficeAssignment 類型配置 InstructorID 主鍵。

modelBuilder.Entity<OfficeAssignment>().HasKey(t =>t.InstructorID);

配置組合主鍵

以下示例配置要作為Department 類型的組合主鍵的DepartmentID 和 Name 屬性。

modelBuilder.Entity<Department>().HasKey(t =>?new?{ t.DepartmentID, t.Name });

?

關(guān)閉數(shù)值主鍵的標(biāo)識

以下示例將DepartmentID 屬性設(shè)置為System.ComponentModel.DataAnnotations.DatabaseGeneratedOption.None，以指示該值不由數(shù)據(jù)庫生成。

modelBuilder.Entity<Department>().Property(t =>t.DepartmentID).HasDatabaseGeneratedOption(DatabaseGeneratedOption.None);

?

指定屬性的最大長度

在以下示例中，Name屬性不應(yīng)超過 50 個字符。如果其值超過 50 個字符，則出現(xiàn) DbEntityValidationException 異常。如果 Code First 基于此模型創(chuàng)建數(shù)據(jù)庫，它還會將 Name 列的最大長度設(shè)置為50 個字符。

modelBuilder.Entity<Department>().Property(t =>t.Name).HasMaxLength(50);

將屬性配置為必需

在下面的示例中，Name屬性是必需的。如果不指定 Name，則出現(xiàn) DbEntityValidationException 異常。如果 Code First 基于此模型創(chuàng)建數(shù)據(jù)庫，則用于存儲此屬性的列將不可為空。

modelBuilder.Entity<Department>().Property(t =>t.Name).IsRequired();

?

指定不將CLR 屬性映射到數(shù)據(jù)庫中的列

以下示例顯示如何指定CLR 類型的屬性不映射到數(shù)據(jù)庫中的列。

modelBuilder.Entity<Department>().Ignore(t => t.Budget);

?

將CLR 屬性映射到數(shù)據(jù)庫中的特定列

以下示例將Name CLR 屬性映射到DepartmentName 數(shù)據(jù)庫列。

modelBuilder.Entity<Department>().Property(t =>t.Name).HasColumnName("DepartmentName");

重命名模型中未定義的外鍵

如果您選擇不對CLR 類型定義外鍵，但希望指定它在數(shù)據(jù)庫中應(yīng)使用的名稱，請編碼如下：

modelBuilder.Entity<Course>()

??????? .HasRequired(c => c.Department)

??????? .WithMany(t => t.Courses)

??????? .Map(m => m.MapKey("ChangedDepartmentID"));

配置字符串屬性是否支持Unicode 內(nèi)容

默認情況下，字符串為Unicode(SQLServer 中的nvarchar)。您可以使用IsUnicode 方法指定字符串應(yīng)為varchar 類型。

modelBuilder.Entity<Department>()

??????? .Property(t => t.Name)

??????? .IsUnicode(false);

配置數(shù)據(jù)庫列的數(shù)據(jù)類型

HasColumnType 方法支持映射到相同基本類型的不同表示。使用此方法并不支持在運行時執(zhí)行任何數(shù)據(jù)轉(zhuǎn)換。請注意，IsUnicode 是將列設(shè)置為 varchar 的首選方法，因為它與數(shù)據(jù)庫無關(guān)。

modelBuilder.Entity<Department>()

??????? .Property(p => p.Name)

??????? .HasColumnType("varchar");

配置復(fù)雜類型的屬性

對復(fù)雜類型配置標(biāo)量屬性有兩種方法。

可以對ComplexTypeConfiguration 調(diào)用Property。

modelBuilder.ComplexType<Details>()

??????? .Property(t => t.Location)

??? ????.HasMaxLength(20);

也可以使用點表示法訪問復(fù)雜類型的屬性。

modelBuilder.Entity<OnsiteCourse>()

??????? .Property(t => t.Details.Location)

??????? .HasMaxLength(20);

將屬性配置為用作樂觀并發(fā)令牌

要指定實體中的某個屬性表示并發(fā)令牌，可使用 ConcurrencyCheck 特性或 IsConcurrencyToken 方法。

modelBuilder.Entity<OfficeAssignment>()

??????? .Property(t => t.Timestamp)

??????? .IsConcurrencyToken();

也可以使用IsRowVersion 方法將屬性配置為數(shù)據(jù)庫中的行版本。將屬性設(shè)置為行版本會自動將它配置為樂觀并發(fā)令牌。

modelBuilder.Entity<OfficeAssignment>()

??????? .Property(t => t.Timestamp)

??????? .IsRowVersion();

類型映射

將類指定為復(fù)雜類型

按約定，沒有指定主鍵的類型將被視為復(fù)雜類型。在一些情況下，Code First 不會檢測復(fù)雜類型(例如，如果您有名為“ID”的屬性，但不想將它用作主鍵)。在此類情況下，您將使用 Fluent API 顯式指定某類型是復(fù)雜類型。

modelBuilder.ComplexType<Details>();

指定不將CLR 實體類型映射到數(shù)據(jù)庫中的表

以下示例顯示如何排除一個 CLR 類型，使之不映射到數(shù)據(jù)庫中的表。

modelBuilder.Ignore<OnlineCourse>();

將CLR 實體類型映射到數(shù)據(jù)庫中的特定表

Department 的所有屬性都將映射到名為 t_ Department 的表中的列。

modelBuilder.Entity<Department>().ToTable("t_Department");

您也可以這樣指定架構(gòu)名稱：

modelBuilder.Entity<Department>().ToTable("t_Department",?"school");

?

映射“每個層次結(jié)構(gòu)一張表(TPH)”繼承

在 TPH 映射情形下，繼承層次結(jié)構(gòu)中的所有類型都將映射到同一個表。鑒別器列用于標(biāo)識每行的類型。使用 Code First 創(chuàng)建模型時，TPH 參與繼承層次結(jié)構(gòu)的類型所用的默認策略。默認情況下，鑒別器列將添加到名為“Discriminator”的表，且層次結(jié)構(gòu)中每個類型的 CLR 類型名稱都將用作鑒別器值。可以使用 Fluent API 修改默認行為。

modelBuilder.Entity<Course>()

??????? .Map<Course>(m=> m.Requires("Type").HasValue("Course"))

??????? .Map<OnsiteCourse>(m=> m.Requires("Type").HasValue("OnsiteCourse"));

映射“每個類型一張表(TPT)”繼承

在 TPT 映射情形下，所有類型分別映射到不同的表。僅屬于某個基類型或派生類型的屬性存儲在映射到該類型的一個表中。映射到派生類型的表還會存儲一個將派生表與基表聯(lián)接的外鍵。

modelBuilder.Entity<Course>().ToTable("Course");

modelBuilder.Entity<OnsiteCourse>().ToTable("OnsiteCourse");

映射“每個具體類一張表(TPC)”繼承

在 TPC 映射情形下，層次結(jié)構(gòu)中的所有非抽象類型分別映射到不同的表。映射到派生類的表與映射到數(shù)據(jù)庫中基類的表并無關(guān)系。類的所有屬性(包括繼承屬性)都將映射到相應(yīng)表的列。

調(diào)用MapInheritedProperties 方法來配置每個派生類型。MapInheritedProperties 將繼承自基類的所有屬性重新映射到派生類的表中的新列。

注意：因為屬于TPC 繼承層次結(jié)構(gòu)的表并不使用同一個主鍵，因此，如果您讓數(shù)據(jù)庫生成的值具有相同標(biāo)識種子，則在映射到子類的表中執(zhí)行插入操作時，會產(chǎn)生重復(fù)的實體鍵。要解決此問題，可以為每個表指定不同的初始種子值，或關(guān)閉主鍵屬性的標(biāo)識。當(dāng)使用 Code First 時，標(biāo)識就是整數(shù)鍵屬性的默認值。

modelBuilder.Entity<Course>()

? .Property(c => c.CourseID)

? .HasDatabaseGeneratedOption(DatabaseGeneratedOption.None);

modelBuilder.Entity<OnsiteCourse>().Map(m =>

{

? m.MapInheritedProperties();

? m.ToTable("OnsiteCourse");

});

modelBuilder.Entity<OnlineCourse>().Map(m =>

{

? m.MapInheritedProperties();

? m.ToTable("OnlineCourse");

});

將實體類型的CLR 屬性映射到數(shù)據(jù)庫中的多個表(實體拆分)

實體拆分允許一個實體類型的屬性分散在多個表中。在以下示例中，Department 實體拆分到兩個表中：Department 和DepartmentDetails。實體拆分通過多次調(diào)用 Map 方法將一部分屬性映射到特定表。

modelBuilder.Entity<Department>()

.Map(m=>

{

? m.Properties(t =>?new{ t.DepartmentID, t.Name });

? m.ToTable("Department");

})

.Map(m=>

{

??m.Properties(t=>?new?{ t.DepartmentID, t.Administrator,t.StartDate, t.Budget });

? m.ToTable("DepartmentDetails");

?});

將多個實體類型映射到數(shù)據(jù)庫中的一個表(表拆分)

以下示例將使用同一個主鍵的兩個實體類型映射到同一個表。

modelBuilder.Entity<OfficeAssignment>()

? .HasKey(t => t.InstructorID);

modelBuilder.Entity<Instructor>()

??? .HasRequired(t => t.OfficeAssignment)

??? .WithRequiredPrincipal(t =>t.Instructor);

modelBuilder.Entity<Instructor>().ToTable("Instructor");

modelBuilder.Entity<OfficeAssignment>().ToTable("Instructor");

使用FluentAPI配置關(guān)系

簡介

使用FluentAPI配置關(guān)系的時候，首先要獲得一個EntityTypeConfiguration實例，然后使用其上的HasRequired, HasOptional或者 HasMany方法來指定當(dāng)前實體參與的關(guān)系類型。HasRequired 和HasOptional方法需要一個lambda表達式來指定一個導(dǎo)航屬性，HasMany方法需要一個lambda表達式指定一個集合導(dǎo)航屬性。然后可以使用WithRequired, WithOptional和WithMany方法來指定反向?qū)Ш綄傩?#xff0c;這些方法有不帶參數(shù)的重載用來指定單向?qū)Ш健?/p>

之后還可以使用HasForeignKey方法來指定外鍵屬性。

配置【必須-可選】關(guān)系(1-0..1)

OfficeAssignment的鍵屬性不符合命名約定，所以需要我們顯式指定。下面的關(guān)系表明，OfficeAssignment的Instructor必須存在，但是Instructor的OfficeAssignment不是必須存在的。

modelBuilder.Entity<OfficeAssignment>()

? .HasKey(t => t.InstructorID);

// Map one-to-zero or one relationship

modelBuilder.Entity<OfficeAssignment>()

? .HasRequired(t => t.Instructor)

? .WithOptional(t => t.OfficeAssignment);

配置兩端都是必須的關(guān)系(1-1)

大多數(shù)情況下，EF都能推斷哪一個類型是依賴項或者是主體項。然而當(dāng)關(guān)系的兩端都是必須的或者都是可選的，那么EF就不能識別依賴項或者是主體項。如果關(guān)系兩端都是必須的，那么在HasRequired方法后使用WithRequiredPrincipal或者WithRequiredDependent來確定主體。如果關(guān)系兩端都是可選的，那么在HasRequired方法后使用WithOptionalPrincipal和WithOptionalDependent。

modelBuilder.Entity<OfficeAssignment>()

? .HasKey(t => t.InstructorID);

modelBuilder.Entity<Instructor>()

? .HasRequired(t => t.OfficeAssignment)

? .WithRequiredPrincipal(t => t.Instructor);

?

配置多對多關(guān)系

下面的代碼配置了一個多對多關(guān)系，CodeFirst會使用命名約定來創(chuàng)建連接表，命名約定會使用Course_CourseID 和 Instructor_InstructorID作為連接表的列。

modelBuilder.Entity<Course>()

??????? .HasMany(t => t.Instructors)

??????? .WithMany(t => t.Courses);

如果想指定連接表的表名和列名，需要使用Map方法，如下：

modelBuilder.Entity<Course>()

??????? .HasMany(t => t.Instructors)

??????? .WithMany(t => t.Courses)

??????? .Map(m =>

??????? {

????????? m.ToTable("CourseInstructor");

????????? m.MapLeftKey("CourseID");

????????? m.MapRightKey("InstructorID");

??????? });

?

配置單向?qū)Ш綄?/h2>

所謂單向?qū)Ш綄傩灾傅氖侵辉陉P(guān)系的一端定義了導(dǎo)航屬性。按照約定，CodeFirst將單向?qū)Ш嚼斫鉃橐粚Χ嚓P(guān)系，如果需要一對一的單向?qū)Ш綄傩?#xff0c;需要使用如下方法：

modelBuilder.Entity<OfficeAssignment>()

? .HasKey(t => t.InstructorID);

modelBuilder.Entity<Instructor>()

? .HasRequired(t => t.OfficeAssignment)

? .WithRequiredPrincipal();

啟用級聯(lián)刪除

使用WillCascadeOnDelete方法來配置關(guān)系是否允許級聯(lián)刪除。如果外鍵是不可空的，CodeFirst默認會設(shè)置級聯(lián)刪除；否則，不會設(shè)置級聯(lián)刪除，當(dāng)主體被刪除后，外鍵將會被置空。

可以使用如下代碼移除此約定：

modelBuilder.Conventions.Remove<OneToManyCascadeDeleteConvention>();

modelBuilder.Conventions.Remove<ManyToManyCascadeDeleteConvention>();

下面的代碼片段配置為外鍵不能為空，而且禁用了級聯(lián)刪除。

modelBuilder.Entity<Course>()

? .HasRequired(t => t.Department)

? .WithMany(t => t.Courses)

? .HasForeignKey(d => d.DepartmentID)

? .WillCascadeOnDelete(false);

配置組合外鍵

下面的代碼配置了組合外鍵

modelBuilder.Entity<Department>()

? .HasKey(d =>?new{ d.DepartmentID, d.Name });

// Composite foreign key

modelBuilder.Entity<Course>()

??? .HasRequired(c => c.Department)

??? .WithMany(d => d.Courses)

??? .HasForeignKey(d =>?new?{ d.DepartmentID, d.DepartmentName });

?

配置不符合命名約定的外鍵屬性

SomeDepartmentID屬性不符合外鍵命名約定，需要使用如下方法將其設(shè)置為外鍵屬性：

modelBuilder.Entity<Course>()

???????? .HasRequired(c => c.Department)

???????? .WithMany(d => d.Courses)

???????? .HasForeignKey(c =>c.SomeDepartmentID);

定義DbSet

DbContext 使用DbSet 屬性

Code First 示例中顯示的常見情況是讓 DbContext 為模型實體類型使用公共自動 DbSet 屬性。例如：

publicclass?BloggingContext:?DbContext

{

??public?DbSet<Blog>Blogs {?get;?set;}

??public?DbSet<Post>Posts {?get;?set;}

}

在 CodeFirst 模式下使用時，這會將 Unicorn、Princess、LadyInWaiting 和Castle 配置為實體類型，也將配置可從這些類型訪問的其他類型。此外，DbContext 還將自動對其中每個屬性調(diào)用 setter 以設(shè)置相應(yīng) DbSet 的實例。

DbContext 使用IDbSet 屬性

在創(chuàng)建 mock或 fake 等情況下，更適合使用接口來聲明 set 屬性。在這些情況下，可使用 IDbSet 接口替代 DbSet。例如：

publicclass?BloggingContext:?DbContext

{

??public?IDbSet<Blog>Blogs {?get;?set;}

??public?IDbSet<Post>Posts {?get;?set;}

}

此上下文的工作方式與對其 set 屬性使用DbSet 類的上下文完全相同。

DbContext 使用只讀set 屬性

如果不希望為DbSet 或 IDbSet 屬性公開公共 setter，可以改為創(chuàng)建只讀屬性并自建 set 實例。例如：

publicclass?BloggingContext:?DbContext

{

??public?DbSet<Blog>Blogs

? {

????get?{?return?Set<Blog>();}

? }

??public?DbSet<Post>Posts

? {

????get?{?return?Set<Post>();}

? }

}

請注意，DbContext將緩存從 Set 方法返回的 DbSet 實例，以便每次調(diào)用其中每個屬性時都返回同一實例。

搜索 CodeFirst 實體類型的工作方式與搜索具有公共 getter 和setter 的屬性相同。

DbContext使用注意事項

·?????????隨著越來越多的對象和他們的引用進入內(nèi)存，DbContext的內(nèi)存消耗可能會迅速增長，這將會引起性能問題。

·?????????當(dāng)不再使用context對象的時候，一定要釋放它。

·?????????如果一個異常使得context進入了一個不可恢復(fù)的狀態(tài)，整個應(yīng)用可能會終止。

·?????????長時間使用的context會增加并發(fā)沖突的可能。

DbSet使用注意事項

DbSet總是針對數(shù)據(jù)庫執(zhí)行查詢，即使要查詢的數(shù)據(jù)已經(jīng)在上下文中，下面幾種情況下會執(zhí)行數(shù)據(jù)庫查詢。

·?????????執(zhí)行foreach

·?????????調(diào)用ToArray, ToDictionary, ToList.

·?????????在最外層查詢調(diào)用LINQ操作符First，Any等等。

·?????????DbSet的擴展方法Load，DbEntityEntry.Reload，Database.ExecuteSqlCommand.

當(dāng)數(shù)據(jù)庫返回查詢結(jié)果的時候，如果結(jié)果集中的對象在context中不存在，那么就會將對象attach到上下文中。如果對象已經(jīng)存在(根據(jù)id來判斷)，那么就會返回在上下文中已經(jīng)存在的對象，數(shù)據(jù)庫的值不會覆蓋當(dāng)前對象database values。在這種情況下，如果我們長時間持有DbContext，那么我們在每次查詢的時候得到就很有可能不是最新版本的對象。

在執(zhí)行一個查詢的時候，上下文中新添加但是還沒有保存的對象不會作為查詢結(jié)果返回，如果想訪問這些對象，需要訪問Local屬性。下面是關(guān)于local屬性的備注

1.????????Local屬性不只是包含新添加的對象，它包含所有已經(jīng)加載到context中的對象。

2.????????Local屬性不包含那些已經(jīng)被Remove的對象(上下文中remove了，但是還在數(shù)據(jù)庫中)

3.????????查詢結(jié)果永遠反應(yīng)數(shù)據(jù)庫的真實數(shù)據(jù)，在上下文中被Remove了但是還沒有在數(shù)據(jù)庫刪除的對象，仍然可以查詢到。DbContext.ChangeTracker屬性提供了DbChangeTracker的實例，該實例的Entries屬性返回一個DbEntityEntry集合，可以找到所有當(dāng)前上下文中跟蹤的實體及其狀態(tài)信息。

有時候在查詢大量實體并只進行只讀操作的時候，實體跟蹤是沒有任何意義的，禁用實體跟蹤會提高查詢性能，可以AsNoTracking方法來禁用實體跟蹤，例如：

using(var?context =?newBloggingContext())

{

??// Query for allblogs without tracking them

??var?blogs1 =context.Blogs.AsNoTracking();

??// Query for someblogs without tracking them

??var?blogs2 =context.Blogs

????????????????????? .Where(b =>b.Name.Contains(".NET"))

????????????????????? .AsNoTracking()

????????????????????? .ToList();

}

根據(jù)主鍵查找實體

DbSet.Find方法會根據(jù)主鍵來查找被上下文跟蹤的實體。如果上下文中不存在此對象，那么將會對數(shù)據(jù)庫進行查詢來查找實體，如果沒有找到實體，則返回null。Find方法可以查詢到剛剛添加到上下文但是還沒有被保存到數(shù)據(jù)庫的實體，這與LINQ查詢不同。

使用 Find 方法時必須考慮：

1.????????如果對象沒有在緩存中，則 Find 沒有優(yōu)勢，但語法仍比按鍵進行查詢簡單。

2.????????如果啟用自動檢測更改，則根據(jù)模型的復(fù)雜性以及對象緩存中的實體數(shù)量，Find 方法的成本可能會增加一個數(shù)量級，甚至更多。

此外，請注意Find 僅返回要查找的實體，它不會自動加載未在對象緩存中的關(guān)聯(lián)實體。如果需要檢索關(guān)聯(lián)實體，可通過預(yù)先加載使用按鍵查詢。

創(chuàng)建和修改關(guān)系

對于擁有外鍵屬性的關(guān)系，修改關(guān)系是非常簡單的，如下：

course.DepartmentID =newCourse.DepartmentID;

下面的代碼通過將外鍵設(shè)置為 null 刪除了關(guān)系。請注意，外鍵屬性必須可以為 Null。

course.DepartmentID = null;

注意：如果引用處于已添加狀態(tài)(在本例中為 course 對象)，在調(diào)用 SaveChanges 之前，引用導(dǎo)航屬性將不與新對象的鍵值同步。由于對象上下文在鍵值保存前不包含已添加對象的永久鍵，因此不發(fā)生同步。

通過將一個新對象分配給導(dǎo)航屬性。下面的代碼在 course 和department 之間創(chuàng)建關(guān)系。如果對象附加到上下文，course 也會添加到 department.Courses 集合中，course 對象的相應(yīng)的外鍵屬性設(shè)置為 department 的鍵屬性值。

course.Department =department;

要刪除該關(guān)系，請將導(dǎo)航屬性設(shè)置為 null。如果使用的是基于 .NET 4.0 的實體框架，則需要先加載相關(guān)端，然后再將其設(shè)置為 Null。例如：

context.Entry(course).Reference(c=> c.Department).Load();

course.Department = null;

從實體框架5.0(它基于 .NET 4.5)開始，不必加載相關(guān)端就可以將關(guān)系設(shè)置為 Null。也可以使用以下方法將當(dāng)前值設(shè)置為 Null。

context.Entry(course).Reference(c=> c.Department).CurrentValue = null;

通過在實體集合中刪除或添加對象。例如，可以將 Course 類型的對象添加到 department.Courses 集合中。此操作將在特定 course 和特定 department 之間創(chuàng)建關(guān)系。如果對象附加到上下文，course 對象的 department 引用和外鍵屬性將設(shè)置為相應(yīng)的 department。

department.Courses.Add(newCourse);

此處，如果course的departmentid不能為空，則可能會出現(xiàn)錯誤，對department.Courses集合不能有刪除course的操作，否則會出現(xiàn)錯誤。因為如果從集合中移除了course，在SaveChanges過程中把該過程識別為更新關(guān)系，而那些被刪除的course的departmentid又不能為空，所以save不會成功。

通過使用 ChangeRelationshipState方法更改兩個實體對象間指定關(guān)系的狀態(tài)。此方法是處理 N 層應(yīng)用程序和獨立關(guān)聯(lián) 時最常用的方法(不能用于外鍵關(guān)聯(lián))。此外，要使用此方法，必須下拉到 ObjectContext，如下例所示。

在下面的示例中，Instructor和 Course 之間存在多對多關(guān)系。調(diào)用 ChangeRelationshipState 方法并傳遞 EntityState.Added 參數(shù)，使 SchoolContext 知道在這兩個對象間添加了關(guān)系。

?????? ((IObjectContextAdapter)context).ObjectContext.ObjectStateManager.

?????????????????ChangeRelationshipState(course, instructor, c => c.Instructor,EntityState.Added);??

請注意，如果是更新(而不僅是添加)關(guān)系，添加新關(guān)系后必須刪除舊關(guān)系：

??????((IObjectContextAdapter)context).ObjectContext. ObjectStateManager.

?????????????????ChangeRelationshipState(course, oldInstructor, c => c.Instructor,EntityState.Deleted);???

同步FK 和導(dǎo)航屬性之間的更改

使用上述方法中的一種更改附加到上下文的對象的關(guān)系時，實體框架需要保持外鍵、引用和集合同步。實體框架使用代理自動管理 POCO 實體的這種同步(也稱為關(guān)系修復(fù))。

如果不通過代理使用POCO 實體，則必須確保調(diào)用 DetectChanges 方法同步上下文中的相關(guān)對象。請注意，下面的 API 會自動觸發(fā) DetectChanges 調(diào)用。

·?????????DbSet.Add

·?????????DbSet.Find

·?????????DbSet.Remove

·?????????DbSet.Local

·?????????DbContext.SaveChanges

·?????????DbSet.Attach

·?????????DbContext.GetValidationErrors

·?????????DbContext.Entry

·?????????DbChangeTracker.Entries

·?????????對 DbSet 執(zhí)行 LINQ 查詢

如果context中有很多實體，而且你正在多次調(diào)用上述方法，那么就會造成很大的性能影響。可以使用下面的代碼來的代碼禁用自動檢測：

using(var?context =?newBloggingContext())

{

??try

? {

???context.Configuration.AutoDetectChangesEnabled =?false;

????// Make manycalls in a loop

????foreach?(var?blog?inaLotOfBlogs)

??? {

????? context.Blogs.Add(blog);

??? }

? }

??finally

? {

???context.Configuration.AutoDetectChangesEnabled =?true;

? }

}

除了以上方法，還可以調(diào)用context.ChangeTracker.DetectChanges方法來顯式檢測變化。需要小心使用這些高級方法，否則很容易在你的程序里引入微妙的bug。

加載相關(guān)對象

預(yù)加載(EagerlyLoading)

預(yù)加載表示在查詢某類實體時一起加載相關(guān)實體，這是使用Include方法完成的，如下：

using(var?context =?newBloggingContext())

{

??// Load all blogsand related posts

??var?blogs1 =context.Blogs

.Include(b=> b.Posts)

.ToList();

??// Load one blogsand its related posts

??var?blog1 =context.Blogs

.Where(b=> b.Name ==?"ADO.NET Blog")

.Include(b=> b.Posts)

.FirstOrDefault();

??// Load all blogsand related posts

??// using a stringto specify the relationship

??var?blogs2 =context.Blogs

??????????????????????? .Include("Posts")

??????????????????????? .ToList();

??// Load one blogand its related posts

??// using a stringto specify the relationship

??var?blog2 =context.Blogs

????????????????????? .Where(b => b.Name ==?"ADO.NET Blog")

????????????????????? .Include("Posts")

????????????????????? .FirstOrDefault();

}

注意：Include方法是一個擴展方法，在System.Data.Entity命名空間下，確保引用了此命名空間。

多級預(yù)加載

下面的代碼顯示了如何加載多級實體。

using(var?context =?newBloggingContext())

{

??// Load all blogs,all related posts, and all related comments

??var?blogs1 =context.Blogs

???????????????????? .Include(b =>b.Posts.Select(p => p.Comments))

???????????????????? .ToList();

??// Load all userstheir related profiles, and related avatar

??var?users1 =context.Users

????????????????????? .Include(u =>u.Profile.Avatar)

????????????????????? .ToList();

??// Load all blogs,all related posts, and all related comments

??// using a stringto specify the relationships

??var?blogs2 =context.Blogs

???????????????????? .Include("Posts.Comments")

???????????????????? .ToList();

??// Load all userstheir related profiles, and related avatar

??// using a stringto specify the relationships

??var?users2 =context.Users

????????????????????? .Include("Profile.Avatar")

????????????????????? .ToList();

}

當(dāng)前不支持在關(guān)聯(lián)實體上進行查詢，Include方法總是加載所有關(guān)聯(lián)實體。

惰性加載

惰性加載指的是當(dāng)?shù)谝辉L問導(dǎo)航屬性的時候自動從數(shù)據(jù)庫加載相關(guān)實體。這種特性是由代理類實現(xiàn)的，代理類派生自實體類，并重寫了導(dǎo)航屬性。所以我們的實體類的導(dǎo)航屬性就必須標(biāo)記為virtual，如下：

publicclass?Blog

{

??public?int?ID {?get;?set; }

??public?string?Title {?get;?set; }

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

}

可以對指定實體關(guān)閉惰性加載，如下：

publicclass?Blog

{

??public?int?ID {?get;?set; }

??public?string?Title {?get;?set; }

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

}

也可以對所有實體關(guān)閉惰性加載，如下：

publicclass?BloggingContext:?DbContext

{

??publicBloggingContext()

? {

????this.Configuration.LazyLoadingEnabled=?false;

? }

}

顯式加載

即使關(guān)閉了惰性加載，我們?nèi)匀豢梢酝ㄟ^顯式調(diào)用來延遲加載相關(guān)實體，這是通過調(diào)用DbEntityEntry上的相關(guān)方法做到的，如下：

using(var?context =?newBloggingContext())

{

??var?post =context.Posts.Find(2);

??// Load the blogrelated to a given post

? context.Entry(post).Reference(p => p.Blog).Load();

??// Load the blogrelated to a given post using a string

? context.Entry(post).Reference("Blog").Load();

??var?blog =context.Blogs.Find(1);

??// Load the postsrelated to a given blog

? context.Entry(blog).Collection(p =>p.Posts).Load();

??// Load the postsrelated to a given blog

??// using a stringto specify the relationship

? context.Entry(blog).Collection("Posts").Load();

}

注意：在外鍵關(guān)聯(lián)中，加載依賴對象的相關(guān)端時，將根據(jù)內(nèi)存中當(dāng)前的相關(guān)外鍵值加載相關(guān)對象：

// Get thecourse where currently DepartmentID = 1.

Course course2 =context.Courses.First(c=>c.DepartmentID == 2);

?// UseDepartmentID foreign key property

// to change theassociation.

course2.DepartmentID = 3;

?// Load therelated Department where DepartmentID = 3

context.Entry(course).Reference(c=> c.Department).Load();

在獨立關(guān)聯(lián)中，基于當(dāng)前數(shù)據(jù)庫中的外鍵值查詢依賴對象的相關(guān)端。不過，如果修改了關(guān)系，并且依賴對象的引用屬性指向?qū)ο笊舷挛闹屑虞d的不同主對象，實體框架將嘗試創(chuàng)建關(guān)系，就像它在客戶端定義的那樣。

Query方法提供了在加載相關(guān)實體的時候應(yīng)用過濾條件的功能，引用導(dǎo)航屬和集合導(dǎo)航屬性都支持Query方法，但是大部分情況下都會針對集合導(dǎo)航屬性使用Query方法，達到只加載部分相關(guān)實體的功能，如下：

using(var?context =?newBloggingContext())

{

??var?blog =context.Blogs.Find(1);

??// Load the postswith the 'entity-framework' tag related to a given blog

? context.Entry(blog)

????? .Collection(b => b.Posts)

????? .Query()

????? .Where(p => p.Title.Contains("entity-framework"))

????? .Load();

??// Load the postswith the 'entity-framework' tag related to a given blog

??// using a stringto specify the relationship

? context.Entry(blog)

????? .Collection("Posts")

????? .Query()

????? .Cast<Post>()

????? .Where(p => p.Title.Contains("entity-framework"))

????? .Load();

}

注意，使用顯式加載的時候，最好關(guān)閉惰性加載，避免引起混亂。Load方法是一個擴展方法，記得引用命名空間System.Data.Entity.DbExtensions

使用Query查詢相關(guān)實體個數(shù)，而不用加載相關(guān)實體，如下：

using(var?context =?newBloggingContext())

{

??var?blog =context.Blogs.Find(1);

??// Count how manyposts the blog has

??var?postCount= context.Entry(blog)

??????????????????????? .Collection(b =>b.Posts)

??????????????????????? .Query()

???????????? ???????????.Count();

}

使用代理

為 POCO 實體類型創(chuàng)建實例時，實體框架常常為充當(dāng)實體代理的動態(tài)生成的派生類型創(chuàng)建實例。此代理重寫實體的某些虛擬屬性，這樣可在訪問屬性時插入掛鉤，從而自動執(zhí)行操作。例如，此機制用于支持關(guān)系的延遲加載。

禁止創(chuàng)建代理

有時需要禁止實體框架創(chuàng)建代理實例。例如，人們通常認為序列化非代理實例要比序列化代理實例容易得多。可通過清除 ProxyCreationEnabled 標(biāo)記來關(guān)閉代理創(chuàng)建功能。上下文的構(gòu)造函數(shù)便是可執(zhí)行此操作的一個位置。例如：

publicclass?BloggingContext:?DbContext

{

??publicBloggingContext()

? {

????this.Configuration.ProxyCreationEnabled=?false;

? }

??public?DbSet<Blog>Blogs {?get;?set;}

??public?DbSet<Post>Posts {?get;?set;}

}

請注意，在無需代理執(zhí)行任何操作的情況下，EF 不會為類型創(chuàng)建代理。這意味著，也可以通過使用封裝和/或沒有虛擬屬性的類型，避免生成代理。

添加新實體

使用DbSet.Add方法添加實體

using(var?context =?newBloggingContext())

{

??var?blog =?new?Blog?{ Name =?"ADO.NET Blog"?};

? context.Blogs.Add(blog);

? context.SaveChanges();

}

修改Entry的State來添加實體

using(var?context =?newBloggingContext())

{

??var?blog =?new?Blog?{ Name =?"ADO.NET Blog"?};

? context.Entry(blog).State =EntityState.Added;

? context.SaveChanges();

}

設(shè)置導(dǎo)航屬性來添加實體

using(var?context =?newBloggingContext())

{

??// Add a new Userby setting a reference from a tracked Blog

??var?blog =context.Blogs.Find(1);

? blog.Owner =?newUser { UserName =?"johndoe1987"?};

??// Add a new Postby adding to the collection of a tracked Blog

??var?blog =context.Blogs.Find(2);

? blog.Posts.Add(newPost?{ Name =?"Howto Add Entities"?});

? context.SaveChanges();

}

所有被添加到上下文中的實體的引用實體，如果沒有被跟蹤，就會被當(dāng)作新實體添加到上下文中，并在調(diào)用SaveChanges方法后被保存到數(shù)據(jù)庫。

附加實體到上下文

如果實體在數(shù)據(jù)庫中存在，但是沒有被上下文跟蹤，可是使用DbSet.Attach方法將其附加到上下文，附加之后，實體處于Unchanged狀態(tài)。處于Unchanged狀態(tài)的實體不會參與SaveChanges的邏輯。

varexistingBlog =?new?Blog{ BlogId = 1, Name =?"ADO.NET Blog"};

using(var?context =?newBloggingContext())

{

? context.Blogs.Attach(existingBlog);

??// Do some morework...

? context.SaveChanges();

}

設(shè)置DbEntityEntry對象的State屬性，也可以附加對象到上下文中，如下：

varexistingBlog =?new?Blog{ BlogId = 1, Name =?"ADO.NET Blog"};

using(var?context =?newBloggingContext())

{

? context.Entry(existingBlog).State =EntityState.Unchanged;

??// Do some morework...

? context.SaveChanges();

}

使用上述兩種方法附加到上下文的實體如果還引用其他實體，那么這些實體也會被附加到上下文中，狀態(tài)為Unchanged

使用如下方法附加一個存在于數(shù)據(jù)庫，但是還沒有附加到上下文的已修改實體：

varexistingBlog =?new?Blog{ BlogId = 1, Name =?"ADO.NET Blog"};

using(var?context =?newBloggingContext())

{

? context.Entry(existingBlog).State =EntityState.Modified;

??// Do some morework...

? context.SaveChanges();

}

如果把一個實體的狀態(tài)置為Modified，那么該實體的所有屬性都將被標(biāo)記為已更改狀態(tài)，當(dāng)SaveChanges被調(diào)用時，所有的屬性值都將被保存到數(shù)據(jù)庫。如果不想保存所有值，可以單獨為每個想要修改的屬性設(shè)置IsModified屬性，如下：

using(var?context =?newBloggingContext())

{

????var?blog =context.Blogs.Find(1);

??? context.Entry(blog).Property(u =>u.Name).IsModified =?true;

????// Use a stringfor the property name

??? context.Entry(blog).Property("Name").IsModified =?true;

}

如果該實體還引用其他未被跟蹤實體，那么這些實體將會作為Unchanged狀態(tài)的實體附加到上下文。如果想修改這些實體，只能單獨把每個引用實體設(shè)置為修改狀態(tài)。

樂觀并發(fā)模式

在嘗試保存使用外鍵關(guān)聯(lián)的實體期間，如果檢測到樂觀并發(fā)異常，SaveChanges 將引發(fā) DbUpdateConcurrencyException。DbUpdateConcurrencyException的 Entries 方法為無法更新的實體返回 DbEntityEntry 實例。

使用DbContext執(zhí)行原始SQL

使用SqlQuery方法執(zhí)行SQL查詢

using(var?context =?newBloggingContext())

{

??var?blogs =context.Blogs.SqlQuery("SELECT * FROMdbo.Blogs").ToList();

}

執(zhí)行存儲過程查詢

using(var?context =?newBloggingContext())

{

??var?blogs =context.Blogs.SqlQuery("dbo.GetBlogs").ToList();

}

為存儲過程傳遞參數(shù)

using(var?context =?newBloggingContext())

{

??var?blogId =1;

??var?blogs =context.Blogs.SqlQuery("dbo.GetBlogById@p0", blogId).Single();

}

查詢非實體類型

using(var?context =?newBloggingContext())

{

??var?blogNames= context.Database.SqlQuery<string>(

?????????????????????"SELECTName FROM dbo.Blogs").ToList();

}

返回是的對象將不會被跟蹤，即使返回類型是實體類型。

執(zhí)行SQL命令

using(var?context =?newBloggingContext())

{

? context.Database.SqlCommand(

??????"UPDATEdbo.Blogs SET Name = 'Another Name' WHERE BlogId = 1");

}

http://blog.csdn.net/gentle_wolf/article/details/14004345

總結(jié)

以上是生活随笔為你收集整理的Entity Framework 5.0 Code First全面学习的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。