【EntityFramework CodeFirst】使用迁移(Migration)示例

1、什么时候需要使用 CodeFirst 迁移

当通过 CodeFirst 模式初始化数据库后，CodeFirst 实体类型发生了改变，比如添加了新的属性。这时就需要将 CodeFirst 实体类的变化同步到数据库结构中。此时，可以使用 CodeFirst 迁移(Migration)功能自动完成此操作这一同步，而不需要重新初始化数据库结构，或手工编写更新数据库结构的 SQL 语句。

2、 EntityFrameworkCodeFirst 示例项目

开发环境：Visual Studio 2019 + Sql server 2017 。

示例项目：下文使用 EntityFrameworkCodeFirst 项目进行举例说明。在之前的示例中，在首次运行 EntityFrameworkCodeFirst 项目时，当 EF CodeFirst 上下文被使用时，已根据上下文中配置好的“数据库初始化器”成员自动创建了数据库（PS：在我的印象里，在早期的 EF CodeFirst，还没有自动迁移功能）。关于该示例的更多信息，请参考：https://blog.csdn.net/itisauto2008/article/details/117463350

 接下来，假如我们为Department实体类型添加一个主管的属性。如下：

/// <summary>
/// 主管
/// </summary>
public virtual Staff Manager { get; set; }

如果直接运行项目，会收到报错：如图。

