1. 项目概述
最近在重构一个遗留系统时，遇到了一个典型场景：需要根据运行时条件动态生成数据库结构变更。传统的手动Add-Migration方式显然无法满足需求，于是我开始研究如何在EF Core的Code First模式下以编程方式生成迁移。这个需求在需要动态创建租户数据库的SaaS系统中尤为常见。
2. 核心原理剖析
2.1 EF Core迁移机制解析
EF Core的迁移本质上是一组有序的Migration类文件，每个文件包含Up()和Down()方法。当我们执行Add-Migration命令时，EF Core会做三件事：
- 比较当前模型与快照模型的差异
- 生成迁移操作代码（AddColumn、CreateTable等）
- 创建迁移类文件并更新快照
编程式生成迁移的核心，就是要模拟这个流程。关键在于理解IMigrationsScaffolder和MigrationCommandListBuilder这两个核心接口。
2.2 动态迁移生成流程
完整的编程式迁移生成包含以下步骤：
- 获取DbContext类型信息
- 创建设计时服务集合
- 构建MigrationsScaffolder实例
- 生成迁移操作命令
- 可选：直接应用迁移到数据库
3. 具体实现方案
3.1 基础环境准备
首先确保项目已安装必要NuGet包：
bash复制dotnet add package Microsoft.EntityFrameworkCore.Design
dotnet add package Microsoft.EntityFrameworkCore.SqlServer
3.2 核心代码实现
以下是动态生成迁移的完整示例：
csharp复制public static void GenerateMigration(string migrationName, DbContext context)
{
// 1. 获取设计时服务
var services = new DesignTimeServicesBuilder(typeof(DbContext).Assembly)
.Build(context);
// 2. 获取必要服务实例
var scaffolder = services.GetRequiredService<IMigrationsScaffolder>();
var migrator = services.GetRequiredService<IMigrator>();
// 3. 生成迁移文件
var migration = scaffolder.ScaffoldMigration(
migrationName,
context.GetType().Namespace,
typeof(DbContext));
// 4. 保存迁移文件
var projectDir = Directory.GetCurrentDirectory();
var migrationsDir = Path.Combine(projectDir, "Migrations");
scaffolder.Save(
migrationsDir,
migration.MigrationFile,
migration.MigrationMetadataFile,
migration.SnapshotFile);
// 5. 可选：立即应用迁移
migrator.Migrate();
}
3.3 关键参数说明
migrationName: 迁移名称，遵循EF Core命名规范context: 当前DbContext实例DesignTimeServicesBuilder: 构建设计时服务容器IMigrationsScaffolder: 迁移脚手架核心接口IMigrator: 迁移应用执行器
4. 高级应用场景
4.1 多租户系统中的应用
在SaaS系统中，可以为每个新租户动态生成专属迁移：
csharp复制public void SetupTenantDatabase(string tenantId)
{
var options = new DbContextOptionsBuilder<TenantDbContext>()
.UseSqlServer(GetTenantConnectionString(tenantId))
.Options;
using var context = new TenantDbContext(options);
GenerateMigration($"Initial_{tenantId}", context);
}
4.2 条件化迁移生成
根据运行时配置决定是否生成特定迁移：
csharp复制if(config.EnableNewFeature)
{
GenerateMigration("Add_NewFeature_Columns", context);
}
5. 实战注意事项
5.1 常见问题排查
-
设计时上下文加载失败
- 确保DbContext有无参构造函数
- 检查是否配置了IDesignTimeDbContextFactory
-
迁移文件生成位置错误
- 显式指定MigrationsDirectory路径
- 检查项目文件是否包含迁移文件夹
-
迁移应用失败
- 确保数据库连接字符串正确
- 检查是否有未应用的迁移冲突
5.2 性能优化建议
- 对于频繁生成的场景，缓存设计时服务集合
- 批量处理多个迁移时，复用同一个DbContext实例
- 考虑使用迁移Bundle优化部署流程
6. 替代方案比较
| 方案 | 优点 | 缺点 | 适用场景 |
|---|---|---|---|
| 编程式生成 | 完全动态控制 | 实现复杂度高 | 需要运行时决定的迁移 |
| 预生成迁移 | 简单可靠 | 不够灵活 | 固定结构的常规项目 |
| 纯SQL脚本 | 性能最优 | 维护困难 | 对性能要求极高的场景 |
7. 扩展思考
在实际项目中，我还发现几个有用的技巧：
- 可以通过继承MigrationsScaffolder来定制迁移代码模板
- 使用IMigrationsModelDiffer比较模型差异时，可以过滤特定类型的变更
- 结合Source Generators可以在编译时生成部分迁移代码
重要提示：动态生成迁移会修改项目文件结构，在生产环境使用时务必做好备份和测试。我在一个线上项目曾因路径处理不当导致迁移文件生成到错误位置，造成部署失败。