执行SQL脚本

在针对关系型数据库编写集成测试时，运行 SQL 脚本以修改数据库模式或将测试数据插入表中通常很有益。spring-jdbc 模块提供支持，通过在 Spring ApplicationContext 加载时执行 SQL 脚本，来初始化嵌入式或现有数据库。有关详细信息，请参阅嵌入式数据库支持 和 使用嵌入式数据库测试数据访问逻辑。

虽然在加载 ApplicationContext 时一次初始化数据库对于测试非常有用，但有时在集成测试期间修改数据库至关重要。以下部分解释了如何在集成测试期间以编程方式和声明式地运行 SQL 脚本。

以编程方式执行 SQL 脚本

Spring 提供以下选项，用于在集成测试方法中以编程方式执行 SQL 脚本。

  • org.springframework.jdbc.datasource.init.ScriptUtils

  • org.springframework.jdbc.datasource.init.ResourceDatabasePopulator

  • org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests

  • org.springframework.test.context.testng.AbstractTransactionalTestNGSpringContextTests

ScriptUtils 提供了一组用于处理 SQL 脚本的静态实用程序方法，主要用于框架内部使用。但是，如果您需要完全控制如何解析和运行 SQL 脚本，ScriptUtils 可能比后面描述的其他一些替代方案更适合您的需求。有关 ScriptUtils 中各个方法的更多详细信息，请参阅 javadoc。

ResourceDatabasePopulator 提供了一个基于对象的 API，用于通过使用外部资源中定义的 SQL 脚本以编程方式填充、初始化或清理数据库。ResourceDatabasePopulator 提供了用于配置解析和运行脚本时使用的字符编码、语句分隔符、注释分隔符和错误处理标志的选项。每个配置选项都有一个合理的默认值。有关默认值的详细信息，请参阅 javadoc。要运行在 ResourceDatabasePopulator 中配置的脚本，您可以调用 populate(Connection) 方法以针对 java.sql.Connection 运行填充器，或者调用 execute(DataSource) 方法以针对 javax.sql.DataSource 运行填充器。以下示例指定了测试模式和测试数据的 SQL 脚本，将语句分隔符设置为 @@，并针对 DataSource 运行脚本

  • Java

  • Kotlin

@Test
void databaseTest() {
	ResourceDatabasePopulator populator = new ResourceDatabasePopulator();
	populator.addScripts(
			new ClassPathResource("test-schema.sql"),
			new ClassPathResource("test-data.sql"));
	populator.setSeparator("@@");
	populator.execute(this.dataSource);
	// run code that uses the test schema and data
}
@Test
fun databaseTest() {
	val populator = ResourceDatabasePopulator()
	populator.addScripts(
			ClassPathResource("test-schema.sql"),
			ClassPathResource("test-data.sql"))
	populator.setSeparator("@@")
	populator.execute(dataSource)
	// run code that uses the test schema and data
}

请注意，ResourceDatabasePopulator 在内部委托给 ScriptUtils 来解析和运行 SQL 脚本。类似地，AbstractTransactionalJUnit4SpringContextTests 和 AbstractTransactionalTestNGSpringContextTests 中的 executeSqlScript(..) 方法在内部使用 ResourceDatabasePopulator 来运行 SQL 脚本。有关更多详细信息，请参阅各个 executeSqlScript(..) 方法的 Javadoc。

使用 @Sql 声明式执行 SQL 脚本

除了上述以编程方式运行 SQL 脚本的机制外，您还可以在 Spring TestContext 框架中声明式地配置 SQL 脚本。具体来说，您可以在测试类或测试方法上声明 @Sql 注解，以配置单个 SQL 语句或 SQL 脚本的资源路径，这些脚本应该在集成测试类或测试方法之前或之后针对给定数据库运行。@Sql 的支持由 SqlScriptsTestExecutionListener 提供，该监听器默认启用。

