Entity Framework（六）：数据迁移

亦凉 2023-06-01 11:27 9阅读 0赞

在前面的几篇文章中，简单的介绍了如何使用Entity Framework的Code First模式创建数据库，但是，在前面的几篇文章中，我们都是通过使用数据库初始化策略来做，也就是每次先删除数据库然后在创建，这样才能把新增加的字段信息更新到数据库，在测试的时候可以做，但是在正式的生产环境中就不能使用这种方式了，那么我们如何做才能在原有的数据库基础上进行字段的增删，这就需要使用到EF的数据迁移技术，使用EF的数据迁移技术，我们不用每次都先删除数据库然后在创建，并且数据库迁移技术还可以为我们设置初始化的数据。在这篇文章中，将会演示“在实体类发生改变时如何自动更新数据库中的表结构”  
一、合并和迁移  
1、合并

合并是指“新的实体模型映射到数据库中，更新其结构”，例如：  
新增了实体类，表现在数据库中就是新增加实体类对应的数据表。  
删除了实体类，表现在数据库中就是删除了实体类对应的数据表。  
在一个已经存在的实体类中增加属性，表现在数据库中就是在实体类对应的数据表中新增加字段。  
在一个已经存在的实体类中删除属性，表现在数据库中就是在实体类对应的数据表中删除字段。  
修改一个已经存在的实体类中属性的名称或类型，表现在数据库中就是修改实体类对应的数据表中字段的名称或类型。  
2、迁移

迁移是指“在更新数据库结构时，把老结构中的数据迁移到新结构中”。

二、迁移前的准备工作

搭建项目结构，整体的项目结构包括一个控制台应用程序和两个类库，项目结构如下：

![1033738-20171128205824956-1704320434.png][]

其中EF.Application是控制台程序，EF.FluentAPI和EF.Model是类型，EF.Model里面存的是实体类，EF.FluentAPI是实体类的Map类，用来设置FluentAPI。

Student类结构如下：

![复制代码][Image 1]

1 using System;
     2 using System.Collections.Generic;
     3 using System.Linq;
     4 using System.Text;
     5 using System.Threading.Tasks;
     6 
     7 namespace EF.Model
     8 {
     9     public class Student
    10     {
    11         public int StudentID { get; set; }
    12 
    13         public string StudentName { get; set; }
    14 
    15         public int Age { get; set; }
    16 
    17         public string Sex { get; set; }
    18     }
    19 }

![复制代码][Image 1]

StudentMap类结构如下：

![复制代码][Image 1]

1 using EF.Model;
     2 using System;
     3 using System.Collections.Generic;
     4 using System.ComponentModel.DataAnnotations.Schema;
     5 using System.Data.Entity.ModelConfiguration;
     6 using System.Linq;
     7 using System.Text;
     8 using System.Threading.Tasks;
     9 
    10 namespace EF.FluentAPI
    11 {
    12     /// <summary>
    13     /// 使用FluentAPI配置
    14     /// </summary>
    15    public class StudentMap :EntityTypeConfiguration<Student>
    16     {
    17        public StudentMap()
    18        {
    19            // 配置数据库中生成的表的名称
    20            this.ToTable("Students");
    21            // 设置StudentID列自动增长
    22            this.Property(p => p.StudentID).HasDatabaseGeneratedOption(DatabaseGeneratedOption.Identity);
    23            // 设置StudentID列作为主键
    24            this.HasKey(p => p.StudentID);
    25            // 设置StudentName列的类型是nvarchar，最大长度是50，必须的
    26            this.Property(p => p.StudentName).HasColumnType("nvarchar").HasMaxLength(50).IsRequired();
    27            // 设置Age列是必须的
    28            this.Property(p => p.Age).IsRequired();
    29            //  设置Sex的类型是nvarchar
    30            this.Property(p => p.Sex).HasColumnType("nvarchar").IsRequired();
    31        }
    32     }
    33 }

![复制代码][Image 1]

EF上下文类结构：

![复制代码][Image 1]

