本文介绍如何在 Spring Boot 测试中将 SQL 初始化脚本集中定义并复用于多个测试类，避免重复声明 @Sql，实现跨测试类的共享数据预加载。
本文介绍如何在 spring boot 测试中将 sql 初始化脚本集中定义并复用于多个测试类，避免重复声明 `@sql`，实现跨测试类的共享数据预加载。
在 Spring 测试生态中，@Sql 注解常用于单个测试类或方法级别执行 SQL 脚本（如插入测试数据、清空表等），但若需在多个测试类间统一、自动、前置地执行相同的数据初始化逻辑，直接在 @Configuration 类中声明 @Sql 是不可行的——因为 @Sql 仅支持作用于测试类或方法，无法被 @Configuration 或 @Import 加载生效。
✅ 正确且简洁的解决方案是：利用测试类继承机制，将 @Sql 声明在公共基类中，再让各测试类继承该基类。Spring Test 会自动识别并执行基类上的 @Sql（包括 scripts、statements、executionPhase 等配置），确保所有子类测试方法运行前完成数据准备。
以下是一个推荐实践示例：
// 公共测试基类 —— 所有需要预置数据的测试类均继承它
@DataJpaTest
@Sql(statements = {
"INSERT INTO customer (name, email) VALUES ('Alice', 'alice@example.com');",
"INSERT INTO customer (name, email) VALUES ('Bob', 'bob@example.com');"
}, executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD)
public class DatabaseTestBase {
// 可在此注入通用依赖（如 TestEntityManager），供子类复用
}
// 具体业务测试类 —— 无需重复声明 @Sql，自动继承初始化逻辑
class CustomerRepositoryTests extends DatabaseTestBase {
@Autowired
private TestEntityManager entityManager;
@Test
void shouldFindCustomerByName() {
Customer found = entityManager.getEntityManager()
.createQuery("SELECT c FROM Customer c WHERE c.name = 'Alice'", Customer.class)
.getSingleResult();
assertThat(found.getEmail()).isEqualTo("alice@example.com");
}
}
⚠️ 注意事项：
- @Sql 在基类中生效的前提是：子类必须显式继承该基类（而非仅 @Import 配置类）；
- 若使用 @Sql(scripts = "classpath:/init-data.sql")，请确保 SQL 文件路径对所有子类可见（建议放在 src/test/resources 下）；
- 推荐配合 executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD（默认值），确保每次测试方法执行前重置数据；如需全局一次初始化，可设为 BEFORE_CLASS，但需注意测试间状态隔离风险；
- 若项目采用 JUnit 5，仍兼容此方案（@DataJpaTest 底层基于 JUnit Jupiter 支持继承链解析）；
- 不建议用 @PostConstruct 或 @Bean 方法执行 SQL —— 它们运行在 Spring 上下文启动阶段，此时 DataSource 可能未完成事务配置，且无法保证执行时机早于测试方法。
总结：虽然 Spring 并未提供“@Sql + @Configuration”的原生组合方式，但通过面向对象的继承设计，我们以零配置成本实现了测试数据初始化逻辑的集中管理与跨类复用，既符合测试可维护性原则，也完全兼容 Spring Boot Test 的生命周期语义。
