efcore技巧貼-也許有你不知道的使用技巧
阿新 • • 發佈：2020-08-28
### 前言
.net 環境近些年也算是穩步發展。在開發的過程中，與資料庫打交道是必不可少的。早期的開發者都是DbHelper一擼到底，到現在的各種各樣的ORM框架大行其道。孰優孰劣誰也說不清楚，文無第一武無第二說的就是這個理。沒有什麼最好的，只有最適合你的。
本人也是從DbHelper開始，期間用過SugarSql，再到EFCODE。本著學習分享的初衷分享本人工作中總結的一些小技巧，希望能幫助更多開發者，期望能達到共同進步。文中若有錯誤地方，歡迎大家不吝賜教。
### 1. DbContext配置
在asp.net中，通常情況下，通過在Startup類的ConfigureServices方法中，將ef服務注入。
示例程式碼如下：
```
services.AddDbContext(opt=>opt.UseMySql("server=.;Database=demo;Uid=root;Pwd=123;Port=3306;"));
```
以上程式碼表示使用MySql資料庫。如果使用SqlServer資料庫，可以把UseMySql改為UseSqlServer，其他資料庫的使用方式也是通過呼叫不同的方法進行選擇。但需要安裝對應的擴充套件方法的程式包，如 Microsoft.EntityFrameworkCore.SqlServer 或 Microsoft.EntityFrameworkCore.Sqlite。
另外，UseMySql方法還包含了一個可空的Action型別的引數，可以通過此引數進行一些個性化的配置，比如配置重試機制。如下所示：
```
services.AddDbContext(opt => opt.UseMySql("server=.;Database=demo;Uid=root;Pwd=123456;Port=3306;",
provideropt => provideropt.EnableRetryOnFailure(3,TimeSpan.FromSeconds(10),new List(){0} )));
```
這個重試機制在某些場景下還是比較有用的。比如，由於網路波動或訪問量導致的一瞬間的連線超時。如果不設定重試機制，則會直接觸發異常，設定了超時後，則會根據設定的時間間隔以及重試次數進行重試。EnableRetryOnFailure方法的最後一個引數是用來設定錯誤程式碼的，只有設定了錯誤程式碼的錯誤，才會觸發重試。獲取錯誤程式碼的方法有很多種，個人比較推薦的是，通過異常資訊進行獲取，比如，使用MySql資料時，觸發的異常型別是MySqlException，此類的Number屬性的值EnableRetryOnFailure方法所需要的Number
### 2. DbContext執行緒問題
efcore不支援在同一個DbContext例項上執行多個並行操作,這包括非同步查詢的並行執行以及從多個執行緒進行的任何顯式併發使用。 因此，始終 await 非同步呼叫，或對並行執行的操作使用單獨的 DbContext 例項。
當 EF Core 檢測到並行操作或多個執行緒同時嘗試使用 DbContext 例項時，你將看到一條 InvalidOperationException，其中包含類似於下面的訊息：
```
A second operation started on this context before a previous operation completed. Any instance members are not guaranteed to be thread safe.
```
意思是，在上一個操作沒有執行完畢之前，又啟動了一個新的操作，所以不能保證執行緒是安全的。
下面是一段錯誤的，可以觸發這個異常的示例程式碼：
所以，請始終await非同步呼叫。如果在多個多個執行緒中使用DbContext，需保證每個執行緒的DbContext的例項是唯一的。
### 3. 資料庫使用連線池
使用 services.AddDbContextPool比使用 services.AddDbContext吞吐量提升在10~20的百分點（非官方說法，對效能提高資料是本人測試後得到的結果）。
需要注意的是，連線池大小並不是越大越好。
### 4. 日誌記錄
在使用ef時，基本上絕大多數和資料庫的互動都是通過linq實現的，然後ef將linq翻譯成對應的sql語句，在排查問題的時候，在開發或者排查問題時，往往需要關注最終執行的sql指令碼，所以就需要通過日誌的方式檢視。
在**efcore2.x**的版本預設是注入日誌服務，所以不需要額外的操作，就可以檢視對應的sql指令碼。但**efcore3.x**的版本預設移除了日誌服務，具體原因參照：https://docs.microsoft.com/zh-cn/ef/core/what-is-new/ef-core-3.0/breaking-changes#adddbc。
可通過自定義DbContext的方式注入日誌任務,示例程式碼如下：
```
public static readonly ILoggerFactory MyLoggerFactory
= LoggerFactory.Create(builder => { builder.AddConsole(); });
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
base.OnConfiguring(optionsBuilder);
optionsBuilder.UseLoggerFactory(MyLoggerFactory);
}
```
當執行ef程式碼時，可在控制檯中檢視相關的sql指令碼，如下圖所示：
### 5. 增
插入資料到資料庫常用的場景有：普通單表單行插入，多表級聯插入，批量插入。
普通單表單行插入比較簡單，例項程式碼如下：
```
var student = new Student {CreateTime = DateTime.Now, Name = "zjjjjjj"};
await _context.Students.AddAsync(student);
await _context.SaveChangesAsync();
```
多表級聯插入，需要在實體對映中配置屬性導航。
比如Blog表和Post是的關係是1對多的關係。則在Blog的實體中，定義一個型別為List的屬性。示例程式碼如下：
```
[Table("blog")]
public class Blog
{
[Column("id")]
public long Id { get; set; }
[Column("title")]
public string Title { get; set; }
public List Posts { get; set; }
[Column("create_date")]
public DateTime CreateDate { get; set; }
}
```
對應的插入語句如下所示：
```
var blog = new Blog
{
Title = "測試標題",
Posts = new List
{
new Post{Content = "評論1"},
new Post{Content = "評論2"},
new Post{Content = "評論3"},
}
};
await _context.Blog.AddAsync(blog);
await _context.SaveChangesAsync();
```
執行此程式碼，會生成如下的日誌：
從日誌中可以看出，通過這種方式實現了級聯插入的效果。
批量插入實現方式有兩種，一種是EF預設實現，適用於資料來源較少的情況。另一種，我們基於EF開發一個大資料量批量插入的服務，適合於資料來源大於1000的場景。在萬級及以上的資料量上，較EF預設的批量插入效能上有非常明顯的提升。具體參考：https://www.cnblogs.com/fulu/p/13370335.html
EF預設實現：
```
var list = new List();
for (int i = 0; i < num; i++)
{
list.Add(new Student { CreateTime = DateTime.Now, Name = "zjjjjjj" });
}
await _context.Students.AddRangeAsync(list);
await _context.SaveChangesAsync();
```
ISqlBulk實現：
```
var list = new List();
for (int i = 0; i < 100000; i++)
{
list.Add(new Student { CreateTime = DateTime.Now, Name = "zjjjjjj" });
}
await _bulk.InsertAsync(list);
```
自增 OR GUID
int自增的優點：
1、需要很小的資料儲存空間，僅僅需要4 byte 。
2、insert和update操作時使用INT的效能比GUID好，所以使用int將會提高應用程式的效能。
3、index和Join 操作，int的效能最好。
4、容易記憶。
int自增的缺點：
1、使用INT資料範圍有限制。如果存在大量的資料，可能會超出INT的取值範圍。
2、很難處理分散式儲存的資料表。
GUID做主鍵的優點：
1、唯一性。
2、適合大量資料中的插入和更新操作。
3、跨伺服器資料合併非常方便。
GUID做主鍵的缺點：
1、儲存空間大（16 byte），因此它將會佔用更多的磁碟大小。
2、很難記憶。join操作效能比int要低。
3、沒有內建的函式獲取最新產生的guid主鍵。
4、EF預設生成的GUID是無序的，會影響資料插入效能。
結論：
在資料量比較少的場景下，建議使用int自增，比如分類。對於大資料量，建議使用有序GUID。因為預設.net生成GUID是無序的，而資料庫中主鍵預設是聚集索引，而聚集索引在物理上的儲存是有序的，當插入資料時，如果插入的是無序的GUID,可能就會涉及到移動資料的情況，進而影響插入的效能，特別是百萬級資料量的時候，效能影響則較為明顯。參考資料：https://www.cnblogs.com/CameronWu/p/guids-as-fast-primary-keys-under-multiple-database.html
其他可選方案：
經過個人多番瞭解，目前市面上常用的分散式id生成演算法和Twitter釋出的雪花演算法大同小異，個人也在專案中使用過雪花演算法，有興趣的朋友可以在部落格園找下相關的內容。不過目前用.net封裝的雪花演算法普遍較基礎，很難在docker或者k8s環境下簡單的使用，所以在此預告下，本人根據雪花演算法編寫的可用於k8s環境的即將開源，敬請期待。
### 6. 查
EF使用Linq查詢資料庫中的資料，使用Linq可編寫強型別的查詢。當命令執行時，EF先將Linq表示式轉換成sql指令碼，然後再提交給資料庫執行。可在日誌中檢視生成的sql指令碼。
##### 根據條件查詢：
```
await _context.Blog.Where(x=>