System.InvalidOperationException:“The model backing the 'Company' context has changed since the database was created. Consider using Code First Migrations to update the database (http://go.microsoft.com/fwlink/?LinkId=238269).”

翻译：无效操作：模型所属上下文已发生修改。考虑使用迁移更新数据库。

3、使用迁移的操作步骤

如图，选择 CodeFirtst 项目，进入NuGet控制台\程序包管理控制台，执行几个命令就可以完成迁移操作。

第一步：为项目启用迁移功能

如图，输入此命令并回车执行：Enable-Migrations

执行中和执行完成，都会回显信息。

执行中：

PM> Enable-Migrations
Checking if the context targets an existing database...

执行完成，如果收到以信息：

Detected database created with a database initializer. Scaffolded migration '202106010245260_InitialCreate' corresponding to existing database. To use an automatic migration instead, delete the Migrations folder and re-run Enable-Migrations specifying the -EnableAutomaticMigrations parameter.

回显信息如下：检测到使用数据库初始化器创建的数据库。与现有数据库相对应的结构化迁移是“202106010245260_InitialCreate”。要改用自动迁移，请删除Migrations文件夹，然后指定-EnableAutomaticMigrations参数重新运行Enable Migrations。

意思是，在启用迁移之前，使用了数据库初始化器创建了数据库。如果使用迁移，需要删除Migrations文件夹，如图。这不会对数据库中的数据产生影响。

然后再执行以下命令，且回显以下信息时，表示成功启用了自动迁移工具了。

PM> Enable-Migrations -EnableAutomaticMigrations
Migrations have already been enabled in project 'D:\……\HelloWorld\EntityFrameworkCodeFirst\bin\Debug\EntityFrameworkCodeFirst.exe'. To overwrite the existing migrations configuration, use the -Force parameter.

第二步：创建迁移任务

执行以下命令:

PM> Add-Migration AddDepartmentManager20210630

其中，AddDepartmentManager20210630 是为本次迁移所起的名字，根据自己需要编写。

执行完成，回显信息如下：

PM>  Add-Migration AddDepartmentManager20210630
Scaffolding migration 'AddDepartmentManager20210630'.
The Designer Code for this migration file includes a snapshot of your current Code First model. This snapshot is used to calculate the changes to your model when you scaffold the next migration. If you make additional changes to your model that you want to include in this migration, then you can re-scaffold it by running 'Add-Migration AddDepartmentManager20210630' again.

同时，在解决方案管理器中，可以看到项目Migrations文件夹中生成了以下文件。可以忽略此文件的存在，直接继续下一步。

文件内容如下：

namespace EntityFrameworkCodeFirst.Migrations
{
    using System;
    using System.Data.Entity.Migrations;
    
    public partial class AddDepartmentManager20210630 : DbMigration
    {
        public override void Up()
        {
            AddColumn("dbo.Departments", "Manager_Id", c => c.Long());
            CreateIndex("dbo.Departments", "Manager_Id");
            AddForeignKey("dbo.Departments", "Manager_Id", "dbo.Staffs", "Id");
        }
        
        public override void Down()
        {
            DropForeignKey("dbo.Departments", "Manager_Id", "dbo.Staffs");
            DropIndex("dbo.Departments", new[] { "Manager_Id" });
            DropColumn("dbo.Departments", "Manager_Id");
        }
    }
}

第三步：执行迁移任务

执行以下命令:

PM> Update-Database

执行完成回显信息如下：

PM> Update-Database
Specify the '-Verbose' flag to view the SQL statements being applied to the target database.
Applying explicit migrations: [202106300603239_AddDepartmentManager20210630].
Applying explicit migration: 202106300603239_AddDepartmentManager20210630.
Running Seed method.

生成并执行了如下SQL语句：

ALTER TABLE [dbo].[Departments] ADD [Manager_Id] [bigint]
go
CREATE INDEX [IX_Manager_Id] ON [dbo].[Departments]([Manager_Id])
go
ALTER TABLE [dbo].[Departments] ADD CONSTRAINT [FK_dbo.Departments_dbo.Staffs_Manager_Id] FOREIGN KEY ([Manager_Id]) REFERENCES [dbo].[Staffs] ([Id])
go
INSERT [dbo].[__MigrationHistory]([MigrationId], [ContextKey], [Model], [ProductVersion])
VALUES (N'202106300603239_AddDepartmentManager20210630', N'EntityFrameworkCodeFirst.Company',  
0x1F8B0800000000000400ED1ADB6EDB36F47DC0FE41D0E39059763A0C5B60B7C89C6630D6244594167B2B68E9D8214A511A496531867DD91EF649FB851DEA2E4AB269C7BD0C2B02043179EE379E739C7FFEFA7BFAE23162CE030849633E7327A3B1EB000FE290F2F5CC4DD5EADB1FDC17CFBFFE6AFA328C1E9DB725DC330D87985CCEDC7BA59233CF93C13D44448E221A8858C62B350AE2C82361EC9D8EC73F7A93890748C2455A8E33BD4DB9A211641FF0E33CE601242A25EC2A0E81C9E21C6FFC8CAA734D2290090960E6BE444CB5B91478F27B2CDECF11E1920AA95CE79C5182F2F8C056AE43388F155128EDD91B09BE12315FFB091E1076B74900E156844928B438ABC16D151A9F6A85BC1AB12415A452C5D19E0427CF0A0B7926FA4176762B0BA20D738B69AD333BCEDC0B4888501170349AC9EE6CCE84061D36F4A8463F7186804EAA58C190D23F27CE3C652A1530E3902A41D889F33A5D321AFC029BBBF83DF0194F196BCA8D92E35DEB008F5E8B3801A136B7B02AB45984AEE3B5F13C13B1426BE0E45A2EB8FAFE3BD7B946E664C9A00A8B86457C150BF8193808A2207C4D9402C1350DC894EF703778699B94DC300E31B15CE78A3CBE02BE56F79872634CA54BFA0861795248F08653CC43445222851E09B773D5BFB7703D3D12D76BF240D799990CFE5784933508D7B90596DDCB7B9AE4C9D908A07715D8A588A3DB98B5A2B3BC7DE7C7A908B43AF120C81D116B50F6F2F98AAC567297782554AF74F9E536E10A883ED9A65E9D965B9335A371509E66985F52F4FF9EA206D73A3C775BD836999A0FCAD313AA4C97E1842A53CE26A1CEA58C039A89D491B62A3F6D3D5FF2D0D95D8B72BFB5F54307620AD10493064599B9DF746CB89576A5794DBB48FF36D9F1683431B56FE869AD7EE10D0B09CD5A67A3FCC4352BC30DBF00060A9CF320EF8CE6440624EC461AFA32B497CAD66C5D6F608902A16B0461D8834A2C7A94AB6E3DA33CA00961BBCC62205A9642AD6EC5C2BC415EC07515DBA5BC0DEF76EA77A5A89819CED865A5C1E0CB331271146280A8AA6D9410BEE979D3B0532F9E355954373308343D1F544FDDA9B3BF27303B49D8A653444B8744716E603794ED13A5EE691A80C39D8FE905ABE25329D0B641C7A556D5A641AC5F61AFADF17ED6282BFE5663F41522CB52F424531805E40996289F9F2AD8EB19D6CB87D872D8F506A6DDE91549126C021AD36F71E2F8F9E83BFFD6DF7F1A8C721A5E207B86C24ADA8A133652181CC66DDE21655DE3055164497473300FA31EB03CB507D2ADE4D2C9DEAEB3CA4C2C51F4DF399AC55CDA530D0B3A88B6D61099A2D01F3B1DE46C0F4118113D2DEA3C6669C4876BFB3076DE7436F1F3137B0A7903D9A4909F74294C3D43FF4EEDEF58BCF320B77D68E5E13C898EE2DC5E52167E1DC0FBEFBB748842FB916F52DAFEFC7FF82069D7CEA15A503F9F7BA57C8D669FD9FA4D18B49EF94C76CD6515402595FE8EAB21C041B20D369E0707F75699B0D287341B2516520F8BD5A068A7B1F97C76A3A4F38A9A20558C56AFA9F16A4E8B176CF722B9F3A4E520AE83DA3FD0503F67FE462A88461A60E4FFC6E68C66BD4509809AD21548952F4770609F9C1A5BE8CF6723EC4919B227AC851738183CCEDC3F9C3F3FFE026849D7540BB573CBB3E72AA4B9F6E10F4404F74474173F4FD8EAF4123D3D806833A7DA36197694C63C7316BFBEAB914F9C1B81717BE68CD18D0D19F245D251D7935FE2E553C64BDF926F8F8869A20FC54C8F1C1F64055704D8FE2BB18199EFE0CDDD41BBA2A1B6F5032E86ACB86D6F4B8EBE083ACE16F2D3EE1D2D03F1E84BC68F113DF661FAD9EC10CD7DC491368579133873C3658CBECE4B5D7D2F9FBA4AEC235F6EC83ED19AB125F1F0EE6B3027AD16709FD70EF190ADA1A5998EB322EC0E3198418DFF99C10496745D93D0931987A0953B15CC82AFE232910D894A10B3DD0445424CAC73A1E88A040AAF039032FB86F22D61A91EC9A325840B7E93AA2455A832444BD6FA9E5597826DFCB33D685BE6E94D927D73780C15504C8A2AC00DFF29A52CACE4BEEC695B0648E81A53748FDA974A7791EB4D45E93AE696840AF355A5F10EA284213179C37DF20087C8F646C22B58936053CEA2C344763BA26DF6E905256B412259D0A8F1F123C670183D3EFF1778AFCF633A260000 , N'6.4.4')

go

关于__MigrationHistory表：

EF CodeFirst 中 DbContext 首次加载 OnModelCreating 会检查 __MigrationHistory 表，该表由 EF 自动创建和维护。一般情况下，忽略此表的存在不影响正常的迁移操作。该表字段描述如下：

• MigrationId： 就是在Add-Migration指令中指定的<版本名>，EF会自动在前面加上时间戳

• ContextKey： 主要作用是对Model进行分组，这样不同项目的Model可以在同一个DB中互不干扰

• Model：EF会基于DBContext中包含的所有Entity Model生成字节数组

• ProductVersion：生成这个Migration的EF的版本号

以上