Entityframework Migrations

　　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,具体使用时集成的类与接口可能会有出入)

public class Area : FullAuditedEntity, IMustHaveTenant
{
    public virtual string Name { get; set; }
    public virtual string Remark { get; set; }
    public virtual string IndexTitle { get; set; }
    public int TenantId { get; set; }
}

 

此处由于集成自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文件
例如

public partial class addIndexTitle : Migration
{
    protected override void Up(MigrationBuilder migrationBuilder)
    {
        migrationBuilder.AddColumn(
            name: "IndexTitle",
            table: "Component",
            nullable: true);

        migrationBuilder.AddColumn(
            name: "IndexTitle",
            table: "Area",
            nullable: true);
    }
15

 
　　protected override void Down(MigrationBuilder migrationBuilder)
　　{
　　　　migrationBuilder.DropColumn(
　　　　　　name: "IndexTitle",
　　　　　　table: "Component");

　　　　migrationBuilder.DropColumn(
　　　　　　name: "IndexTitle",
　　　　　　table: "Area");
　　}
}        

 

（此处只是举例说明，并非实际由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.