ARTICLE DETAIL

建站实战干货

来自一线的建站与推广经验沉淀,每一条都经过真实交付验证。

使用iBatis 库的ScriptRunner库来执行

2026/8/18 10:25:59 拓冰建站 浏览量
使用iBatis 库的ScriptRunner库来执行

ScriptRunner 是 iBatis 库的一个组件,用于执行 SQL 脚本。它可以读取 SQL 语句的文本文件并在数据库上执行这些语句。这在进行数据库初始化、单元测试或者应用数据库迁移时非常有用。ScriptRunner 提供了一种简单直接的方式来运行包含多个 SQL 语句的脚本。

特点

  1. 执行多条 SQL 语句:能够从文件中读取并执行包含多条 SQL 语句的脚本。
  2. 错误处理:能够处理脚本执行过程中出现的 SQL 异常,并继续执行后续语句。
  3. 灵活性:支持定义语句分隔符,适应不同风格的 SQL 脚本。
  4. 日志记录:可以记录脚本执行过程中的各种信息。

如何在 Spring Boot 项目中使用

添加依赖

首先确保你的项目中包含 MyBatis 依赖,因为 ScriptRunner 随 MyBatis 一起提供。

Maven 依赖示例:

<dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>你的MyBatis版本</version>
</dependency>
  1. 创建 SQL 脚本

    在你的资源目录下(如 src/main/resources),创建一个 SQL 脚本文件。例如,src/main/resources/sql/init.sql

  2. 编写执行脚本的方法

    在你的应用中,创建一个方法来使用 ScriptRunner 执行 SQL 脚本。

  3. 编写执行脚本的方法

    在你的应用中,创建一个方法来使用 ScriptRunner 执行 SQL 脚本。

import org.apache.ibatis.jdbc.ScriptRunner;
import org.springframework.beans.factory.annotation.Autowired;
import javax.sql.DataSource;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.sql.Connection;@Component
public class ScriptRunnerService {private final DataSource dataSource;@Autowiredpublic ScriptRunnerService(DataSource dataSource) {this.dataSource = dataSource;}public void runScript(String scriptPath) throws Exception {try (Connection connection = dataSource.getConnection()) {ScriptRunner runner = new ScriptRunner(connection);runner.setLogWriter(null); // 可以设置为 null 来禁用日志输出runner.runScript(new BufferedReader(new InputStreamReader(getClass().getResourceAsStream(scriptPath), StandardCharsets.UTF_8)));}}
}

这个方法会打开一个数据库连接,并使用 ScriptRunner 执行指定路径的 SQL 脚本。

在应用中使用

你现在可以在应用启动时或在需要时调用这个方法来执行 SQL 脚本。例如,你可以在单元测试的 @BeforeEach@BeforeAll 方法中调用它来初始化数据库状态。

@SpringBootTest
public class SomeTest {@Autowiredprivate ScriptRunnerService scriptRunnerService;@BeforeEachpublic void setup() throws Exception {scriptRunnerService.runScript("/sql/init.sql");}// 测试方法
}

这样,你就可以在 Spring Boot 项目中利用 ScriptRunner 执行 SQL 脚本了。这在进行单元测试或数据库初始化时非常有用,特别是当你需要在每次测试前重置数据库状态时。