EF Core约定生成迁移脚本时重复创建表的原因排查

问题原因 #

使用IModelFinalizingConvention添加影子实体时，EF Core的迁移脚本生成逻辑可能重复输出表创建语句——这是因为模型最终化阶段的Convention可能被多次触发，或者迁移系统在对比模型快照时误判实体状态，导致重复生成DDL。

可行解决方案 #

1. 避免重复添加影子实体 #

在Convention实现中，添加影子实体前先检查实体是否已存在，防止重复注册：

public class TabularHiLoConvention : IModelFinalizingConvention
{
    public void ProcessModelFinalizing(IConventionModelBuilder modelBuilder, IConventionContext<IConventionModelBuilder> context)
    {
        // 先校验实体是否已注册，避免重复添加
        if (modelBuilder.Metadata.FindEntityType(typeof(TabularHiLoEntity)) == null)
        {
            modelBuilder.Entity<TabularHiLoEntity>(b =>
            {
                b.ToTable("TabularHiLo");
                b.HasKey(e => e.Id);
                b.Property(e => e.Id).ValueGeneratedNever();
                b.Property(e => e.NextHiValue).IsRequired();
            });
        }
    }
}

2. 替换Convention类型 #

将IModelFinalizingConvention换成IEntityTypeAddedConvention，该Convention仅在实体被添加到模型时触发，避免模型最终化阶段的重复处理：

public class TabularHiLoConvention : IEntityTypeAddedConvention
{
    public void ProcessEntityTypeAdded(IConventionEntityTypeBuilder entityTypeBuilder, IConventionContext<IConventionEntityTypeBuilder> context)
    {
        // 在这里实现HiLo实体的注册逻辑，确保仅触发一次
    }
}

3. 排查DbContext重复配置 #

检查DbContext的OnModelCreating方法，确认没有手动重复添加该影子实体的配置，避免Convention和手动配置双重触发表创建逻辑。

4. 手动清理迁移脚本（临时方案） #

如果上述方法暂时无效，可以在生成迁移脚本后，手动删除重复的CREATE TABLE语句，或者直接修改迁移文件，确保表创建逻辑仅出现一次。

内容的提问来源于stack exchange，提问作者JeffreyABecker