Entityframework Migrations

DogTwo發表於2018-12-29
Framework

　　EF相關的內容園子裡已經有很多很好的文章了，這篇只是把自己之前的一些整理搬運到這裡，拋磚引玉，溫故知新。

Migrations確實是個好東西，至少就升級維護Database方面，幫助筆者脫離苦海。另一個專案中開發階段忽視了DB升級的處理方面的問題，導致每次專案上線都很難去處理DB。因為只有最新版本的Script,如果表結構沒有變化還好一點，如果表結構有變動幾乎沒辦法處理。甚至很難比對出上一次release版本的db和最新的db之間的區別。
利用Migrations，我們可以記錄每次db的變動，甚至可以將初始化的資料處理成一個單獨的Migrations用於Restore DB. 對於某些基於特定版本的問題,也可以輕鬆的將DB還原到出現問題的環境。
正文:
既可以利用Entity去生成Migrations，也可以通過工具利用現有的db去生成Migrations.
準備工作(具體怎麼安裝，容我再研究一下):

（目前最新版本應該是2.2，參見園子裡的這篇文章）
Entity Framework Core .NET Command Line Tools 2.0.0-rtm-26452

  • Microsoft.EntityFrameworkCore.SqlServer 2.0.3
  • Microsoft.EntityFrameworkCore.Tools 2.0.3
  • Microsoft.EntityFrameworkCore.Design 2.0.3

DotNetCliToolReference:

Microsoft.EntityFrameworkCore.Tools.DotNet 2.0.0

以Code First由Entity生成Migrations為例(筆者使用的是Abp,具體使用時整合的類與介面可能會有出入)

1 public class Area : FullAuditedEntity, IMustHaveTenant
2 {
3     public virtual string Name { get; set; }
4     public virtual string Remark { get; set; }
5     public virtual string IndexTitle { get; set; }
6     public int TenantId { get; set; }
7 }

 

此處由於整合自FullAuditedEntity類，會自動的為Area的Entity新增自增的Id,以及類似與CreationTime等統計相關的欄位.
Entity建好之後，需要在xxxDbContext中宣告一下你的Entity.
public virtual DbSet

Area { get; set; }
此處有兩個作用

生成Migrations時確保識別出這個Entity
允許使用Repository

與dotnet命令類似，dotnet ef的相關命令都可以使用 –help來檢視具體用法.
我們使用dotnet ef migrations add AddArea命令來為剛剛建立的Entity生成Migrations.
這個命令會新增兩個新的檔案，分別是對應的Migrations檔案和Designer檔案.另外這個命令會修改x`x`xDbContextModelSnapshot.cs 檔案.暫時我們只需要關注Migrations檔案
例如

 1 public partial class addIndexTitle : Migration
 2 {
 3     protected override void Up(MigrationBuilder migrationBuilder)
 4     {
 5         migrationBuilder.AddColumn(
 6             name: "IndexTitle",
 7             table: "Component",
 8             nullable: true);
 9 
10         migrationBuilder.AddColumn(
11             name: "IndexTitle",
12             table: "Area",
13             nullable: true);
14     }
15

 
16 　　protected override void Down(MigrationBuilder migrationBuilder)
17 　　{
18 　　　　migrationBuilder.DropColumn(
19 　　　　　　name: "IndexTitle",
20 　　　　　　table: "Component");
21 
22 　　　　migrationBuilder.DropColumn(
23 　　　　　　name: "IndexTitle",
24 　　　　　　table: "Area");
25 　　}
26 }

 

（此處只是舉例說明，並非實際由Area實體生成的Migration）
可以看到兩個方法Up和Down,這兩個方法就是你在升級或降級db時會去執行的方法。
當然你也可以不寫實體，直接生成一個空的Migration檔案來初始化資料等.如

public partial class InitialDB: Migration
{
　　protected override void Up(MigrationBuilder migrationBuilder)
　　{
　　　　var sql = “Insert into ....”
　　　　migrationBuilder.sql(sql);
　　}

　　protected override void Down(MigrationBuilder migrationBuilder)
　　{

　　}
}

 

如果你不需要或者是想刪除這個Migration 使用命令
dotnet ef migrations remove
這個命令會依次倒敘移除你的Migration，前提是這個Migrations沒有更新到DB中.
成功生成Migration後需要把Migration的改動升級到DB中，此時需要執行命令
dotnet ef database update
這個命令如果不新增任何引數，無論你的DB當前處於哪個Migration，都會更新到最新的Migration.
如果你在update後新增 某一個Migration的名字作為引數，DB將更新至指定的Migration(可以降級DB)
當然以上所有工作的前提都是你要連線到某一個真實存在的DB,連線的方式不再贅述了.
此外，如果是某些特定環境,你不能或很難去執行上面的命令來更新DB.
這時你可以將Migrator檔案Publish出來，作為一個單獨的專案去執行，當然你要修改對應的config檔案來確保你的配置正確。
之後更新DB時你只需要在這個Migrator包的路徑下cmd中執行
dotnet XXXX.Migrator.dll (具體名字未定，並非一定是Migrator)來更新DB.

相關文章