EF Core 9中dotnet-ef migrations script命令的SQL批处理问题解析

问题背景

在Entity Framework Core 9.0版本中，开发人员发现使用dotnet-ef migrations script命令生成的SQL脚本存在一个严重问题：脚本中缺少必要的GO分隔符，导致SQL批处理执行失败。这个问题特别影响存储过程的创建和修改操作，因为SQL Server要求CREATE/ALTER PROCEDURE必须是批处理中的第一条语句。

问题表现

在EF Core 8.0.8版本中，生成的迁移脚本会正确包含GO分隔符和事务控制语句，例如：

BEGIN TRANSACTION;
GO

CREATE OR ALTER PROCEDURE SomeProcedure
AS
    BEGIN TRANSACTION
    INSERT INTO ExampleTable (Column1, Column2)
    VALUES ('Value1', 'Value2');
    COMMIT TRANSACTION
GO

而在EF Core 9.0.2及以上版本中，生成的脚本缺少了这些关键分隔符：

BEGIN TRANSACTION;
CREATE OR ALTER PROCEDURE SomeProcedure
AS
    BEGIN TRANSACTION
    INSERT INTO ExampleTable (Column1, Column2)
    VALUES ('Value1', 'Value2');
    COMMIT TRANSACTION

这种变化会导致SQL Server报错："'CREATE/ALTER PROCEDURE' must be the first statement in a query batch."

技术分析

SQL批处理基础

SQL Server中的批处理是一组一起提交执行的SQL语句。GO不是SQL语句，而是SQL Server工具(如SSMS和sqlcmd)识别的批处理分隔符。它告诉工具将前面的语句作为一个批次发送到服务器执行。

EF Core迁移脚本生成机制

EF Core的迁移脚本生成器负责将C#迁移代码转换为可执行的SQL脚本。在转换过程中，它需要：

1. 正确处理事务边界
2. 确保每个迁移操作在独立的批处理中执行
3. 维护迁移历史表的更新

在EF Core 9中，脚本生成逻辑发生了变化，导致批处理分隔符的缺失。

存储过程创建的特殊要求

SQL Server对存储过程的创建有特殊要求：

• CREATE/ALTER PROCEDURE必须是批处理中的第一条语句
• 不能与其他SQL语句混合在同一个批处理中
• 通常需要自己的事务上下文

影响范围

这个问题主要影响：

1. 使用dotnet-ef migrations script命令生成脚本的用户
2. 迁移中包含存储过程创建/修改操作的情况
3. 需要将迁移脚本应用于SQL Server数据库的场景

值得注意的是，这个问题不影响迁移包(migration bundles)的生成，仅影响脚本生成工具。

临时解决方案

目前开发人员可以采用以下临时解决方案：

1. 使用suppressTransaction参数：

migrationBuilder.Sql(sql, suppressTransaction: true);

2. 手动编辑生成的脚本，添加必要的GO分隔符

3. 降级到EF Core 8.x版本生成迁移脚本

4. 考虑使用迁移包而非脚本，因为此问题不影响包生成

最佳实践建议

1. 存储过程迁移分离：考虑将存储过程的创建/修改放在单独的迁移中

2. 脚本生成后验证：始终检查生成的脚本是否符合SQL Server的批处理要求

3. 考虑使用SQL项目：对于复杂的数据库对象，考虑使用SQL Server Data Tools (SSDT)项目来管理

4. 测试环境验证：在应用生产环境前，先在测试环境验证生成的脚本

总结

EF Core 9中迁移脚本生成器的这一变化给依赖脚本部署的团队带来了挑战。虽然可以通过临时解决方案缓解问题，但最佳做法是等待官方修复或调整迁移策略以适应这一变化。开发团队应当意识到数据库迁移是部署过程中的关键环节，需要特别关注其可靠性和一致性。