EntityFramework Core 9.0 迁移脚手架问题解析与解决方案

在升级到 EntityFramework Core 9.0.0 版本后，许多开发者在尝试以编程方式生成数据库迁移时遇到了一个关键问题。本文将深入分析这个问题的本质，并提供完整的解决方案。

问题现象

当开发者使用 EF Core 9.0.0 及以上版本时，在调用 IMigrationsScaffolder.ScaffoldMigration() 方法生成迁移脚本时，系统会抛出以下异常：

System.InvalidOperationException: Metadata changes are not allowed when the model has been marked as read-only.

这个问题特别容易在以下场景中出现：

1. 当应用程序在生成迁移前执行了任何与迁移相关的操作（如检查待应用迁移）
2. 在已有数据库和迁移历史的情况下生成新的迁移

问题根源

经过 EF Core 团队的深入调查，发现这个问题源于 EF Core 9.0 中引入的一个内部变更。当应用程序在生成迁移前调用了如 DbContext.Database.GetPendingMigrations() 或 DbContext.Database.Migrate() 等方法时，会导致模型状态被标记为"只读"，从而阻止后续的迁移生成操作。

解决方案

临时解决方案（EF Core 9.0.0-9.0.2）

对于暂时无法升级到最新版本的用户，可以采用以下临时解决方案：

1. 避免在生成迁移前调用任何迁移相关API：确保在调用 ScaffoldMigration 之前不执行任何可能改变模型状态的操作。

2. 使用独立进程：将迁移生成逻辑放在一个独立的进程中执行，避免与其他迁移操作产生冲突。

永久解决方案（EF Core 9.0.3+）

EF Core 团队在 9.0.3 版本中修复了这个问题。升级到 9.0.3 或更高版本后，开发者可以正常使用编程方式生成迁移。

升级后需要注意以下几点：

1. 包引用调整：确保项目中正确引用了 Microsoft.EntityFrameworkCore.Design 包，并移除了可能存在的 PrivateAssets 配置。

2. API 使用优化：可以使用 DbContext.Database.HasPendingModelChanges() 方法来简化模型变更检测逻辑。

最佳实践

基于 EF Core 9.0 的迁移生成最佳实践：

// 示例代码 - 编程方式生成迁移
var services = new ServiceCollection()
    .AddEntityFrameworkDesignTimeServices()
    .AddDbContextDesignTimeServices(dbContext);

var designTimeServices = new SqlServerDesignTimeServices();
designTimeServices.ConfigureDesignTimeServices(services);

var serviceProvider = services.BuildServiceProvider();
var scaffolder = serviceProvider.GetRequiredService<IMigrationsScaffolder>();

var migration = scaffolder.ScaffoldMigration(
    "MigrationName",
    "YourNamespace",
    "YourMigrationsSubNamespace");

// 写入迁移文件
await File.WriteAllTextAsync(Path.Combine(migrationPath, migration.MigrationId + migration.FileExtension), 
    migration.MigrationCode);

常见问题补充

1. 迁移生成全量脚本问题：如果发现生成的迁移脚本包含所有表结构而非增量变更，请检查模型快照文件是否完整且可访问。

2. 自定义迁移程序集：使用自定义 IMigrationsAssembly 实现时，确保正确处理模型快照的加载和存储。

3. 多数据库支持：为不同数据库提供程序（如 SQL Server 和 PostgreSQL）生成迁移时，应为每种数据库创建独立的迁移文件夹。

总结

EF Core 9.0 在迁移生成机制上的这一变更虽然初期带来了一些兼容性问题，但通过及时升级到修复版本并遵循新的最佳实践，开发者可以继续高效地使用编程方式管理数据库迁移。理解这一问题的本质有助于开发者更好地掌握 EF Core 的迁移机制，为未来的版本升级和应用维护打下坚实基础。