1 using System;
     2 using System.Collections.Generic;
     3 using System.Data.Entity;
     4 using System.Linq;
     5 using System.Text;
     6 using System.Threading.Tasks;
     7 
     8 namespace EF.FluentAPI
     9 {
    10    public class EFDbContext:DbContext
    11     {
    12        public EFDbContext()
    13            : base("name=CodeFirstApplication")
    14        { }
    15 
    16        protected override void OnModelCreating(DbModelBuilder modelBuilder)
    17        {
    18            modelBuilder.Configurations.Add(new StudentMap());
    19        }
    20     }
    21 }

![复制代码][Image 1]

数据库连接字符串：【注意：在EF.Application和EF.FluentAPI的App.config里面都要添加上该连接字符串】

1 <connectionStrings>
    2     <add name="CodeFirstApplication" connectionString="Server=.;Database=MigrationsDB;User Id=sa;Password=1qaz@WSX" providerName="System.Data.SqlClient"/>
    3 </connectionStrings>

控制台程序：

![复制代码][Image 1]

1 using EF.FluentAPI;
     2 using System;
     3 using System.Collections.Generic;
     4 using System.Linq;
     5 using System.Text;
     6 using System.Threading.Tasks;
     7 using EF.Model;
     8 
     9 namespace EF.Application
    10 {
    11     class Program
    12     {
    13         static void Main(string[] args)
    14         {
    15             Console.WriteLine("请输入学生姓名:");
    16             string studentName = Console.ReadLine().Trim();
    17             Console.WriteLine("请输入学生年龄:");
    18             int age = 0;
    19             if (!int.TryParse(Console.ReadLine().Trim(), out age))
    20             {
    21                 Console.WriteLine("年龄只能输入正整数，请重新输入:");
    22                 return;
    23             }
    24             Console.WriteLine("请输入学生性别(男/女):");
    25             string sex = Console.ReadLine().Trim();
    26 
    27             using (var context = new EFDbContext())
    28             {
    29                 Student student = new Student() 
    30                 {
    31                 StudentName=studentName,
    32                 Age=age,
    33                 Sex=sex
    34                 };
    35 
    36                 context.Entry(student).State = System.Data.Entity.EntityState.Added;
    37                 // 保存
    38                 context.SaveChanges();
    39             }
    40 
    41             Console.Write("添加成功");
    42             Console.ReadKey();
    43         }
    44     }
    45 }

![复制代码][Image 1]

运行程序：

![1033738-20171128211701690-776519964.png][]

查看数据库：

![1033738-20171128212405503-247198188.png][]

其中生成的表\_\_MigrationHistory用来记录每次的迁移。

三、迁移

现在我们在Student实体类中增加Grade字段，整体项目做如下的改动：

Student类：

![复制代码][Image 1]

StudentMap类：

![复制代码][Image 1]

控制台：

![复制代码][Image 1]

1 using EF.FluentAPI;
     2 using System;
     3 using System.Collections.Generic;
     4 using System.Linq;
     5 using System.Text;
     6 using System.Threading.Tasks;
     7 using EF.Model;
     8 
     9 namespace EF.Application
    10 {
    11     class Program
    12     {
    13         static void Main(string[] args)
    14         {
    15             Console.WriteLine("请输入学生姓名:");
    16             string studentName = Console.ReadLine().Trim();
    17             Console.WriteLine("请输入学生年龄:");
    18             int age = 0;
    19             if (!int.TryParse(Console.ReadLine().Trim(), out age))
    20             {
    21                 Console.WriteLine("年龄只能输入正整数，请重新输入:");
    22                 return;
    23             }
    24             Console.WriteLine("请输入学生性别(男/女):");
    25             string sex = Console.ReadLine().Trim();
    26             Console.WriteLine("请输入年级:");
    27             string grade = Console.ReadLine().Trim();
    28 
    29             using (var context = new EFDbContext())
    30             {
    31                 Student student = new Student() 
    32                 {
    33                 StudentName=studentName,
    34                 Age=age,
    35                 Sex=sex,
    36                 Grade=grade
    37                 };
    38 
    39                 context.Entry(student).State = System.Data.Entity.EntityState.Added;
    40                 // 保存
    41                 context.SaveChanges();
    42             }
    43 
    44             Console.Write("添加成功");
    45             Console.ReadKey();
    46         }
    47     }
    48 }

