王杰岸1. EF Core Code First 迁移概述
在EF Core开发中，Code First是一种常用的数据库建模方式，它允许开发者通过定义实体类来设计数据库结构，然后通过迁移(Migration)机制将这些模型变更应用到数据库中。传统方式是通过命令行工具生成迁移文件，但在某些自动化场景下，我们需要以编程方式动态生成迁移。
Code First迁移的核心原理是：
- 通过DbContext和实体类定义数据模型
- 与当前数据库结构进行比较，识别差异
- 生成迁移脚本文件(.cs和.Designer.cs)
- 应用迁移到数据库
需要模型API调用？ 免费领10W Token，多模型网关一键接入 Claude、DeepSeek 等主流模型。
2. 编程生成迁移的实现方法
2.1 基本实现步骤
要在代码中动态生成迁移，可以使用EF Core提供的MigrationScaffolder类。以下是核心实现代码：
csharp复制public void GenerateMigration(DbContext context, string migrationName, string outputDir)
{
// 获取数据库提供程序服务
var services = context.GetInfrastructure();
// 获取迁移脚手架
var scaffolder = services.GetRequiredService<IMigrationScaffolder>();
// 生成迁移
var migration = scaffolder.ScaffoldMigration(migrationName, context.GetType().Namespace,
context.Model.GetRelationalModel());
// 保存迁移文件
Directory.CreateDirectory(outputDir);
File.WriteAllText(Path.Combine(outputDir, $"{migration.MigrationId}.cs"), migration.MigrationCode);
File.WriteAllText(Path.Combine(outputDir, $"{migration.MigrationId}.Designer.cs"), migration.MetadataCode);
File.WriteAllText(Path.Combine(outputDir, $"{migration.MigrationId}.Snapshot.cs"), migration.SnapshotCode);
}
2.2 关键组件解析
- IMigrationScaffolder：EF Core提供的迁移脚手架接口，负责生成迁移代码
- GetRelationalModel()：获取当前DbContext的模型关系信息
- MigrationCode：生成的迁移操作代码
- MetadataCode：迁移的元数据代码
- SnapshotCode：当前模型快照代码
3. 高级应用场景
3.1 动态模型变更处理
在实际项目中，我们可能需要根据运行时条件动态修改模型：
csharp复制public void GenerateMigrationWithDynamicModel(DbContext context, Action<ModelBuilder> modelChanges)
{
// 克隆原始模型
var model = context.Model.Clone();
// 应用动态变更
var modelBuilder = new ModelBuilder(model);
modelChanges(modelBuilder);
// 创建临时DbContext
using var tempContext = new TempDbContext(model);
// 生成迁移
GenerateMigration(tempContext, "DynamicMigration", "Migrations");
}
private class TempDbContext : DbContext
{
private readonly IModel _model;
public TempDbContext(IModel model) => _model = model;
protected override void OnConfiguring(DbContextOptionsBuilder options)
=> options.UseSqlServer("Server=.;Database=Temp;Trusted_Connection=True;");
protected override void OnModelCreating(ModelBuilder modelBuilder)
=> modelBuilder.Model.Merge(_model);
}
3.2 迁移自定义处理
我们可以自定义迁移操作，实现更复杂的数据库变更：
csharp复制public class CustomMigrationGenerator : IMigrationsCodeGenerator
{
private readonly IMigrationsCodeGenerator _inner;
public CustomMigrationGenerator(IMigrationsCodeGenerator inner) => _inner = inner;
public string GenerateMigration(string migrationNamespace, string migrationName,
IReadOnlyList<MigrationOperation> upOperations,
IReadOnlyList<MigrationOperation> downOperations)
{
// 自定义迁移代码生成逻辑
var code = _inner.GenerateMigration(migrationNamespace, migrationName, upOperations, downOperations);
// 添加自定义代码
return code.Replace("// <auto-generated />",
"// <auto-generated />\n// Custom migration generated at " + DateTime.Now);
}
// 其他必要接口实现...
}
4. 实际应用中的注意事项
4.1 环境配置要点
- 依赖注入配置：
csharp复制services.AddDbContext<MyContext>(options =>
options.UseSqlServer(connectionString)
.ReplaceService<IMigrationsCodeGenerator, CustomMigrationGenerator>());
- 迁移文件组织：
- 确保迁移目录结构符合EF Core约定
- 避免迁移文件名冲突
- 保持迁移顺序的正确性
4.2 常见问题排查
- 模型变更未检测到：
- 确保DbContext模型已更新
- 检查模型快照是否同步更新
- 验证模型比较器是否正常工作
- 迁移生成失败：
- 检查数据库连接是否有效
- 验证模型是否有效
- 确保有足够的文件系统权限
- 迁移应用问题：
- 检查迁移历史表(__EFMigrationsHistory)是否存在
- 验证迁移是否已正确生成
- 确保数据库用户有足够权限
5. 性能优化建议
5.1 批量迁移处理
对于需要生成多个迁移的场景，可以使用批量处理：
csharp复制public void GenerateMigrationsInBatch(DbContext context, IEnumerable<string> migrationNames)
{
var services = context.GetInfrastructure();
var scaffolder = services.GetRequiredService<IMigrationScaffolder>();
var model = context.Model;
foreach (var name in migrationNames)
{
// 模拟模型变更
model = ApplyModelChange(model, name);
// 创建临时上下文
using var tempContext = CreateTempContext(model);
// 生成迁移
var migration = scaffolder.ScaffoldMigration(name, tempContext.GetType().Namespace,
tempContext.Model.GetRelationalModel());
SaveMigrationFiles(migration, "Migrations");
}
}
5.2 迁移缓存机制
频繁生成迁移时，可以引入缓存提高性能：
csharp复制private static readonly ConcurrentDictionary<string, Migration> _migrationCache = new();
public Migration GetOrCreateMigration(DbContext context, string migrationName)
{
return _migrationCache.GetOrAdd(migrationName, name =>
{
var services = context.GetInfrastructure();
var scaffolder = services.GetRequiredService<IMigrationScaffolder>();
return scaffolder.ScaffoldMigration(name, context.GetType().Namespace,
context.Model.GetRelationalModel());
});
}
6. 安全注意事项
- 输入验证：
- 验证迁移名称不包含特殊字符
- 检查输出目录路径是否合法
- 限制模型变更的范围
- 权限控制：
- 确保迁移生成操作有适当权限
- 限制对敏感模型的访问
- 审计迁移生成操作
- 错误处理：
csharp复制try
{
GenerateMigration(context, migrationName, outputDir);
}
catch (Exception ex) when (ex is InvalidOperationException or ArgumentException)
{
// 处理特定异常
LogError(ex);
throw new MigrationGenerationException("Failed to generate migration", ex);
}
7. 测试策略
7.1 单元测试示例
csharp复制[Fact]
public void Should_Generate_Migration_File()
{
// 准备
using var context = new TestDbContext();
var generator = new MigrationGenerator();
var testDir = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
try
{
// 执行
generator.GenerateMigration(context, "TestMigration", testDir);
// 验证
var files = Directory.GetFiles(testDir);
Assert.Equal(3, files.Length);
Assert.Contains("TestMigration.cs", files[0]);
}
finally
{
Directory.Delete(testDir, true);
}
}
7.2 集成测试要点
- 测试迁移文件生成是否正确
- 验证迁移可以成功应用到数据库
- 测试回滚功能是否正常
- 验证模型变更是否按预期反映在迁移中
8. 实际案例：多租户架构下的迁移管理
在多租户系统中，我们可能需要为不同租户生成特定迁移：
csharp复制public void GenerateTenantSpecificMigration(DbContext context, string tenantId)
{
// 获取租户特定配置
var tenantConfig = GetTenantConfig(tenantId);
// 应用租户特定模型变更
var model = context.Model.Clone();
ApplyTenantSpecificModelChanges(model, tenantConfig);
// 生成迁移
using var tempContext = CreateTenantContext(model, tenantConfig);
GenerateMigration(tempContext, $"Tenant_{tenantId}_Migration", "Migrations");
// 应用迁移到租户数据库
ApplyMigrationToTenantDatabase(tenantConfig.ConnectionString);
}
这种模式允许我们为不同租户维护独立的数据库结构变更历史，同时保持核心模型的一致性。