使用 Spring Boot Test @Sql 注解通过掩码描述文件-java教程-PHP中文网

使用 Spring Boot Test @Sql 注解通过掩码描述文件

聖光之護

发布： 2025-10-11 09:19:00

原创

450人浏览过

使用 spring boot test @sql 注解通过掩码描述文件

本文介绍了在使用 Spring Boot Test 的 @Sql 注解时，如何通过掩码（mask）来指定需要执行的 SQL 脚本文件。由于 @Sql 注解本身不支持直接使用掩码，因此本文提供了两种替代方案：针对 PostgreSQL 数据库，通过编程方式读取和执行脚本；针对 H2 数据库，利用 RUNSCRIPT 命令将多个 SQL 文件合并到一个文件中执行。

在使用 Spring Boot 进行集成测试时，@Sql 注解是一个非常有用的工具，它可以帮助我们在测试之前或之后执行 SQL 脚本，从而准备测试数据或清理测试环境。通常，我们可以直接指定需要执行的 SQL 脚本文件，例如：

@Sql(scripts = "/folder/my_favourite_script.sql")
@Test
public void myTest() {
  // 测试逻辑
}

登录后复制

但是，如果我们需要执行某个目录下所有的 SQL 脚本文件，@Sql 注解本身并不支持使用掩码（例如 /folder/*.sql）来一次性指定多个文件。直接使用掩码会导致 CannotReadScriptException 异常，因为 Spring 无法找到名为 /folder/*.sql 的文件。

针对这个问题，我们可以考虑以下两种解决方案：

方案一：针对 PostgreSQL 数据库，通过编程方式执行脚本

如果你的测试环境中使用的是 PostgreSQL 数据库，可以通过编程方式读取指定目录下的所有 SQL 脚本文件，并逐个执行。这种方式的灵活性更高，可以自定义文件过滤规则和执行逻辑。

首先，我们需要注入 DataSource 对象：

@Autowired
private DataSource dataSource;

登录后复制

然后，我们可以编写一个方法来读取指定目录下的所有 SQL 脚本文件，并使用 JdbcTemplate 执行这些脚本。

import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.datasource.init.ScriptUtils;

import javax.sql.DataSource;
import java.io.IOException;
import java.sql.Connection;
import java.sql.SQLException;

public class SqlScriptExecutor {

    public static void executeScripts(DataSource dataSource, String locationPattern) throws IOException, SQLException {
        PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        Resource[] resources = resolver.getResources(locationPattern);

        try (Connection connection = dataSource.getConnection()) {
            connection.setAutoCommit(false); // 开启事务，保证数据一致性

            for (Resource resource : resources) {
                try {
                    ScriptUtils.executeSqlScript(connection, resource);
                } catch (Exception e) {
                    connection.rollback();
                    throw new RuntimeException("Failed to execute script: " + resource.getFilename(), e);
                }
            }

            connection.commit(); // 提交事务
        }
    }
}

登录后复制

在这个方法中，我们使用了 PathMatchingResourcePatternResolver 来根据指定的路径模式查找所有匹配的资源文件。然后，我们遍历这些资源文件，并使用 ScriptUtils.executeSqlScript 方法执行每个 SQL 脚本。为了保证数据一致性，我们开启了事务，并在执行过程中发生异常时回滚事务。

最后，在测试方法中调用 executeScripts 方法：

码上飞

码上飞（CodeFlying）是一款AI自动化开发平台，通过自然语言描述即可自动生成完整应用程序。

138

查看详情

@Test
public void myTest() throws IOException, SQLException {
    SqlScriptExecutor.executeScripts(dataSource, "classpath:/folder/*.sql");
    // 测试逻辑
}

登录后复制

注意事项：

locationPattern 参数指定了 SQL 脚本文件的路径模式，例如 classpath:/folder/*.sql。
确保你的 SQL 脚本文件都位于 classpath 下的 /folder 目录中。
这种方法需要手动管理事务，确保数据一致性。

方案二：针对 H2 数据库，使用 RUNSCRIPT 命令

如果你的测试环境中使用的是 H2 数据库，可以使用 RUNSCRIPT 命令来执行多个 SQL 脚本文件。RUNSCRIPT 命令可以将多个 SQL 脚本文件合并到一个文件中执行。

首先，创建一个名为 scripts.sql 的文件，并将以下内容添加到该文件中：

RUNSCRIPT FROM 'file1.sql';
RUNSCRIPT FROM 'file2.sql';
-- ...
RUNSCRIPT FROM 'fileN.sql';

登录后复制

将 file1.sql、file2.sql 等替换为实际的 SQL 脚本文件名。确保这些文件都位于 classpath 下的同一目录中。

然后，使用 @Sql 注解指定 scripts.sql 文件：

@Sql("scripts.sql")
@Test
public void myTest() {
  // 测试逻辑
}

登录后复制

注意事项：

scripts.sql 文件必须位于 classpath 下。
RUNSCRIPT 命令中的文件名必须是相对于 scripts.sql 文件的相对路径。
这种方法只适用于 H2 数据库。

总结

虽然 @Sql 注解本身不支持使用掩码来指定多个 SQL 脚本文件，但我们可以通过编程方式或使用数据库特定的命令来实现类似的功能。选择哪种方案取决于你的测试环境和具体需求。如果使用的是 PostgreSQL 数据库，建议使用编程方式，因为这种方式的灵活性更高。如果使用的是 H2 数据库，可以使用 RUNSCRIPT 命令，这种方式更简单。

以上就是使用 Spring Boot Test @Sql 注解通过掩码描述文件的详细内容，更多请关注php中文网其它相关文章！