![复制代码][Image 1]

启用数据迁移：

1、打开迁移

在程序包管理器控制台中输入：Enable-Migrations

![1033738-20171128214732612-75596924.png][]

按回车键后，会生成Migrations文件夹，以及Migrations文件夹下面的Configuration类和201711281316287\_InitialCreate类：

![1033738-20171128215313003-1531747587.png][]

Configuration：这个类允许你去配置如何迁移，对于本文将使用默认的配置（在本文中因为只有一个Context，Enable-Migrations将自动对context type作出适配）;

201711281316287\_InitialCreate：这个迁移之所以存在是因为我们之前用Code First创建了数据库，在启用迁移之前，scaffolded migration里面的代码表示在数据库中已经创建的对象，本文中即为表Students。

Code First Migrations有两个需要熟悉的命令：  
Add-Migration 将scaffold创建下一次基于上一次迁移以来的更改的迁移；  
Update-Database 将任何挂起的迁移应用到数据库；

以上面新增加的字段Grade属性为例，命令Add-Migration允许我们对迁移进行命名，我们把迁移命名为AddGrade。

2、增加迁移节点

在程序包管理器控制台中输入命令：Add-Migration AddGrade

![1033738-20171128222642081-817503100.png][]

一个新的迁移（201711281402492\_AddGrade）在目录Migrations中创建成功：

![1033738-20171128222858909-1935148216.png][]

201711281402492\_AddGrade类结构如下：

![复制代码][Image 1]

1 namespace EF.FluentAPI.Migrations
     2 {
     3     using System;
     4     using System.Data.Entity.Migrations;
     5     
     6     public partial class AddGrade : DbMigration
     7     {
     8         public override void Up()
     9         {
    10             AddColumn("dbo.Students", "Grade", c => c.String(nullable: false, maxLength: 16, unicode: false));
    11         }
    12         
    13         public override void Down()
    14         {
    15             DropColumn("dbo.Students", "Grade");
    16         }
    17     }
    18 }

![复制代码][Image 1]

201711281402492\_AddGrade的名称是上面Add后面定义的迁移名称，而类下面有两个方法：一个是Up，一个是Down，记录了需要升级的修改，这里也就是Students表增加了Grade列。只要我们在后面执行Update-Database，就会执行此类下面的Up函数。

这里的Down函数简单介绍就是：为了回滚修改而设计的。如果用户希望恢复到某一个迁移节点，程序会自动根据已经执行的迁移，判断回滚哪些迁移，执行他们的Down函数。

3、更新数据库

在程序包管理器控制台中输入命令：Update-Database -Verbose

![1033738-20171128224130784-1848998725.png][]

查看数据库，Students表已经增加Grade字段：

![1033738-20171128224539190-1079234958.png][]

到此为止，迁移已经完成，再次运行项目：

![1033738-20171128225032144-2076036152.png][]

查看数据库：

![1033738-20171128225243175-422683129.png][]

输入的数据保存到数据库中。

四、修改属性

1、将Student实体类中的Grade属性的名称修改为GradeTest:

![复制代码][Image 1]

2、增加迁移节点

在程序包管理器控制台中输入命令：Add-Migration ModifyGrade

![1033738-20171129085349737-2142734232.png][]

在Migrations文件夹下面会生成本次的迁移记录：201711290052153\_ModifyGrade

![1033738-20171129085823987-1062121675.png][]

查看201711290052153\_ModifyGrade类结构：

![复制代码][Image 1]

1 namespace EF.FluentAPI.Migrations
     2 {
     3     using System;
     4     using System.Data.Entity.Migrations;
     5     
     6     public partial class ModifyGrade : DbMigration
     7     {
     8         public override void Up()
     9         {
    10             AddColumn("dbo.Students", "GradeTest", c => c.String(nullable: false, maxLength: 16, unicode: false));
    11             DropColumn("dbo.Students", "Grade");
    12         }
    13         
    14         public override void Down()
    15         {
    16             AddColumn("dbo.Students", "Grade", c => c.String(nullable: false, maxLength: 16, unicode: false));
    17             DropColumn("dbo.Students", "GradeTest");
    18         }
    19     }
    20 }

