EF Core迁移中为含HasData数据的表添加列的问题

问题场景 #

在.NET 6项目中使用EF Core，初始定义Foo模型并通过Fluent API的HasData插入种子数据：

public class Foo
{
    public int ID { get; set; }
    public string Name { get; set; } = null!;
}

数据库上下文配置：

public DbSet<Foo> Foos => Set<Foo>();

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    var foo = modelBuilder.Entity<Foo>();
    foo.HasKey(f => f.Id);
    foo.HasProperty(f => f.Id).IsRequired();
    foo.HasProperty(f => f.Name).IsRequired();
    foo.HasData(new Foo { Id = 1, Name = "Apple" });
    foo.HasData(new Foo { Id = 2, Name = "Banana" });
}

后续为Foo添加Quantity字段（修正原代码拼写错误：in改为int）：

public class Foo
{
    public int ID { get; set; }
    public string Name { get; set; } = null!;
    public int Quantity { get; set; }
}

同时更新HasData配置添加Quantity值后，生成的迁移并未执行“添加列+更新现有行”的预期操作，反而尝试删除原有行（因外键约束报错）再插入新行。

解决方案 #

方案1：使用Fluent API的UpdateData（推荐） #

EF Core 5及以上版本提供了UpdateData方法，专门用于更新已存在的种子数据，避免生成删除再插入的操作。修改OnModelCreating配置如下：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    var foo = modelBuilder.Entity<Foo>();
    foo.HasKey(f => f.Id);
    foo.HasProperty(f => f.Id).IsRequired();
    foo.HasProperty(f => f.Name).IsRequired();
    foo.HasProperty(f => f.Quantity).IsRequired();

    // 保留初始种子数据定义
    foo.HasData(new Foo { Id = 1, Name = "Apple" });
    foo.HasData(new Foo { Id = 2, Name = "Banana" });

    // 使用UpdateData更新现有种子数据的Quantity字段
    foo.UpdateData(
        keyValue: 1,
        propertyValues: new { Quantity = 10 });
    foo.UpdateData(
        keyValue: 2,
        propertyValues: new { Quantity = 20 });
}

重新生成迁移后，生成的代码会自动添加Quantity列，并生成UPDATE语句更新现有行的字段值，不会触发删除操作。

方案2：手动修改迁移的Up/Down方法 #

如果需要更灵活的控制，或者项目有特殊需求，可以直接修改生成的迁移类：

1. Up方法：保留添加列的代码，删除自动生成的DeleteData和InsertData语句，替换为SQL更新语句：

protected override void Up(MigrationBuilder migrationBuilder)
{
    // 添加Quantity列
    migrationBuilder.AddColumn<int>(
        name: "Quantity",
        table: "Foos",
        type: "int",
        nullable: false,
        defaultValue: 0);

    // 手动编写SQL更新现有行的Quantity值
    migrationBuilder.Sql("UPDATE Foos SET Quantity = 10 WHERE Id = 1;");
    migrationBuilder.Sql("UPDATE Foos SET Quantity = 20 WHERE Id = 2;");
}

2. Down方法：只需要删除Quantity列即可：

protected override void Down(MigrationBuilder migrationBuilder)
{
    migrationBuilder.DropColumn(
        name: "Quantity",
        table: "Foos");
}

原理说明 #

EF Core的HasData默认通过主键判断数据是否存在，当修改种子数据的属性并重新调用HasData时，EF会认为这是要替换原有数据，因此生成删除旧数据再插入新数据的操作。而UpdateData则明确告诉EF要更新已有主键对应的字段值，从而生成正确的更新语句。

内容的提问来源于stack exchange，提问作者Green Grasso Holm