执行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脚本。有关详细信息，请参见Javadoc中各种executeSqlScript(..)方法。

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

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

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

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

路径资源语义

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

从 Spring Framework 6.2 开始，路径可以包含属性占位符 (${…​})，这些占位符将被测试的ApplicationContext的Environment中存储的属性替换。

以下示例演示如何在基于 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 管理的事务中运行（例如，@Transactional注解的测试的TransactionalTestExecutionListener管理的事务），或在隔离的事务中运行，这取决于@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合并和覆盖配置

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