asp.net core系列 29 EF模型配置(查詢型別,關係資料庫建模)
一.查詢型別
此功能是EF Core 2.1中的新功能。 EF Core除了實體型別之外,EF Core模型還可以包含查詢型別,這些查詢型別是針對“未對映到實體型別”的資料獲取。比如檢視,或只讀資料表。
1.1 下面介紹下,查詢型別與實體型別共同與不同點:
(1) 可以在OnModelCreating中或通過派生DbContext上的“set”屬性新增到EF Core模型中。
(2) 支援許多相同的對映功能,在關係資料庫上,如繼承對映和導航屬性。也可以配置目標資料庫物件和列通過 fluent API 方法或資料註釋。
但是,它們不同於實體中的型別:
(1) 不需要定義的鍵。
(2) 不會跟蹤DbContext上的更改,因此不會在資料庫中插入、更新或刪除。
(3) 永遠不會由約定發現。
(4) 僅支援一部分導航對映功能
它們可能永遠不會作為關係的主體端(沒有主體實體和依賴實體的關係)。
它們僅可包含指向的實體的引用導航屬性。
實體不能包含查詢型別的導航屬性。
(5) 在ModelBuilder上使用Query方法而不是Entity方法進行定址。
(6) 是否通過型別DbQuery<T>而不是DbSet<T>的屬性對映到DbContext上。
(7) 對映到使用的資料庫物件ToView方法,而非ToTable。
(8) 可以對映到定義查詢。定義查詢是在模型中宣告的輔助查詢,充當查詢型別的資料。
1.2 查詢型別使用方案(應用場景)
(1) 作為返回型別的即席FromSql()查詢。
(2) 對映到資料庫檢視。
(3) 對映到不具有定義的主鍵的表。
(4) 對映到模型中定義的查詢。
1.3 對映到資料庫物件
查詢型別對映到的資料庫物件,通過實現 ToView
的
fluent API 。 此ToView方法中指定的資料庫物件,從 EF Core 的角度來看是檢視,這意味著它將被視為只讀查詢源和不能作為目標的更新、插入或刪除操作(也可以將被視為只讀表)。 相反,對於實體型別,EF Core 假定資料庫物件中指定 ToTable
方法可以視為表或檢視、 意味著它可以用作查詢源,還可以做更新、 刪除和插入操作。
// 查詢型別的Blog ,引數: view or table. modelBuilder.Query<Blog>().ToView("xx"); // 實體型別的Blog引數: view or table。注意如果是檢視,更新資料,只能是一個表的檢視。 modelBuilder.Entity<Blog>().ToTable("xx");
1.4 案例
下面的示例演示如何使用查詢型別來查詢資料庫檢視。完整程式碼可檢視官方示例 (下面有連結 )。
(1)首先定義一個簡單的Blog和Post實體型別。
public class Blog { public int BlogId { get; set; } public string Name { get; set; } public string Url { get; set; } public ICollection<Post> Posts { get; set; } } public class Post { public int PostId { get; set; } public string Title { get; set; } public string Content { get; set; } public int BlogId { get; set; } }
(2) 使用BloggingContext上下文生成一個簡單的資料庫檢視,這樣就可以查詢與每個Blog的帖子(Posts)數
BloggingContext.Database.ExecuteSqlCommand( @"CREATE VIEW View_BlogPostCounts AS SELECT b.Name, Count(p.PostId) as PostCount FROM Blogs b JOIN Posts p on p.BlogId = b.BlogId GROUP BY b.Name");
(3) 接下來,我們定義一個查詢類來儲存資料庫檢視的結果
public class BlogPostsCount { public string BlogName { get; set; } public int PostCount { get; set; } }
(4) 我們配置中的查詢型別在OnModelCreating中使用 modelBuilder.Query<T>
API。 我們使用標準的 fluent 配置 Api 來配置查詢型別的對映:
protected override void OnModelCreating(ModelBuilder modelBuilder) { modelBuilder .Query<BlogPostsCount>().ToView("View_BlogPostCounts") .Property(v => v.BlogName).HasColumnName("Name"); }
(5) 最後,我們可以採用標準方式來查詢資料庫檢視:
var postCounts = BloggingContext.BlogPostCounts.ToList();
二. 關係資料庫建模
一般而言,本部分中的配置適用於關係資料庫。 安裝關係資料庫提供程式時,下面顯示的擴充套件方法將變為可用,原因在於共享Microsoft.EntityFrameworkCore.Relational 包
2.1 表對映
表對映是指(實體與資料表的對映)包括查詢的表資料,並將其儲存到資料庫中。
按照約定,每個實體都將對映到一個表,該表的名稱與 DbSet<TEntity>
在派生上下文中公開實體的屬性相同。例如在EF上下文中公開Blog型別,生成的表名與屬性名相同。
//生成Blogs表名 public DbSet<Blog> Blogs { get; set; }
//除了約定還可以使用資料註釋,表blogs與實體Blog對映 [Table("blogs")] public class Blog { public int BlogId { get; set; } public string Url { get; set; } } //還可以使用Fluent API 配置,功能實現與上面一樣 modelBuilder.Entity<Blog>().ToTable("blogs");
2.2 列對映
按照約定,實體中的每個屬性都會對映到表中,具有相同名稱的資料欄位。還可以使用資料註釋或Fluent API 配置:
public class Blog { //資料註釋將表Blog的blog_id欄位對映到BlogId屬性。 [Column("blog_id")] public int BlogId { get; set; } public string Url { get; set; } } //使用Fluent API配置,功能實現與上面一樣 modelBuilder.Entity<Blog>().Property(b => b.BlogId).HasColumnName("blog_id");
2.3 資料型別
資料型別是指:資料庫的資料型別與 CLR 屬性型別對映。可以使用資料註釋來指定精確的資料型別的列(一般用在code first模式)。
//資料註釋的案例 public class Blog { public int BlogId { get; set; } [Column(TypeName = "varchar(200)")] public string Url { get; set; } [Column(TypeName = "decimal(5, 2)")] public decimal Rating { get; set; } } //Fluent API配置,功能實現與上面一樣 modelBuilder.Entity<Blog>(eb => { eb.Property(b => b.Url).HasColumnType("varchar(200)"); eb.Property(b => b.Rating).HasColumnType("decimal(5, 2)"); });
2.4 主鍵
對於每個實體型別的鍵是引入了主鍵約束。按照約定,主鍵名稱是PK_<type name>,例如Posts 實體中有BlogId屬性,那表中主鍵約束名是PK_Posts。可以使用Fluent API配置資料庫中的主鍵約束的名稱。
//將預設的PK_Posts改為了PrimaryKey_BlogId主鍵約束名 modelBuilder.Entity<Blog>() .HasKey(b => b.BlogId) .HasName("PrimaryKey_BlogId");
2.5 預設架構
如果物件沒有顯式配置架構,則預設架構是建立物件的資料庫架構。按照約定,資料庫提供程式將選擇最合適的預設架構。例如,Microsoft SQL Server將使用該 dbo
模式。無法使用資料註釋設定預設架構,可以使用Fluent API指定預設架構。
-- 修改sqlserver 表預設架構 ALTER SCHEMA [blogging] TRANSFER dbo.Blogs -- 查詢表 select * from [blogging].Blogs
//設定ef core 對應資料庫表查詢的架構名 modelBuilder.HasDefaultSchema("blogging");
2.6 預設值
如果插入新行,但未指定列值,可設定一個預設值。不可以使用約定或資料註釋提供預設值。可以使用Fluent API 配置預設值.
//例如插入資料時,設定Created欄位取sqlserver的當前時間值。 modelBuilder.Entity<Blog>() .Property(b => b.Created) .HasDefaultValueSql("getdate()");
2.7 索引
關係資料庫中的索引對映到相同的概念的 EF core 中的索引。按照約定,索引名為 IX_<type name>_<property name>
,
對於複合索引,下劃線分隔的屬性名稱列表。可以使用Fluent API配置索引的名稱。
//設定url索引名稱為Index_Url modelBuilder.Entity<Blog>() .HasIndex(b => b.Url) .HasName("Index_Url"); //還可以指定索引過濾器 modelBuilder.Entity<Blog>() .HasIndex(b => b.Url) .HasFilter("[Url] IS NOT NULL");
參考文獻:
官方文件: EF查詢型別