![复制代码][Image 1]

可以看到在Up方法里面，它不是直接修改了列的名称，而是先增加了一个新列GradeTest，然后删除旧列Grade。这样执行会有一个后果：如果Grade列里面有数据，数据会全部丢失。

3、更新到数据库

在程序包管理器控制台中输入命令：Update-Database -Verbose

![1033738-20171129090815628-1050859862.png][]

查看数据库表：

![1033738-20171129091215894-1971036594.png][]

通过查看数据库表，会发现新增加了GradeTest列，原先的Grade列被删掉，数据也全部丢失。

五、删除属性

删除属性和增加属性的操作差不多

1、修改Student实体类，注释掉GradeTest属性：

![复制代码][Image 1]

2、增加迁移节点

在程序包管理器控制台中输入命令：Add-Migration DeleteGradeTest

![1033738-20171129093250003-1705674071.png][]

查看生成的迁移记录类：

![1033738-20171129093442425-1766987574.png][]

201711290130110\_DeleteGradeTest类里面的Up方法里面删除了GradeTest列。

3、更新到数据库

在程序包管理器控制台中输入命令：Update-Database -Verbose

![1033738-20171129094046112-1828523901.png][]

查看数据库表，可以发现GradeTest列被删除掉：

![1033738-20171129094239300-1164840676.png][]

六、迁移至指定的版本（包括后退）

到目前为止，我们进行迁移都是进行升级，但是有些时候我们需要升级或降级至指定版本，例如我们想迁移数据库至运行ModifyGrade迁移之后的状态，此时我们就可以使用-TargetMigration来降级到这个版本。

在程序包管理器控制台中输入命令：Update-Database -TargetMigration:ModifyGrade

![1033738-20171129134352112-1779825663.png][]

这个命令将会运行201711290130110\_DeleteGradeTest类里面的Down命令。Reverting migrations表示回复迁移。

这时候在查看数据库表，会发现Students表中又有了GradeTest列。

如果你想回滚一切至空数据库，可以使用命令：Update-Database -TargetMigration:$InitialDatabase

![1033738-20171129140511659-1763706480.png][]

这时候在查看数据库，发现Students表中所有列都已经被删除：

![1033738-20171129140907128-1921391716.png][]

七、如何在保留现有数据的基础上修改列名

查看DbMigration类，会发现该类下面有一个RenameColumn()的方法，使用该方法可以在不丢失数据的基础上修改列的名称：

![1033738-20171129141809878-1986862409.png][]

1、修改Student实体类，将StudentName修改为Name。

2、在程序包管理器控制台中输入命令：Add-Migration RenameStudentName，生成迁移文件，手动修改迁移类文件，修改内容如下：

![复制代码][Image 1]

1 namespace EF.FluentAPI.Migrations
     2 {
     3     using System;
     4     using System.Data.Entity.Migrations;
     5     
     6     public partial class RenameStudentName : DbMigration
     7     {
     8         public override void Up()
     9         {
    10             //AddColumn("dbo.Students", "Name", c => c.String(nullable: false, maxLength: 50));
    11             AddColumn("dbo.Students", "GradeTest", c => c.String(nullable: false, maxLength: 16, unicode: false));
    12             //DropColumn("dbo.Students", "StudentName");
    13             RenameColumn("dbo.Students", "StudentName", "Name");
    14         }
    15         
    16         public override void Down()
    17         {
    18             //AddColumn("dbo.Students", "StudentName", c => c.String(nullable: false, maxLength: 50));
    19             DropColumn("dbo.Students", "GradeTest");
    20             //DropColumn("dbo.Students", "Name");
    21             RenameColumn("dbo.Students", "Name", "StudentName");
    22         }
    23     }
    24 }

![复制代码][Image 1]

3、执行Update-Database命令，数据库列名被自动修改。

![1033738-20171129144458362-1436439755.png][]