默认情况下，方法级别的 @Sql 声明会覆盖类级别的声明，但此行为可以通过 @SqlMergeMode 在每个测试类或每个测试方法中进行配置。有关更多详细信息，请参阅 使用 @SqlMergeMode 合并和覆盖配置。

但是，这并不适用于为 BEFORE_TEST_CLASS 或 AFTER_TEST_CLASS 执行阶段配置的类级别声明。此类声明无法被覆盖，并且相应的脚本和语句将在每个类中执行一次，此外还有任何方法级别的脚本和语句。

路径资源语义

每个路径都被解释为 Spring Resource。一个简单的路径（例如，"schema.sql"）被视为相对于定义测试类的包的类路径资源。以斜杠开头的路径被视为绝对类路径资源（例如，"/org/example/schema.sql"）。引用 URL 的路径（例如，以 classpath:、file:、http: 为前缀的路径）通过使用指定的资源协议加载。

以下示例展示了如何在基于 JUnit Jupiter 的集成测试类中，在类级别和方法级别使用 @Sql

  • Java

  • Kotlin

@SpringJUnitConfig
@Sql("/test-schema.sql")
class DatabaseTests {

	@Test
	void emptySchemaTest() {
		// run code that uses the test schema without any test data
	}

	@Test
	@Sql({"/test-schema.sql", "/test-user-data.sql"})
	void userTest() {
		// run code that uses the test schema and test data
	}
}
@SpringJUnitConfig
@Sql("/test-schema.sql")
class DatabaseTests {

	@Test
	fun emptySchemaTest() {
		// run code that uses the test schema without any test data
	}

	@Test
	@Sql("/test-schema.sql", "/test-user-data.sql")
	fun userTest() {
		// run code that uses the test schema and test data
	}
}

默认脚本检测

如果未指定任何 SQL 脚本或语句，则会尝试检测 default 脚本，具体取决于 @Sql 的声明位置。如果无法检测到默认脚本，则会抛出 IllegalStateException。

  • 类级别声明：如果带注释的测试类是com.example.MyTest，则相应的默认脚本是classpath:com/example/MyTest.sql。

  • 方法级别声明：如果带注释的测试方法名为testMethod()，并且定义在类com.example.MyTest中，则相应的默认脚本是classpath:com/example/MyTest.testMethod.sql。

记录 SQL 脚本和语句

如果要查看正在执行哪些 SQL 脚本，请将org.springframework.test.context.jdbc日志类别设置为DEBUG。

如果要查看正在执行哪些 SQL 语句，请将org.springframework.jdbc.datasource.init日志类别设置为DEBUG。

声明多个@Sql集

如果需要为给定的测试类或测试方法配置多个 SQL 脚本集，但每个集具有不同的语法配置、不同的错误处理规则或不同的执行阶段，则可以声明多个@Sql实例。您可以使用@Sql作为可重复注释，也可以使用@SqlGroup注释作为显式容器来声明多个@Sql实例。

以下示例展示了如何使用@Sql作为可重复注释

  • Java

  • Kotlin

@Test
@Sql(scripts = "/test-schema.sql", config = @SqlConfig(commentPrefix = "`"))
@Sql("/test-user-data.sql")
void userTest() {
	// run code that uses the test schema and test data
}
@Test
@Sql("/test-schema.sql", config = SqlConfig(commentPrefix = "`"))
@Sql("/test-user-data.sql")
fun userTest() {
	// run code that uses the test schema and test data
}

在前面的示例中展示的场景中，test-schema.sql脚本使用不同的语法来表示单行注释。

以下示例与前面的示例相同，只是@Sql声明在@SqlGroup中分组在一起。使用@SqlGroup是可选的，但您可能需要使用@SqlGroup才能与其他 JVM 语言兼容。

  • Java

  • Kotlin

@Test
@SqlGroup({
	@Sql(scripts = "/test-schema.sql", config = @SqlConfig(commentPrefix = "`")),
	@Sql("/test-user-data.sql")
)}
void userTest() {
	// run code that uses the test schema and test data
}
@Test
@SqlGroup(
	Sql("/test-schema.sql", config = SqlConfig(commentPrefix = "`")),
	Sql("/test-user-data.sql")
)
fun userTest() {
	// Run code that uses the test schema and test data
}

