Code First 約定
借助 CodeFirst,可通過使用 C# 或Visual Basic .NET 類來描述模型。模型的基本形狀可通過約定來檢測。約定是規則集,用于在使用 Code First 時基于類定義自動配置概念模型。約定是在 System.Data.Entity.ModelConfiguration.Conventions 命名空間中定義的。
可通過使用資料注釋或Fluent API 進一步配置模型。優先級是通過 Fluent API 進行配置,然後是通過資料注釋,再次是通過約定。
API 文檔中提供了 Code First 約定的詳細清單。本主題概述 Code First 使用的約定。
當使用 CodeFirst 開發時,通常是從編寫用來定義概念(域)模型的 .NET類開始。除了定義類之外,還需要讓 DbContext 知道模型中要包含哪些類。為此,需要定義一個上下文類,此類派生自 DbContext 并公開需要成為模型一部分的類型的 DbSet 屬性。Code First 将包含這些類型,還将包含任何引用類型,即使這些引用類型是在不同的程式集中定義的也是如此。
如果類型存在于繼承層次結構中,則為基類定義 DbSet 屬性就足夠了,如果派生類型位于與基類相同的程式集中,則自動包含這些派生類型。
在下面的示例中,僅對SchoolEntities 類定義一個DbSet 屬性 (Departments)。CodeFirst 使用此屬性來發現并包含任何引用類型。
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
public int CourseID { get; set; }
public string Title { get; set; }
public int Credits { get; set; }
// Foreign key
// 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”(不區分大小寫)或類名的後面跟有“ID”,則 Code First 會推斷該屬性是主鍵。如果主鍵屬性的類型為數值或 GUID,則将其配置為辨別列。
實體架構中的導航屬性提供了一種在兩個實體類型之間導航關系的方法。針對對象參與到其中的每個關系,各對象均可以具有導航屬性。使用導航屬性,可以在兩個方向上導航和管理關系,傳回引用對象(如果多重性為一或者零或一)或集合(如果多重性為多)。Code First 根據針對類型定義的導航屬性來推斷關系。
除導航屬性外,建議還要包括表示依賴對象的類型的外鍵屬性。任何資料類型與主體主鍵屬性相同、遵循以下一種格式的屬性都表示關系的外鍵:“<導航屬性名稱><主體主鍵屬性>”、“<主體類名><主鍵屬性名稱>”或“<主體主鍵屬性名稱>”。如果找到多個比對項,則優先級符合上面列出的順序。外鍵檢測不區分大小寫。在檢測外鍵屬性時,Code First 基于外鍵的可空性推斷關系的多重性。如果屬性可以為 Null,則将關系注冊為可選關系;否則,将關系注冊為必需關系。
如果依賴實體上的外鍵不能為 Null,則 CodeFirst 對關系設定級聯删除。如果依賴實體上的外鍵可以為 Null,則Code First 不對關系設定級聯删除,并且在删除主體時,會将該外鍵設定為 Null。通過使用 Fluent API,可以覆寫由約定檢測的多重性和級聯删除行為。
在下面的示例中,導航屬性和外鍵用于定義 Department 類與Course 類之間的關系。
注意:如果相同類型間有多個關系(例如,假設定義 Person 和Book 類,其中,Person 包含ReviewedBooks 和AuthoredBooks 導航屬性,而Book 類包含 Author 和Reviewer 導航屬性),則需要使用資料注釋或 Fluent API 手動配置關系。
當 CodeFirst 發現無法推斷主鍵以及未通過資料注釋或 Fluent API 注冊主鍵的類時,類型會自動注冊為複雜類型。複雜類型檢測還要求類型不具有引用實體類型的屬性,并且未被其他類型的集合屬性引用。對于以下類定義,Code First 推斷Details 是複雜類型,因為它沒有主鍵。
publicOnsiteCourse()
{
Details = newDetails();
}
public Details Details { get;set; }
publicclass Details
如果您還沒有在應用程式中進行任何其他配置,則對 DbContext 調用無參數構造函數将會導緻 DbContext 使用按約定建立的資料庫連接配接在 Code First 模式下運作。例如:
namespaceDemo.EF
public class BloggingContext: DbContext
publicBloggingContext()
// C# will callbase class parameterless constructor by default
{
}
在此示例中,DbContext使用派生上下文類 Demo.EF.BloggingContext 的命名空間限定名稱作為資料庫名稱,并使用 SQL Express 或 LocalDb 為此資料庫建立連接配接字元串。如果同時安裝了這兩個資料庫,将使用 SQL Express。
預設情況下,VisualStudio 2010 包含 SQLExpress,VisualStudio 2012 包含LocalDb。安裝期間,EntityFrameworkNuGet 包會檢查哪個資料庫伺服器可用。随後 NuGet 包将設定按約定建立連接配接時 Code First 所使用的預設資料庫伺服器,以此更新配置檔案。如果 SQL Express 正在運作,将使用它。如果 SQL Express 不可用,則 LocalDb 将注冊為預設資料庫。如果配置檔案已包含預設連接配接工廠設定,則不會更改該檔案。
如果您尚未在應用程式中進行任何其他配置,在通過要使用的資料庫名稱對 DbContext 調用字元串構造函數時,将會導緻 DbContext 使用按約定建立的與該名稱資料庫的連接配接在 Code First 模式下運作。例如:
public BloggingContext()
: base("BloggingDatabase")
在此示例中,DbContext使用“BloggingDatabase”作為資料庫名稱,并使用 SQL Express(随Visual Studio 2010 安裝)或LocalDb(随Visual Studio 2012 安裝)為此資料庫建立連接配接字元串。如果同時安裝了這兩個資料庫,将使用 SQL Express。
可以選擇将連接配接字元串放入 app.config 或web.config 檔案中。例如:
<configuration>
<connectionStrings>
<addname="BloggingCompactDatabase"
providerName="System.Data.SqlServerCe.4.0"
connectionString="Data Source=Blogging.sdf"/>
</connectionStrings>
</configuration>
這是一種訓示 DbContext 使用資料庫伺服器而非 SQL Express 或LocalDb 的簡單方法 — 上例指定了 SQL Server Compact Edition 資料庫。
如果連接配接字元串的名稱與上下文的名稱(帶或不帶命名空間限定)相同,則使用無參數構造函數時 DbContext 會找到該連接配接字元串。如果連接配接字元串名稱與上下文名稱不同,則可通過将連接配接字元串名稱傳遞給 DbContext 構造函數,訓示 DbContext 在 CodeFirst 模式下使用此連接配接。例如:
publicclass BloggingContext: DbContext
publicBloggingContext()
: base("BloggingCompactDatabase")
或者,也可以對傳遞給DbContext 構造函數的字元串使用 “name=<連接配接字元串名稱>”格式。例如:
: base("name=BloggingCompactDatabase")
使用此形式可以明确要求在配置檔案中查找連接配接字元串。如果未找到具有給定名稱的連接配接字元串,則将引發異常。
資料庫建立是由政策來控制的,有如下四種政策:
1. CreateDatabaseIfNotExists:這是預設的政策。如果資料庫不存在,那麼就建立資料庫。但是如果資料庫存在了,而且實體發生了變化,就會出現異常。
2. DropCreateDatabaseIfModelChanges:此政策表明,如果模型變化了,資料庫就會被重新建立,原來的資料庫被删除掉了。
3. DropCreateDatabaseAlways:此政策表示,每次運作程式都會重新建立資料庫,這在開發和調試的時候非常有用。
4. 自定制資料庫政策:可以自己實作IDatabaseInitializer來建立自己的政策。或者從已有的實作了IDatabaseInitializer接口的類派生。
如下示例顯示了如何應用資料庫建立政策:
public class UserManContext : DbContext
public UserManContext()
: base("USMDBConnectionString")
{
Database.SetInitializer<UserManContext>(new CreateDatabaseIfNotExists<UserManContext>());
}
下面的代碼建立了一個自定義政策,什麼也沒有做,但是我們可以在Seed方法裡添加我們的種子資料。
public class USMDBInitializer : DropCreateDatabaseAlways<UserManContext>
protected override void Seed(UserManContext context)
base.Seed(context);
雖然EF提供了在配置檔案中配置政策的方法,如下所示:
<appSettings>
value="System.Data.Entity.DropCreateDatabaseAlways`1[[EFCodeFirstSample.UserManContext,EFCodeFirstSample]], EntityFramework" />
</appSettings>
Key必須以DatabaseInitializerForType開始,後邊加空格,之後是context類的全名稱,包括帶命名空間的類名和所在的程式集名。Value是政策的全名稱。可以看見key和value都非常難讀,還不如自己寫配置來的好。
如果不想使用政策,就可以關閉政策,特别是預設政策。關閉政策的代碼如下:
Database.SetInitializer<UserManContext>(null);
還可以在配置檔案中關閉政策,如下:
<addkey="DatabaseInitializerForTypeEFCodeFirstSample.UserManContext, EFCodeFirstSample"
value="Disabled" />
上面提高可以在自定義資料庫初始化政策中添加種子資料,下面的示例說明如何添加種子資料:
User admin = new User();
admin.Name = "admin";
admin.DisplayName = "Administrator";
admin.Status = 1;
admin.LastModDate= DateTime.Now;
context.Users.Add(admin);
需要注意的是日期字段,資料庫中的日期範圍小于.NET中的日期範圍,是以必須給一個合适的值,像DateTime.MinValue這樣的值無法存儲到資料庫中。可以參考SqlDateTime類型來确定Sql資料庫支援的時間範圍。
可以移除在System.Data.Entity.ModelConfiguration.Conventions 命名空間中定義的任何約定。下面的示例移除 PluralizingTableNameConvention。
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 進行開發。
通過實體架構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 BloggerName { get;set; }
public virtual ICollection<Post> Posts { get;set; }
publicclass Post
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。
[Key]
public int PrimaryTrackingKey { get;set; }
如果您在使用Code First 的資料庫生成功能,則Blog 表将具有名為 PrimaryTrackingKey 的主鍵列,該列預設情況下還定義為 Identity。
Required 注釋告訴 EF 某一個特定屬性是必需的。
在 Title 屬性中添加 Required 将強制 EF(和 MVC)確定該屬性中包含資料。
[Required]
publicstring Title { get;set; }
Required 特性将使被映射的屬性不可為空來影響生成的資料庫。請注意,Title 字段已經更改為“not null”。
使用MaxLength 和MinLength 特性,您可以就像對Required 那樣指定其他屬性驗證。
下面是具有長度要求的BloggerName。該示例也說明如何組合特性。
[MaxLength(10), MinLength(5)]
publicstring BloggerName { get;set; }
MaxLength 注釋将通過把屬性長度設定為 10 來影響資料庫。MinLength屬性不會對資料庫産生影響。
Code First 約定訓示具有受支援資料類型的每個屬性都要在資料庫中有表示。但在您的應用程式中并不總是如此。例如,您可以在 Blog 類中使用一個屬性來基于 Title 和BloggerName 字段建立代碼。該屬性可以動态建立,無需存儲。您可以使用 NotMapped 注釋來标記不映射到資料庫的所有屬性,如下面的 BlogCode 屬性。
[NotMapped]
publicstring BlogCode
get
returnTitle.Substring(0, 1) + ":" +BloggerName.Substring(0, 1);
跨一組類描述域實體,然後将這些類分層以描述一個完整實體的情況并不少見。例如,您可以向模型中添加一個名為 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]
現在,您可以在Blog 類中添加一個屬性來表示該部落格的 BlogDetails。
public BlogDetails BlogDetail { get; set; }
在資料庫中,Blog表将包含該部落格的所有屬性,包括在其 BlogDetail 屬性中所含的屬性。預設情況下,每個屬性都将添加複雜類型名稱字首 BlogDetail。
另外,有趣的是,雖然DateCreated 屬性在類中定義為不可為空的 DateTime,但相關資料庫字段是可為空的。如果想影響資料庫架構,則必須使用 Required 注釋。
ConcurrencyCheck 注釋可用于标記要在使用者編輯或删除實體時用于在資料庫中進行并發檢查的一個或多個屬性。如果之前使用 EF 設計器,則這等同于将屬性的 ConcurrencyMode 設定為 Fixed。
現在讓我們将ConcurrencyCheck 添加到BloggerName 屬性,看看它如何工作。
[ConcurrencyCheck, MaxLength(10),MinLength(5)]
調用SaveChanges 時,因為BloggerName 字段上具有ConcurrencyCheck 注釋,是以在更新中将使用該屬性的初始值。該指令将嘗試通過同時依據鍵值和 BloggerName 的初始值進行篩選來查找正确的行。下面是發送到資料庫的 UPDATE 指令的關鍵部分,在其中您可以看到該指令将更新 PrimaryTrackingKey 為 1 且BloggerName 為“Julie”(這是從資料庫中檢索到該部落格時的初始值)的行。
where (([PrimaryTrackingKey]= @4) and([BloggerName] = @5))
@4=1,@5=N'Julie'
如果在此期間有人更改了該部落格的部落客姓名,則此更新将失敗,并引發 DbUpdateConcurrencyException 并且需要處理該異常。
使用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")]
Column 注釋更适于用來指定被映射列的特性。您可以規定名稱、資料類型甚至列出現在表中的順序。下面是 Column 特性的示例。
[Column("BlogDescription",TypeName = "ntext")]
publicString Description { get; set; }
下面是重新生成後的表。表名稱已更改為 InternalBlogs,複雜類型的 Description 列現在是BlogDescription。因為該名稱在注釋中指定,Code First 不會使用以複雜類型名稱作為列名開頭的約定。
一個重要的資料庫功能是可以使用計算屬性。如果您将 Code First 類映射到包含計算列的表,則您可能不想讓實體架構嘗試更新這些列。但是在插入或更新資料後,您的确需要 EF 從資料庫中傳回這些值。您可以使用 DatabaseGenerated 注釋與 Computed 枚舉一起在您的類中标注這些屬性。其他枚舉為 None 和Identity。
[DatabaseGenerated(DatabaseGeneratedOption.Computed)]
publicDateTime DateCreated { get; set; }
當 Code First生成資料庫時,您可以對 byte 或timestamp 列使用此标記,否則您隻應該在指向現有資料庫時使用,因為 Code First 将不能确定計算列的公式。
您閱讀過以上内容,知道預設情況下,整數鍵屬性将成為資料庫中的辨別鍵。這與将 DatabaseGenerated 設定為 DatabaseGenerationOption.Identity 是一樣的。如果不希望它成為辨別鍵,則可以将該值設定為 DatabaseGenerationOption.None。
Code First 約定将在您的模型中處理最常用的關系,但是在某些情況下它需要幫助。
在 Blog 類中更改鍵屬性的名稱造成它與 Post 的關系出現問題。
生成資料庫時,CodeFirst 會在 Post 類中看到 BlogId 屬性并識别出該屬性,按照約定,它與類名加“Id”比對,并作為 Blog 類的外鍵。但是在此Blog 類中沒有 BlogId 屬性。解決方法是,在 Post 中建立一個導航屬性,并使用 Foreign DataAnnotation 來幫助 CodeFirst 了解如何在兩個類之間建立關系(那就是使用 Post.BlogId 屬性)以及如何在資料庫中指定限制。
[ForeignKey("BlogId")]
public Blog Blog { get; set; }
資料庫中的限制顯示InternalBlogs.PrimaryTrackingKey 與Posts.BlogId 之間的關系。
類之間存在多個關系時,将使用 InverseProperty。
在 Post 類中,您可能需要跟蹤是誰撰寫了部落格文章以及誰編輯了它。下面是 Post 類的兩個新的導航屬性。
publicPerson CreatedBy { get;set; }
publicPerson UpdatedBy { get;set; }
您還需要在這些屬性引用的 Person 類中添加内容。Person類具有傳回到 Post 的導航屬性,一個屬性指向該使用者撰寫的所有文章,一個屬性指向該使用者更新的所有文章。
publicclass Person
public List<Post>PostsWritten { get; set;}
public List<Post>PostsUpdated { get; set;}
Code First 不能自行使這兩個類中的屬性比對。Posts 的資料庫表應該有一個表示 CreatedBy 人員的外鍵,有一個表示 UpdatedBy 人員的外鍵,但是 Code First 将建立四個外鍵屬性:Person_Id、Person_Id1、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。
通常通過重寫派生DbContext 上的OnModelCreating 方法來通路Code First Fluent API。以下示例旨在顯示如何使用 Fluent API 執行各種任務,您可以将代碼複制出來并進行自定義,使之适用于您的模型。
Property 方法用于為每個屬于實體或複雜類型的屬性配置特性。Property 方法用于擷取給定屬性的配置對象。配置對象上的選項特定于要配置的類型;例如,IsUnicode 隻能用于字元串屬性。
要顯式将某個屬性設定為主鍵,可使用 HasKey 方法。在以下示例中,使用了 HasKey 方法對 OfficeAssignment 類型配置 InstructorID 主鍵。
modelBuilder.Entity<OfficeAssignment>().HasKey(t =>t.InstructorID);
以下示例配置要作為Department 類型的組合主鍵的DepartmentID 和 Name 屬性。
modelBuilder.Entity<Department>().HasKey(t => new { t.DepartmentID, t.Name });
以下示例将DepartmentID 屬性設定為System.ComponentModel.DataAnnotations.DatabaseGeneratedOption.None,以訓示該值不由資料庫生成。
modelBuilder.Entity<Department>().Property(t =>t.DepartmentID).HasDatabaseGeneratedOption(DatabaseGeneratedOption.None);
在以下示例中,Name屬性不應超過 50 個字元。如果其值超過 50 個字元,則出現 DbEntityValidationException 異常。如果 Code First 基于此模型建立資料庫,它還會将 Name 列的最大長度設定為50 個字元。
modelBuilder.Entity<Department>().Property(t =>t.Name).HasMaxLength(50);
在下面的示例中,Name屬性是必需的。如果不指定 Name,則出現 DbEntityValidationException 異常。如果 Code First 基于此模型建立資料庫,則用于存儲此屬性的列将不可為空。
modelBuilder.Entity<Department>().Property(t =>t.Name).IsRequired();
以下示例顯示如何指定CLR 類型的屬性不映射到資料庫中的列。
modelBuilder.Entity<Department>().Ignore(t => t.Budget);
以下示例将Name CLR 屬性映射到DepartmentName 資料庫列。
modelBuilder.Entity<Department>().Property(t =>t.Name).HasColumnName("DepartmentName");
如果您選擇不對CLR 類型定義外鍵,但希望指定它在資料庫中應使用的名稱,請編碼如下:
modelBuilder.Entity<Course>()
.HasRequired(c => c.Department)
.WithMany(t => t.Courses)
.Map(m => m.MapKey("ChangedDepartmentID"));
預設情況下,字元串為Unicode(SQLServer 中的nvarchar)。您可以使用IsUnicode 方法指定字元串應為varchar 類型。
modelBuilder.Entity<Department>()
.Property(t => t.Name)
.IsUnicode(false);
HasColumnType 方法支援映射到相同基本類型的不同表示。使用此方法并不支援在運作時執行任何資料轉換。請注意,IsUnicode 是将列設定為 varchar 的首選方法,因為它與資料庫無關。
.Property(p => p.Name)
.HasColumnType("varchar");
對複雜類型配置标量屬性有兩種方法。
可以對ComplexTypeConfiguration 調用Property。
modelBuilder.ComplexType<Details>()
.Property(t => t.Location)
.HasMaxLength(20);
也可以使用點表示法通路複雜類型的屬性。
modelBuilder.Entity<OnsiteCourse>()
.Property(t => t.Details.Location)
.HasMaxLength(20);
要指定實體中的某個屬性表示并發令牌,可使用 ConcurrencyCheck 特性或 IsConcurrencyToken 方法。
modelBuilder.Entity<OfficeAssignment>()
.Property(t => t.Timestamp)
.IsConcurrencyToken();
也可以使用IsRowVersion 方法将屬性配置為資料庫中的行版本。将屬性設定為行版本會自動将它配置為樂觀并發令牌。
.IsRowVersion();
按約定,沒有指定主鍵的類型将被視為複雜類型。在一些情況下,Code First 不會檢測複雜類型(例如,如果您有名為“ID”的屬性,但不想将它用作主鍵)。在此類情況下,您将使用 Fluent API 顯式指定某類型是複雜類型。
modelBuilder.ComplexType<Details>();
以下示例顯示如何排除一個 CLR 類型,使之不映射到資料庫中的表。
modelBuilder.Ignore<OnlineCourse>();
Department 的所有屬性都将映射到名為 t_ Department 的表中的列。
modelBuilder.Entity<Department>().ToTable("t_Department");
您也可以這樣指定架構名稱:
modelBuilder.Entity<Department>().ToTable("t_Department", "school");
在 TPH 映射情形下,繼承層次結構中的所有類型都将映射到同一個表。鑒别器列用于辨別每行的類型。使用 Code First 建立模型時,TPH 參與繼承層次結構的類型所用的預設政策。預設情況下,鑒别器列将添加到名為“Discriminator”的表,且層次結構中每個類型的 CLR 類型名稱都将用作鑒别器值。可以使用 Fluent API 修改預設行為。
.Map<Course>(m=> m.Requires("Type").HasValue("Course"))
.Map<OnsiteCourse>(m=> m.Requires("Type").HasValue("OnsiteCourse"));
在 TPT 映射情形下,所有類型分别映射到不同的表。僅屬于某個基類型或派生類型的屬性存儲在映射到該類型的一個表中。映射到派生類型的表還會存儲一個将派生表與基表聯接的外鍵。
modelBuilder.Entity<Course>().ToTable("Course");
modelBuilder.Entity<OnsiteCourse>().ToTable("OnsiteCourse");
在 TPC 映射情形下,層次結構中的所有非抽象類型分别映射到不同的表。映射到派生類的表與映射到資料庫中基類的表并無關系。類的所有屬性(包括繼承屬性)都将映射到相應表的列。
調用MapInheritedProperties 方法來配置每個派生類型。MapInheritedProperties 将繼承自基類的所有屬性重新映射到派生類的表中的新列。
注意:因為屬于TPC 繼承層次結構的表并不使用同一個主鍵,是以,如果您讓資料庫生成的值具有相同辨別種子,則在映射到子類的表中執行插入操作時,會産生重複的實體鍵。要解決此問題,可以為每個表指定不同的初始種子值,或關閉主鍵屬性的辨別。當使用 Code First 時,辨別就是整數鍵屬性的預設值。
.Property(c => c.CourseID)
.HasDatabaseGeneratedOption(DatabaseGeneratedOption.None);
modelBuilder.Entity<OnsiteCourse>().Map(m =>
m.MapInheritedProperties();
m.ToTable("OnsiteCourse");
});
modelBuilder.Entity<OnlineCourse>().Map(m =>
m.ToTable("OnlineCourse");
實體拆分允許一個實體類型的屬性分散在多個表中。在以下示例中,Department 實體拆分到兩個表中:Department 和DepartmentDetails。實體拆分通過多次調用 Map 方法将一部分屬性映射到特定表。
.Map(m=>
m.Properties(t => new{ t.DepartmentID, t.Name });
m.ToTable("Department");
})
m.Properties(t=> new { t.DepartmentID, t.Administrator,t.StartDate, t.Budget });
m.ToTable("DepartmentDetails");
});
以下示例将使用同一個主鍵的兩個實體類型映射到同一個表。
.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配置關系的時候,首先要獲得一個EntityTypeConfiguration執行個體,然後使用其上的HasRequired, HasOptional或者 HasMany方法來指定目前實體參與的關系類型。HasRequired 和HasOptional方法需要一個lambda表達式來指定一個導航屬性,HasMany方法需要一個lambda表達式指定一個集合導航屬性。然後可以使用WithRequired, WithOptional和WithMany方法來指定反向導航屬性,這些方法有不帶參數的重載用來指定單向導航。
之後還可以使用HasForeignKey方法來指定外鍵屬性。
OfficeAssignment的鍵屬性不符合命名約定,是以需要我們顯式指定。下面的關系表明,OfficeAssignment的Instructor必須存在,但是Instructor的OfficeAssignment不是必須存在的。
// Map one-to-zero or one relationship
.HasRequired(t => t.Instructor)
.WithOptional(t => t.OfficeAssignment);
大多數情況下,EF都能推斷哪一個類型是依賴項或者是主體項。然而當關系的兩端都是必須的或者都是可選的,那麼EF就不能識别依賴項或者是主體項。如果關系兩端都是必須的,那麼在HasRequired方法後使用WithRequiredPrincipal或者WithRequiredDependent來确定主體。如果關系兩端都是可選的,那麼在HasRequired方法後使用WithOptionalPrincipal和WithOptionalDependent。
.HasRequired(t => t.OfficeAssignment)
.WithRequiredPrincipal(t => t.Instructor);
下面的代碼配置了一個多對多關系,CodeFirst會使用命名約定來建立連接配接表,命名約定會使用Course_CourseID 和 Instructor_InstructorID作為連接配接表的列。
.HasMany(t => t.Instructors)
.WithMany(t => t.Courses);
如果想指定連接配接表的表名和列名,需要使用Map方法,如下:
.Map(m =>
{
m.ToTable("CourseInstructor");
m.MapLeftKey("CourseID");
m.MapRightKey("InstructorID");
});
所謂單向導航屬性指的是隻在關系的一端定義了導航屬性。按照約定,CodeFirst将單向導航了解為一對多關系,如果需要一對一的單向導航屬性,需要使用如下方法:
.WithRequiredPrincipal();
使用WillCascadeOnDelete方法來配置關系是否允許級聯删除。如果外鍵是不可空的,CodeFirst預設會設定級聯删除;否則,不會設定級聯删除,當主體被删除後,外鍵将會被置空。
可以使用如下代碼移除此約定:
modelBuilder.Conventions.Remove<OneToManyCascadeDeleteConvention>();
modelBuilder.Conventions.Remove<ManyToManyCascadeDeleteConvention>();
下面的代碼片段配置為外鍵不能為空,而且禁用了級聯删除。
.HasRequired(t => t.Department)
.WithMany(t => t.Courses)
.HasForeignKey(d => d.DepartmentID)
.WillCascadeOnDelete(false);
下面的代碼配置了組合外鍵
.HasKey(d => new{ d.DepartmentID, d.Name });
// Composite foreign key
.HasRequired(c => c.Department)
.WithMany(d => d.Courses)
.HasForeignKey(d => new { d.DepartmentID, d.DepartmentName });
SomeDepartmentID屬性不符合外鍵命名約定,需要使用如下方法将其設定為外鍵屬性:
.HasRequired(c => c.Department)
.WithMany(d => d.Courses)
.HasForeignKey(c =>c.SomeDepartmentID);
Code First 示例中顯示的常見情況是讓 DbContext 為模型實體類型使用公共自動 DbSet 屬性。例如:
public DbSet<Blog>Blogs { get; set;}
public DbSet<Post>Posts { get; set;}
在 CodeFirst 模式下使用時,這會将 Unicorn、Princess、LadyInWaiting 和Castle 配置為實體類型,也将配置可從這些類型通路的其他類型。此外,DbContext 還将自動對其中每個屬性調用 setter 以設定相應 DbSet 的執行個體。
在建立 mock或 fake 等情況下,更适合使用接口來聲明 set 屬性。在這些情況下,可使用 IDbSet 接口替代 DbSet。例如:
public IDbSet<Blog>Blogs { get; set;}
public IDbSet<Post>Posts { get; set;}
此上下文的工作方式與對其 set 屬性使用DbSet 類的上下文完全相同。
如果不希望為DbSet 或 IDbSet 屬性公開公共 setter,可以改為建立隻讀屬性并自建 set 執行個體。例如:
public DbSet<Blog>Blogs
get { return Set<Blog>();}
public DbSet<Post>Posts
get { return Set<Post>();}
請注意,DbContext将緩存從 Set 方法傳回的 DbSet 執行個體,以便每次調用其中每個屬性時都傳回同一執行個體。
搜尋 CodeFirst 實體類型的工作方式與搜尋具有公共 getter 和setter 的屬性相同。
· 随着越來越多的對象和他們的引用進入記憶體,DbContext的記憶體消耗可能會迅速增長,這将會引起性能問題。
· 當不再使用context對象的時候,一定要釋放它。
· 如果一個異常使得context進入了一個不可恢複的狀态,整個應用可能會終止。
· 長時間使用的context會增加并發沖突的可能。
DbSet總是針對資料庫執行查詢,即使要查詢的資料已經在上下文中,下面幾種情況下會執行資料庫查詢。
· 執行foreach
· 調用ToArray, ToDictionary, ToList.
· 在最外層查詢調用LINQ操作符First,Any等等。
· DbSet的擴充方法Load,DbEntityEntry.Reload,Database.ExecuteSqlCommand.
當資料庫傳回查詢結果的時候,如果結果集中的對象在context中不存在,那麼就會将對象attach到上下文中。如果對象已經存在(根據id來判斷),那麼就會傳回在上下文中已經存在的對象,資料庫的值不會覆寫目前對象database values。在這種情況下,如果我們長時間持有DbContext,那麼我們在每次查詢的時候得到就很有可能不是最新版本的對象。
在執行一個查詢的時候,上下文中新添加但是還沒有儲存的對象不會作為查詢結果傳回,如果想通路這些對象,需要通路Local屬性。下面是關于local屬性的備注
1. Local屬性不隻是包含新添加的對象,它包含所有已經加載到context中的對象。
2. Local屬性不包含那些已經被Remove的對象(上下文中remove了,但是還在資料庫中)
3. 查詢結果永遠反應資料庫的真實資料,在上下文中被Remove了但是還沒有在資料庫删除的對象,仍然可以查詢到。DbContext.ChangeTracker屬性提供了DbChangeTracker的執行個體,該執行個體的Entries屬性傳回一個DbEntityEntry集合,可以找到所有目前上下文中跟蹤的實體及其狀态資訊。
有時候在查詢大量實體并隻進行隻讀操作的時候,實體跟蹤是沒有任何意義的,禁用實體跟蹤會提高查詢性能,可以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();
DbSet.Find方法會根據主鍵來查找被上下文跟蹤的實體。如果上下文中不存在此對象,那麼将會對資料庫進行查詢來查找實體,如果沒有找到實體,則傳回null。Find方法可以查詢到剛剛添加到上下文但是還沒有被儲存到資料庫的實體,這與LINQ查詢不同。
使用 Find 方法時必須考慮:
1. 如果對象沒有在緩存中,則 Find 沒有優勢,但文法仍比按鍵進行查詢簡單。
2. 如果啟用自動檢測更改,則根據模型的複雜性以及對象緩存中的實體數量,Find 方法的成本可能會增加一個數量級,甚至更多。
此外,請注意Find 僅傳回要查找的實體,它不會自動加載未在對象緩存中的關聯實體。如果需要檢索關聯實體,可通過預先加載使用按鍵查詢。
對于擁有外鍵屬性的關系,修改關系是非常簡單的,如下:
course.DepartmentID =newCourse.DepartmentID;
下面的代碼通過将外鍵設定為 null 删除了關系。請注意,外鍵屬性必須可以為 Null。
course.DepartmentID = null;
注意:如果引用處于已添加狀态(在本例中為 course 對象),在調用 SaveChanges 之前,引用導航屬性将不與新對象的鍵值同步。由于對象上下文在鍵值儲存前不包含已添加對象的永久鍵,是以不發生同步。
通過将一個新對象配置設定給導航屬性。下面的代碼在 course 和department 之間建立關系。如果對象附加到上下文,course 也會添加到 department.Courses 集合中,course 對象的相應的外鍵屬性設定為 department 的鍵屬性值。
course.Department =department;
要删除該關系,請将導航屬性設定為 null。如果使用的是基于 .NET 4.0 的實體架構,則需要先加載相關端,然後再将其設定為 Null。例如:
context.Entry(course).Reference(c=> c.Department).Load();
course.Department = null;
從實體架構5.0(它基于 .NET 4.5)開始,不必加載相關端就可以将關系設定為 Null。也可以使用以下方法将目前值設定為 Null。
context.Entry(course).Reference(c=> c.Department).CurrentValue = null;
通過在實體集合中删除或添加對象。例如,可以将 Course 類型的對象添加到 department.Courses 集合中。此操作将在特定 course 和特定 department 之間建立關系。如果對象附加到上下文,course 對象的 department 引用和外鍵屬性将設定為相應的 department。
department.Courses.Add(newCourse);
此處,如果course的departmentid不能為空,則可能會出現錯誤,對department.Courses集合不能有删除course的操作,否則會出現錯誤。因為如果從集合中移除了course,在SaveChanges過程中把該過程識别為更新關系,而那些被删除的course的departmentid又不能為空,是以save不會成功。
通過使用 ChangeRelationshipState方法更改兩個實體對象間指定關系的狀态。此方法是處理 N 層應用程式和獨立關聯 時最常用的方法(不能用于外鍵關聯)。此外,要使用此方法,必須下拉到 ObjectContext,如下例所示。
在下面的示例中,Instructor和 Course 之間存在多對多關系。調用 ChangeRelationshipState 方法并傳遞 EntityState.Added 參數,使 SchoolContext 知道在這兩個對象間添加了關系。
((IObjectContextAdapter)context).ObjectContext.ObjectStateManager.
ChangeRelationshipState(course, instructor, c => c.Instructor,EntityState.Added);
請注意,如果是更新(而不僅是添加)關系,添加新關系後必須删除舊關系:
((IObjectContextAdapter)context).ObjectContext. ObjectStateManager.
ChangeRelationshipState(course, oldInstructor, c => c.Instructor,EntityState.Deleted);
使用上述方法中的一種更改附加到上下文的對象的關系時,實體架構需要保持外鍵、引用和集合同步。實體架構使用代理自動管理 POCO 實體的這種同步(也稱為關系修複)。
如果不通過代理使用POCO 實體,則必須確定調用 DetectChanges 方法同步上下文中的相關對象。請注意,下面的 API 會自動觸發 DetectChanges 調用。
· DbSet.Add
· DbSet.Find
· DbSet.Remove
· DbSet.Local
· DbContext.SaveChanges
· DbSet.Attach
· DbContext.GetValidationErrors
· DbContext.Entry
· DbChangeTracker.Entries
· 對 DbSet 執行 LINQ 查詢
如果context中有很多實體,而且你正在多次調用上述方法,那麼就會造成很大的性能影響。可以使用下面的代碼來的代碼禁用自動檢測:
try
context.Configuration.AutoDetectChangesEnabled = false;
// Make manycalls in a loop
foreach (var blog inaLotOfBlogs)
context.Blogs.Add(blog);
finally
context.Configuration.AutoDetectChangesEnabled = true;
除了以上方法,還可以調用context.ChangeTracker.DetectChanges方法來顯式檢測變化。需要小心使用這些進階方法,否則很容易在你的程式裡引入微妙的bug。
預加載表示在查詢某類實體時一起加載相關實體,這是使用Include方法完成的,如下:
// 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")
.FirstOrDefault();
// using a stringto specify the relationship
.Include("Posts")
.ToList();
// Load one blogand its related posts
var blog2 =context.Blogs
.Where(b => b.Name == "ADO.NET Blog")
.Include("Posts")
.FirstOrDefault();
注意:Include方法是一個擴充方法,在System.Data.Entity命名空間下,確定引用了此命名空間。
下面的代碼顯示了如何加載多級實體。
// Load all blogs,all related posts, and all related comments
.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)
// using a stringto specify the relationships
.Include("Posts.Comments")
var users2 =context.Users
.Include("Profile.Avatar")
目前不支援在關聯實體上進行查詢,Include方法總是加載所有關聯實體。
惰性加載指的是當第一通路導航屬性的時候自動從資料庫加載相關實體。這種特性是由代理類實作的,代理類派生自實體類,并重寫了導航屬性。是以我們的實體類的導航屬性就必須标記為virtual,如下:
public int ID { get; set; }
public virtual ICollection<Post>Posts { get; set;}
可以對指定實體關閉惰性加載,如下:
public ICollection<Post>Posts { get; set;}
也可以對所有實體關閉惰性加載,如下:
this.Configuration.LazyLoadingEnabled= false;
即使關閉了惰性加載,我們仍然可以通過顯式調用來延遲加載相關實體,這是通過調用DbEntityEntry上的相關方法做到的,如下:
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();
context.Entry(blog).Collection("Posts").Load();
注意:在外鍵關聯中,加載依賴對象的相關端時,将根據記憶體中目前的相關外鍵值加載相關對象:
// 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
在獨立關聯中,基于目前資料庫中的外鍵值查詢依賴對象的相關端。不過,如果修改了關系,并且依賴對象的引用屬性指向對象上下文中加載的不同主對象,實體架構将嘗試建立關系,就像它在用戶端定義的那樣。
Query方法提供了在加載相關實體的時候應用過濾條件的功能,引用導航屬和集合導航屬性都支援Query方法,但是大部分情況下都會針對集合導航屬性使用Query方法,達到隻加載部分相關實體的功能,如下:
// 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();
.Collection("Posts")
.Cast<Post>()
注意,使用顯式加載的時候,最好關閉惰性加載,避免引起混亂。Load方法是一個擴充方法,記得引用命名空間System.Data.Entity.DbExtensions
使用Query查詢相關實體個數,而不用加載相關實體,如下:
// Count how manyposts the blog has
var postCount= context.Entry(blog)
.Collection(b =>b.Posts)
.Query()
.Count();
為 POCO 實體類型建立執行個體時,實體架構常常為充當實體代理的動态生成的派生類型建立執行個體。此代理重寫實體的某些虛拟屬性,這樣可在通路屬性時插入挂鈎,進而自動執行操作。例如,此機制用于支援關系的延遲加載。
有時需要禁止實體架構建立代理執行個體。例如,人們通常認為序列化非代理執行個體要比序列化代理執行個體容易得多。可通過清除 ProxyCreationEnabled 标記來關閉代理建立功能。上下文的構造函數便是可執行此操作的一個位置。例如:
this.Configuration.ProxyCreationEnabled= false;
請注意,在無需代理執行任何操作的情況下,EF 不會為類型建立代理。這意味着,也可以通過使用封裝和/或沒有虛拟屬性的類型,避免生成代理。
使用DbSet.Add方法添加實體
var blog = new Blog { Name = "ADO.NET Blog" };
context.Blogs.Add(blog);
context.SaveChanges();
修改Entry的State來添加實體
context.Entry(blog).State =EntityState.Added;
設定導航屬性來添加實體
// Add a new Userby setting a reference from a tracked Blog
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" });
所有被添加到上下文中的實體的引用實體,如果沒有被跟蹤,就會被當作新實體添加到上下文中,并在調用SaveChanges方法後被儲存到資料庫。
如果實體在資料庫中存在,但是沒有被上下文跟蹤,可是使用DbSet.Attach方法将其附加到上下文,附加之後,實體處于Unchanged狀态。處于Unchanged狀态的實體不會參與SaveChanges的邏輯。
varexistingBlog = new Blog{ BlogId = 1, Name = "ADO.NET Blog"};
context.Blogs.Attach(existingBlog);
// Do some morework...
設定DbEntityEntry對象的State屬性,也可以附加對象到上下文中,如下:
context.Entry(existingBlog).State =EntityState.Unchanged;
使用上述兩種方法附加到上下文的實體如果還引用其他實體,那麼這些實體也會被附加到上下文中,狀态為Unchanged
使用如下方法附加一個存在于資料庫,但是還沒有附加到上下文的已修改實體:
context.Entry(existingBlog).State =EntityState.Modified;
如果把一個實體的狀态置為Modified,那麼該實體的所有屬性都将被标記為已更改狀态,當SaveChanges被調用時,所有的屬性值都将被儲存到資料庫。如果不想儲存所有值,可以單獨為每個想要修改的屬性設定IsModified屬性,如下:
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狀态的實體附加到上下文。如果想修改這些實體,隻能單獨把每個引用實體設定為修改狀态。
在嘗試儲存使用外鍵關聯的實體期間,如果檢測到樂觀并發異常,SaveChanges 将引發 DbUpdateConcurrencyException。DbUpdateConcurrencyException的 Entries 方法為無法更新的實體傳回 DbEntityEntry 執行個體。
使用SqlQuery方法執行SQL查詢
var blogs =context.Blogs.SqlQuery("SELECT * FROMdbo.Blogs").ToList();
執行存儲過程查詢
var blogs =context.Blogs.SqlQuery("dbo.GetBlogs").ToList();
為存儲過程傳遞參數
var blogId =1;
var blogs =context.Blogs.SqlQuery("dbo.GetBlogById@p0", blogId).Single();
查詢非實體類型
var blogNames= context.Database.SqlQuery<string>(
"SELECTName FROM dbo.Blogs").ToList();
傳回是的對象将不會被跟蹤,即使傳回類型是實體類型。
執行SQL指令
context.Database.SqlCommand(
"UPDATEdbo.Blogs SET Name = 'Another Name' WHERE BlogId = 1");
http://blog.csdn.net/gentle_wolf/article/details/14004345
本文轉自左正部落格園部落格,原文連結:http://www.cnblogs.com/soundcode/p/4773484.html,如需轉載請自行聯系原作者