这里值得注意的是：在执行Update命令时，程序会提醒操作者： Changing any part of an object name could break scripts and stored procedures。翻译为中文：更改对象名的任一部分都可能会破坏脚本和存储过程。及修改列名可能会导致存储过程及其他调用列的sql脚本失效。

查看数据库表发现列名已经修改：

![1033738-20171129145051878-1933615846.png][]

注意：在实际开发中，不建议随便修改列名：可能会导致其他用的该列的地方调用失败。

总结：

1、迁移的关联在数据库的迁移历史表\_\_MigrationHistory和项目的Migrations文件夹下的继承了DbMigration的cs文件。

2、Migrations文件夹下的继承了DbMigration的cs文件可以手动修改，这里的修改可以非常灵活，表格和表格字段的增删改，在这里都有。

代码下载地址：https://pan.baidu.com/s/1eR9RJ0Y

转载于:https://www.cnblogs.com/dgg2015/p/11152574.html

[1033738-20171128205824956-1704320434.png]: /images/20230601/788306d343004547b723e478e82485d1.png
[Image 1]: 
[1033738-20171128211701690-776519964.png]: /images/20230601/1c549af89c354b8283b993262ccaebfa.png
[1033738-20171128212405503-247198188.png]: /images/20230601/a6f9bae81dec47e3aa4e2b809d3b157e.png
[1033738-20171128214732612-75596924.png]: /images/20230601/a12c918930d04cc79e81fe1e3c9c9ad2.png
[1033738-20171128215313003-1531747587.png]: /images/20230601/d94f94db648f413e8ce1c3f1384515eb.png
[1033738-20171128222642081-817503100.png]: /images/20230601/13f71f0a20024107a8e74beef823bc06.png
[1033738-20171128222858909-1935148216.png]: /images/20230601/01c2ba330bb64331b5cf56e76ade9989.png
[1033738-20171128224130784-1848998725.png]: /images/20230601/88777b17507b4f8384da19fbc927bf89.png
[1033738-20171128224539190-1079234958.png]: /images/20230601/a618ef61acf44a8ca205fe26f2758ee1.png
[1033738-20171128225032144-2076036152.png]: /images/20230601/b2c6e80956f24215a005f31d9df57947.png
[1033738-20171128225243175-422683129.png]: /images/20230601/82a75f8418c9418f946177efd5765490.png
[1033738-20171129085349737-2142734232.png]: /images/20230601/28f5eee1a41f471284a8ebd3227bdf12.png
[1033738-20171129085823987-1062121675.png]: /images/20230601/d540721a22e1403c94cf5b59a69fe1bb.png
[1033738-20171129090815628-1050859862.png]: /images/20230601/1949fae426b74f779e2e53afd4586005.png
[1033738-20171129091215894-1971036594.png]: /images/20230601/8de8a1e19ffc4af28688df35b514ee8e.png
[1033738-20171129093250003-1705674071.png]: /images/20230601/34fb0a97a5764eb392c38d2fbe1ab3ae.png
[1033738-20171129093442425-1766987574.png]: /images/20230601/dd54bbeb2ca6446f920bcdba961f668b.png
[1033738-20171129094046112-1828523901.png]: /images/20230601/d337fb125a4a4230b1d5c4d420697727.png
[1033738-20171129094239300-1164840676.png]: /images/20230601/57bba6da0d014bfb98f0d4f9d9383e84.png
[1033738-20171129134352112-1779825663.png]: /images/20230601/b0bae1045a9d41c98ef2188c1ebaa92d.png
[1033738-20171129140511659-1763706480.png]: /images/20230601/dd6b582113c74bde92ee598275f1a515.png
[1033738-20171129140907128-1921391716.png]: /images/20230601/187606c001f24269958af218d86742b5.png
[1033738-20171129141809878-1986862409.png]: /images/20230601/fcfa934f2119468b90f758ae3ae092ff.png
[1033738-20171129144458362-1436439755.png]: /images/20230601/e828b75effd943708a2185dbc8d58741.png
[1033738-20171129145051878-1933615846.png]: /images/20230601/1ea40751bd854f259a3dea7614fc5bff.png