脚本执行阶段

默认情况下，SQL 脚本在相应的测试方法之前运行。但是，如果您需要在测试方法之后运行特定的脚本集（例如，清理数据库状态），则可以将@Sql中的executionPhase属性设置为AFTER_TEST_METHOD，如下面的示例所示

  • Java

  • Kotlin

@Test
@Sql(
	scripts = "create-test-data.sql",
	config = @SqlConfig(transactionMode = ISOLATED)
)
@Sql(
	scripts = "delete-test-data.sql",
	config = @SqlConfig(transactionMode = ISOLATED),
	executionPhase = AFTER_TEST_METHOD
)
void userTest() {
	// run code that needs the test data to be committed
	// to the database outside of the test's transaction
}
@Test
@Sql("create-test-data.sql",
	config = SqlConfig(transactionMode = ISOLATED))
@Sql("delete-test-data.sql",
	config = SqlConfig(transactionMode = ISOLATED),
	executionPhase = AFTER_TEST_METHOD)
fun userTest() {
	// run code that needs the test data to be committed
	// to the database outside of the test's transaction
}
ISOLATED和AFTER_TEST_METHOD分别从Sql.TransactionMode和Sql.ExecutionPhase中静态导入。

从 Spring Framework 6.1 开始，可以通过将类级别@Sql声明中的executionPhase属性设置为BEFORE_TEST_CLASS或AFTER_TEST_CLASS，来在测试类之前或之后运行特定的脚本集，如下面的示例所示

  • Java

  • Kotlin

@SpringJUnitConfig
@Sql(scripts = "/test-schema.sql", executionPhase = BEFORE_TEST_CLASS)
class DatabaseTests {

	@Test
	void emptySchemaTest() {
		// run code that uses the test schema without any test data
	}

	@Test
	@Sql("/test-user-data.sql")
	void userTest() {
		// run code that uses the test schema and test data
	}
}
@SpringJUnitConfig
@Sql("/test-schema.sql", executionPhase = BEFORE_TEST_CLASS)
class DatabaseTests {

	@Test
	fun emptySchemaTest() {
		// run code that uses the test schema without any test data
	}

	@Test
	@Sql("/test-user-data.sql")
	fun userTest() {
		// run code that uses the test schema and test data
	}
}
BEFORE_TEST_CLASS从Sql.ExecutionPhase中静态导入。

使用@SqlConfig配置脚本

您可以使用 @SqlConfig 注解配置脚本解析和错误处理。当在集成测试类上声明为类级注解时，@SqlConfig 充当测试类层次结构中所有 SQL 脚本的全局配置。当使用 @Sql 注解的 config 属性直接声明时，@SqlConfig 充当封闭 @Sql 注解中声明的 SQL 脚本的本地配置。@SqlConfig 中的每个属性都有一个隐式默认值，该值在相应属性的 javadoc 中有记录。由于 Java 语言规范中定义的注解属性规则，不幸的是，无法将 null 值分配给注解属性。因此，为了支持对继承的全局配置进行覆盖，@SqlConfig 属性具有显式默认值，要么是 ""（对于字符串），要么是 {}（对于数组），要么是 DEFAULT（对于枚举）。这种方法允许本地声明的 @SqlConfig 通过提供除 ""、{} 或 DEFAULT 之外的值来选择性地覆盖来自全局声明的 @SqlConfig 的各个属性。只要本地 @SqlConfig 属性没有提供除 ""、{} 或 DEFAULT 之外的显式值，就会继承全局 @SqlConfig 属性。因此，显式本地配置会覆盖全局配置。

@Sql 和 @SqlConfig 提供的配置选项等效于 ScriptUtils 和 ResourceDatabasePopulator 支持的选项，但它们是 <jdbc:initialize-database/> XML 命名空间元素提供的选项的超集。有关详细信息，请参阅 @Sql 和 @SqlConfig 中各个属性的 javadoc。

