EF Core 8/9 迁移脚本生成中的变量重复声明问题解析

问题背景

在将项目从 .NET 7 升级到 .NET 8 后，开发人员发现使用 EF Core 8.0.11 生成的迁移脚本执行时会报错。错误信息显示"变量名 '@defaultSchema' 已被声明"，这表明在同一个 SQL 批处理中重复声明了相同名称的变量。

问题现象对比

在 EF Core 7.0.20 版本中，生成的迁移脚本会使用 GO 语句将不同的迁移操作分隔成独立的批处理，每个批处理都有自己的变量作用域。例如：

IF NOT EXISTS(...)
BEGIN
    -- 迁移操作1
    DECLARE @defaultSchema sysname = SCHEMA_NAME();
    -- 其他操作
END;
GO

IF NOT EXISTS(...)
BEGIN
    -- 迁移操作2
    DECLARE @defaultSchema sysname = SCHEMA_NAME();
    -- 其他操作
END;
GO

而在 EF Core 8.0.11 及 9.0.0 版本中，生成的脚本移除了这些 GO 分隔符，导致所有迁移操作都在同一个批处理中执行，从而引发变量重复声明的问题：

IF NOT EXISTS(...)
BEGIN
    -- 迁移操作1
    DECLARE @defaultSchema sysname = SCHEMA_NAME();
    -- 其他操作
END;

IF NOT EXISTS(...)
BEGIN
    -- 迁移操作2
    DECLARE @defaultSchema sysname = SCHEMA_NAME(); -- 这里会报错
    -- 其他操作
END;

问题根源

这个问题源于 EF Core 8/9 版本中迁移脚本生成逻辑的变化。新版本默认将整个脚本作为一个事务执行，因此移除了批处理分隔符 GO。虽然这种改变有助于保证迁移的原子性，但却导致了变量作用域的问题。

临时解决方案

目前有两种临时解决方案：

1. 使用 --no-transactions 参数：生成脚本时不使用事务，这样会保留 GO 分隔符

   dotnet ef migrations script --no-transactions
   

   但这种方法牺牲了事务安全性，如果脚本执行中途失败，数据库可能处于部分迁移状态。

2. 手动修改生成的脚本：在适当位置添加 GO 语句分隔批处理。

长期解决方案

EF Core 团队已经确认这是一个回归问题，并计划在 9.0.1 版本中修复。该版本预计在 2024 年 1 月中旬发布。

技术建议

对于需要立即部署的项目，建议：

1. 评估使用 --no-transactions 选项的风险
2. 考虑暂时回退到 EF Core 7.x 版本
3. 如果必须使用 EF Core 8/9，可以编写自定义脚本生成器来处理变量作用域问题

对于表重命名等特定操作，也可以考虑使用原始 SQL 迁移来避免这个问题：

migrationBuilder.Sql("EXEC sp_rename '[dbo].[oldTable]', 'newTable', 'OBJECT'");

总结

这个问题展示了框架升级可能带来的微妙兼容性问题。开发者在升级 EF Core 版本时，不仅需要关注新功能，还应该全面测试现有的迁移流程。特别是在涉及复杂数据库操作时，脚本生成方式的改变可能会产生意想不到的影响。