EF Core 6+如何获取特定迁移对应的模型快照？

问题背景 #

项目基于EF Core 6及以上版本开发，现有两个迁移：InitialMigration和SecondMigration，当前模型快照记录了两者都应用后的数据库状态。需要获取仅应用InitialMigration时的模型快照，用于执行squash migration（删除现有迁移及快照，基于当前C#模型生成新初始迁移）前的多环境状态校验：

• 若squash前存在未应用迁移，可直接对比当前模型快照与数据库结构；
• 若squash后新增了迁移，当前模型快照对应新增迁移的状态，此时需确认数据库是否与InitialMigration的模型快照匹配，排查未同步迁移，保障squash操作安全。

原方案需创建额外数据库并对比SQL结构，现寻求无额外数据库的实现方式。

解决方案 #

核心思路 #

利用EF Core的迁移API，在内存中构建指定迁移执行后的模型，再与目标数据库的当前模型对比，全程无需创建物理数据库。

步骤1：构建指定迁移后的内存模型 #

通过EF Core设计时服务，加载目标迁移并在内存中生成对应状态的模型：

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Design;
using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.Extensions.DependencyInjection;

// 替换为你的DbContext类型
public class YourDbContextFactory : IDesignTimeDbContextFactory<YourDbContext>
{
    public YourDbContext CreateDbContext(string[] args)
    {
        var options = new DbContextOptionsBuilder<YourDbContext>()
            // 使用临时内存数据库作为设计时载体，无持久化数据
            .UseSqlServer("Server=(localdb)\\mssqllocaldb;Database=TempDesignTimeDb;Trusted_Connection=True;")
            .Options;
        return new YourDbContext(options);
    }
}

public static class MigrationModelHelper
{
    public static Model GetModelAfterSpecificMigration(string targetMigrationName)
    {
        // 注册EF Core设计时服务
        var services = new ServiceCollection()
            .AddDbContextDesignTimeServices<YourDbContext>()
            .AddSingleton<IDesignTimeDbContextFactory<YourDbContext>, YourDbContextFactory>()
            .BuildServiceProvider();

        var migrationsAssembly = services.GetRequiredService<IMigrationsAssembly>();
        // 查找目标迁移
        if (!migrationsAssembly.Migrations.TryGetValue(targetMigrationName, out var targetMigration))
        {
            throw new InvalidOperationException($"未找到指定迁移: {targetMigrationName}");
        }

        // 从空模型开始，应用目标迁移的Up操作
        var conventionSet = services.GetRequiredService<IConventionSetBuilder>().CreateConventionSet();
        var modelBuilder = new ModelBuilder(conventionSet);
        targetMigration.Up(modelBuilder);

        // 完成模型构建并返回
        return modelBuilder.FinalizeModel();
    }
}

步骤2：对比内存模型与目标数据库状态 #

使用EF Core内置的模型差异检测工具，对比内存中的目标模型与实际数据库的模型：

using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Migrations;

public static bool IsDatabaseMatchingTargetModel(YourDbContext dbContext, Model targetModel)
{
    var services = dbContext.GetInfrastructure();
    var relationalModelDiffer = services.GetRequiredService<IRelationalModelDiffer>();

    // 获取当前数据库的模型
    var currentDbModel = dbContext.Model;

    // 检测数据库结构差异（表、列、索引、约束等）
    var differences = relationalModelDiffer.GetDifferences(
        targetModel.GetRelationalModel(),
        currentDbModel.GetRelationalModel()
    );

    // 无差异则说明数据库状态匹配
    return !differences.Any();
}

步骤3：调用示例 #

// 生成InitialMigration对应的内存模型
var targetModel = MigrationModelHelper.GetModelAfterSpecificMigration("InitialMigration");

// 连接到目标数据库
using var dbContext = new YourDbContext(); // 需配置目标数据库的连接字符串
var isMatching = IsDatabaseMatchingTargetModel(dbContext, targetModel);

if (isMatching)
{
    Console.WriteLine("数据库状态与InitialMigration执行后一致，可安全执行squash migration");
}
else
{
    Console.WriteLine("数据库状态与InitialMigration执行后不一致，请排查未同步的迁移");
}

补充说明 #

• 若InitialMigration不是首个迁移，需先遍历并应用其所有前置迁移到空模型，可通过迁移的Dependencies属性获取依赖链；
• 内存数据库仅作为设计时DbContext的临时载体，不会生成持久化的物理文件；
• IRelationalModelDiffer会检测所有数据库结构相关的变更，对比结果精准可靠。

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