@Sql 的事务管理

默认情况下，SqlScriptsTestExecutionListener 会推断使用 @Sql 配置的脚本所需的交易语义。具体来说，SQL 脚本是在没有事务的情况下运行的，在现有的 Spring 管理的事务中运行（例如，由 TransactionalTestExecutionListener 为使用 @Transactional 注解的测试管理的事务），或者在隔离的事务中运行，具体取决于 @SqlConfig 中 transactionMode 属性的配置值以及测试的 ApplicationContext 中是否存在 PlatformTransactionManager。但是，至少测试的 ApplicationContext 中必须存在 javax.sql.DataSource。

如果 SqlScriptsTestExecutionListener 用于检测 DataSource 和 PlatformTransactionManager 并推断事务语义的算法不适合您的需求，您可以通过设置 @SqlConfig 的 dataSource 和 transactionManager 属性来指定显式名称。此外，您可以通过设置 @SqlConfig 的 transactionMode 属性来控制事务传播行为（例如，脚本是否应该在隔离的事务中运行）。虽然本文档无法详细讨论使用 @Sql 进行事务管理的所有支持选项，但 @SqlConfig 和 SqlScriptsTestExecutionListener 的 javadoc 提供了详细的信息，以下示例展示了一个使用 JUnit Jupiter 和事务性测试以及 @Sql 的典型测试场景。

  • Java

  • Kotlin

@SpringJUnitConfig(TestDatabaseConfig.class)
@Transactional
class TransactionalSqlScriptsTests {

	final JdbcTemplate jdbcTemplate;

	@Autowired
	TransactionalSqlScriptsTests(DataSource dataSource) {
		this.jdbcTemplate = new JdbcTemplate(dataSource);
	}

	@Test
	@Sql("/test-data.sql")
	void usersTest() {
		// verify state in test database:
		assertNumUsers(2);
		// run code that uses the test data...
	}

	int countRowsInTable(String tableName) {
		return JdbcTestUtils.countRowsInTable(this.jdbcTemplate, tableName);
	}

	void assertNumUsers(int expected) {
		assertEquals(expected, countRowsInTable("user"),
			"Number of rows in the [user] table.");
	}
}
@SpringJUnitConfig(TestDatabaseConfig::class)
@Transactional
class TransactionalSqlScriptsTests @Autowired constructor(dataSource: DataSource) {

	val jdbcTemplate: JdbcTemplate = JdbcTemplate(dataSource)

	@Test
	@Sql("/test-data.sql")
	fun usersTest() {
		// verify state in test database:
		assertNumUsers(2)
		// run code that uses the test data...
	}

	fun countRowsInTable(tableName: String): Int {
		return JdbcTestUtils.countRowsInTable(jdbcTemplate, tableName)
	}

	fun assertNumUsers(expected: Int) {
		assertEquals(expected, countRowsInTable("user"),
				"Number of rows in the [user] table.")
	}
}

请注意，在运行 usersTest() 方法后，无需清理数据库，因为对数据库所做的任何更改（无论是在测试方法中还是在 /test-data.sql 脚本中）都会被 TransactionalTestExecutionListener 自动回滚（有关详细信息，请参阅 事务管理）。

使用 @SqlMergeMode 合并和覆盖配置

从 Spring Framework 5.2 开始，可以将方法级 @Sql 声明与类级声明合并。例如，这允许您为每个测试类提供一次数据库模式或一些通用测试数据的配置，然后为每个测试方法提供额外的、特定于用例的测试数据。要启用 @Sql 合并，请使用 @SqlMergeMode(MERGE) 注释您的测试类或测试方法。要为特定测试方法（或特定测试子类）禁用合并，您可以通过 @SqlMergeMode(OVERRIDE) 切换回默认模式。有关示例和更多详细信息，请参阅 @SqlMergeMode 注释文档部分。