@Sql 注解的局限性
在 Spring Boot 测试中，@Sql 注解常用于在测试方法执行前或后执行特定的 SQL 脚本，以准备或清理测试数据。例如：
@Sql(scripts = "/folder/my_favourite_script.sql")
@Test
void myTestMethod() {
// ... test logic
}然而，当尝试使用文件掩码（如 /folder/*.sql）来指定一个目录下的所有 SQL 文件时，Spring Framework 会抛出 CannotReadScriptException，指出资源未找到。这是因为 @Sql 注解的内部机制并未实现文件系统层面的通配符解析。
解决方案一：命令式脚本执行（适用于任何数据库）
由于 @Sql 注解不提供文件掩码功能，一个通用且灵活的解决方案是放弃注解的声明式方式，转而采用命令式（编程）方式来执行 SQL 脚本。这种方法的核心是获取数据库的 DataSource 实例，然后手动读取并执行 SQL 文件。
实现步骤：
- 注入 DataSource： 在测试类中自动注入 DataSource。
- 获取资源： 使用 Spring 的 ResourcePatternResolver 或 Java NIO 来查找匹配文件掩码的 SQL 脚本文件。
- 读取并执行： 遍历找到的脚本文件，读取其内容，并通过 DataSource 执行这些 SQL 语句。
示例思路（伪代码）：
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.jdbc.datasource.init.ScriptUtils;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.boot.test.context.SpringBootTest;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import javax.sql.DataSource;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
@ExtendWith(SpringExtension.class)
@SpringBootTest
class MyIntegrationTest {
@Autowired
private DataSource dataSource;
@Autowired
private ResourcePatternResolver resourcePatternResolver;
@Test
void executeMultipleSqlScriptsImperatively() throws IOException {
String scriptLocationPattern = "classpath:/folder/*.sql"; // 假设脚本在 classpath 的 /folder 目录下
Resource[] scripts = resourcePatternResolver.getResources(scriptLocationPattern);
for (Resource script : scripts) {
System.out.println("Executing script: " + script.getFilename());
// 使用 Spring 的 ScriptUtils 来执行 SQL 脚本
// 注意：ScriptUtils.executeSqlScript 默认会处理分号分隔的语句
ScriptUtils.executeSqlScript(dataSource.getConnection(), script, false, false,
ScriptUtils.DEFAULT_COMMENT_PREFIX,
ScriptUtils.DEFAULT_STATEMENT_SEPARATOR,
ScriptUtils.DEFAULT_BLOCK_COMMENT_START_DELIMITER,
ScriptUtils.DEFAULT_BLOCK_COMMENT_END_DELIMITER);
}
// ... test logic
}
}注意事项：
- 这种方法提供了最大的灵活性，你可以完全控制文件查找逻辑和脚本执行过程。
- 需要手动处理异常和事务管理（如果需要）。
- 适用于任何数据库，因为它是通过标准的 JDBC DataSource 进行操作。
解决方案二：利用 H2 数据库的 RUNSCRIPT 命令
如果你的测试环境使用的是 H2 数据库，可以利用 H2 数据库特有的 RUNSCRIPT 命令来间接实现批量脚本执行。RUNSCRIPT 命令允许在一个 SQL 脚本中引用并执行另一个 SQL 脚本。
实现步骤：
- 创建主脚本文件： 在 src/test/resources 目录下创建一个“主”SQL 脚本文件（例如 scripts.sql）。
- 引用子脚本： 在 scripts.sql 文件中，使用 RUNSCRIPT FROM 'file_path.sql'; 语法来引用所有需要执行的子 SQL 脚本。
- @Sql 注解引用主脚本： 在你的测试方法上，使用 @Sql 注解指向这个主脚本文件。
示例：
假设你的 SQL 脚本位于 /folder/file1.sql, /folder/file2.sql 等。
1. 创建 scripts.sql 文件：
在 src/test/resources/scripts.sql 中添加如下内容：
-- scripts.sql RUNSCRIPT FROM 'classpath:/folder/file1.sql'; RUNSCRIPT FROM 'classpath:/folder/file2.sql'; -- ... 如果有更多文件，继续添加
2. 在测试中使用 @Sql 注解：
import org.springframework.test.context.jdbc.Sql;
import org.springframework.boot.test.context.SpringBootTest;
import org.junit.jupiter.api.Test;
@SpringBootTest
class H2TestExample {
@Sql("classpath:/scripts.sql") // 指向主脚本文件
@Test
void myH2SpecificTest() {
// ... test logic
}
}注意事项：
- 此方法仅适用于 H2 数据库。
- 你需要手动维护 scripts.sql 文件，当子脚本文件增减时，需要更新此文件。
- RUNSCRIPT 命令支持相对路径和 classpath: 前缀。
总结与建议
选择哪种方法取决于你的具体需求和测试环境：
- 命令式脚本执行 提供最大的灵活性和数据库无关性，适用于需要动态文件查找逻辑或非 H2 数据库的场景。虽然代码量稍多，但可以更好地控制执行流程。
- H2 的 RUNSCRIPT 命令 是 H2 数据库用户的一个便捷选项，它利用了数据库本身的特性。缺点是需要手动维护一个主脚本文件，并且仅限于 H2。
对于大多数 Spring Boot 测试场景，如果需要批量执行 SQL 脚本且无法避免文件掩码的需求，命令式执行通常是更推荐的通用解决方案。如果你的测试数据库固定为 H2 且脚本文件数量相对稳定，那么 RUNSCRIPT 方式可以简化配置。
