事务管理

在 TestContext 框架中，事务由 TransactionalTestExecutionListener 管理，它是默认配置的，即使你没有在测试类上显式声明 @TestExecutionListeners。然而，要启用事务支持，你必须在通过 @ContextConfiguration 语义加载的 ApplicationContext 中配置一个 PlatformTransactionManager bean（更多细节稍后提供）。此外，你必须在测试的类级别或方法级别声明 Spring 的 @Transactional 注解。

测试管理的事务

测试管理的事务是通过 TransactionalTestExecutionListener 声明式管理的事务，或者通过 TestTransaction 编程式管理的事务（稍后描述）。你不应将这类事务与 Spring 管理的事务（由 Spring 在加载用于测试的 ApplicationContext 中直接管理）或应用管理的事务（在被测试调用的应用代码中编程式管理）混淆。Spring 管理的事务和应用管理的事务通常会参与到测试管理的事务中。然而，如果 Spring 管理的事务或应用管理的事务配置的传播类型不是 REQUIRED 或 SUPPORTS，则应谨慎使用（有关详情，请参见事务传播的讨论）。

抢占式超时和测试管理的事务

在使用测试框架中的任何形式的抢占式超时与 Spring 的测试管理的事务结合时，必须谨慎。

具体来说，Spring 的测试支持在调用当前测试方法*之前*，会将事务状态绑定到当前线程（通过 java.lang.ThreadLocal 变量）。如果测试框架为了支持抢占式超时而在新线程中调用当前测试方法，则在当前测试方法中执行的任何操作将*不会*在测试管理的事务中被调用。因此，任何此类操作的结果将不会随测试管理的事务一起回滚。相反，即使 Spring 正确地回滚了测试管理的事务，这些操作仍会提交到持久化存储——例如，关系型数据库。

可能发生这种情况的情况包括但不限于以下几种。

  • JUnit 4 的 @Test(timeout = …​) 支持和 TimeOut 规则

  • JUnit Jupiter 的 org.junit.jupiter.api.Assertions 类中的 assertTimeoutPreemptively(…​) 方法

  • TestNG 的 @Test(timeOut = …​) 支持

启用和禁用事务

使用 @Transactional 注解测试方法会导致测试在事务中运行，该事务默认在测试完成后自动回滚。如果测试类使用 @Transactional 注解，则该类层次结构中的每个测试方法都在一个事务中运行。未注解 @Transactional（在类或方法级别）的测试方法不在事务中运行。请注意，@Transactional 不支持测试生命周期方法——例如，注解了 JUnit Jupiter 的 @BeforeAll、@BeforeEach 等方法。此外，注解了 @Transactional 但将 propagation 属性设置为 NOT_SUPPORTED 或 NEVER 的测试也不在事务中运行。

表 1. @Transactional 属性支持
属性 测试管理的事务支持

value 和 transactionManager

是

propagation

仅支持 Propagation.NOT_SUPPORTED 和 Propagation.NEVER

isolation

否

timeout

否

readOnly

否

rollbackFor 和 rollbackForClassName

否：请改用 TestTransaction.flagForRollback()

noRollbackFor 和 noRollbackForClassName

否：请改用 TestTransaction.flagForCommit()

方法级别的生命周期方法——例如，注解了 JUnit Jupiter 的 @BeforeEach 或 @AfterEach 的方法——在测试管理的事务中运行。另一方面，套件级别和类级别的生命周期方法——例如，注解了 JUnit Jupiter 的 @BeforeAll 或 @AfterAll 的方法，以及注解了 TestNG 的 @BeforeSuite, @AfterSuite, @BeforeClass, 或 @AfterClass 的方法——*不在*测试管理的事务中运行。

如果你需要在套件级别或类级别的生命周期方法中运行事务内的代码，你可能希望将相应的 PlatformTransactionManager 注入到你的测试类中，然后结合 TransactionTemplate 使用它来进行编程式事务管理。

请注意，AbstractTransactionalJUnit4SpringContextTests 和 AbstractTransactionalTestNGSpringContextTests 在类级别预配置了事务支持。

以下示例演示了为基于 Hibernate 的 UserRepository 编写集成测试的常见场景

  • Java

  • Kotlin

@SpringJUnitConfig(TestConfig.class)
@Transactional
class HibernateUserRepositoryTests {

	@Autowired
	HibernateUserRepository repository;

	@Autowired
	SessionFactory sessionFactory;

	JdbcTemplate jdbcTemplate;

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

	@Test
	void createUser() {
		// track initial state in test database:
		final int count = countRowsInTable("user");

		User user = new User(...);
		repository.save(user);

		// Manual flush is required to avoid false positive in test
		sessionFactory.getCurrentSession().flush();
		assertNumUsers(count + 1);
	}

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

	private void assertNumUsers(int expected) {
		assertEquals("Number of rows in the [user] table.", expected, countRowsInTable("user"));
	}
}
@SpringJUnitConfig(TestConfig::class)
@Transactional
class HibernateUserRepositoryTests {

	@Autowired
	lateinit var repository: HibernateUserRepository

	@Autowired
	lateinit var sessionFactory: SessionFactory

	lateinit var jdbcTemplate: JdbcTemplate

	@Autowired
	fun setDataSource(dataSource: DataSource) {
		this.jdbcTemplate = JdbcTemplate(dataSource)
	}

	@Test
	fun createUser() {
		// track initial state in test database:
		val count = countRowsInTable("user")

		val user = User()
		repository.save(user)

		// Manual flush is required to avoid false positive in test
		sessionFactory.getCurrentSession().flush()
		assertNumUsers(count + 1)
	}

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

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

如事务回滚和提交行为中所解释，在 createUser() 方法运行后无需清理数据库，因为对数据库所做的任何更改都会由 TransactionalTestExecutionListener 自动回滚。

事务回滚和提交行为

默认情况下，测试事务会在测试完成后自动回滚；然而，事务的提交和回滚行为可以通过 @Commit 和 @Rollback 注解声明式配置。更多详情请参见注解支持部分中的相应条目。

编程式事务管理

你可以通过使用 TestTransaction 中的静态方法来编程式地与测试管理的事务进行交互。例如，你可以在测试方法、前置方法和后置方法中使用 TestTransaction 来启动或结束当前测试管理的事务，或者配置当前测试管理的事务以进行回滚或提交。只要启用了 TransactionalTestExecutionListener，对 TestTransaction 的支持就会自动可用。

以下示例演示了 TestTransaction 的一些功能。更多详情请参见TestTransaction 的 Javadoc。

  • Java

  • Kotlin

@ContextConfiguration(classes = TestConfig.class)
public class ProgrammaticTransactionManagementTests extends
		AbstractTransactionalJUnit4SpringContextTests {

	@Test
	public void transactionalTest() {
		// assert initial state in test database:
		assertNumUsers(2);

		deleteFromTables("user");

		// changes to the database will be committed!
		TestTransaction.flagForCommit();
		TestTransaction.end();
		assertFalse(TestTransaction.isActive());
		assertNumUsers(0);

		TestTransaction.start();
		// perform other actions against the database that will
		// be automatically rolled back after the test completes...
	}

	protected void assertNumUsers(int expected) {
		assertEquals("Number of rows in the [user] table.", expected, countRowsInTable("user"));
	}
}
@ContextConfiguration(classes = [TestConfig::class])
class ProgrammaticTransactionManagementTests : AbstractTransactionalJUnit4SpringContextTests() {

	@Test
	fun transactionalTest() {
		// assert initial state in test database:
		assertNumUsers(2)

		deleteFromTables("user")

		// changes to the database will be committed!
		TestTransaction.flagForCommit()
		TestTransaction.end()
		assertFalse(TestTransaction.isActive())
		assertNumUsers(0)

		TestTransaction.start()
		// perform other actions against the database that will
		// be automatically rolled back after the test completes...
	}

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

在事务外部运行代码

有时，你可能需要在事务性测试方法之前或之后，但在事务上下文之外运行某些代码——例如，在运行测试之前验证数据库的初始状态，或在测试运行后验证预期的事务提交行为（如果测试配置为提交事务）。TransactionalTestExecutionListener 支持 @BeforeTransaction 和 @AfterTransaction 注解，正是为了应对这些场景。你可以使用其中一个注解来注解测试类中的任何 void 方法，或者测试接口中的任何 void 默认方法，TransactionalTestExecutionListener 会确保你的事务前方法或事务后方法在适当的时间运行。

一般来说，@BeforeTransaction 和 @AfterTransaction 方法不能接受任何参数。

然而，自 Spring Framework 6.1 起，对于使用 JUnit Jupiter 结合 SpringExtension 的测试，@BeforeTransaction 和 @AfterTransaction 方法可以选择接受参数，这些参数将由任何注册的 JUnit ParameterResolver 扩展（例如 SpringExtension）解析。这意味着可以将 JUnit 特定的参数（如 TestInfo 或测试 ApplicationContext 中的 bean）提供给 @BeforeTransaction 和 @AfterTransaction 方法，如下例所示。

  • Java

  • Kotlin

@BeforeTransaction
void verifyInitialDatabaseState(@Autowired DataSource dataSource) {
	// Use the DataSource to verify the initial state before a transaction is started
}
@BeforeTransaction
fun verifyInitialDatabaseState(@Autowired dataSource: DataSource) {
	// Use the DataSource to verify the initial state before a transaction is started
}

任何前置方法（例如，注解了 JUnit Jupiter 的 @BeforeEach 的方法）和任何后置方法（例如，注解了 JUnit Jupiter 的 @AfterEach 的方法）都在事务性测试方法的测试管理的事务中运行。

类似地，注解了 @BeforeTransaction 或 @AfterTransaction 的方法仅对事务性测试方法运行。

配置事务管理器

TransactionalTestExecutionListener 要求在测试的 Spring ApplicationContext 中定义一个 PlatformTransactionManager bean。如果在测试的 ApplicationContext 中有多个 PlatformTransactionManager 实例，你可以通过使用 @Transactional(\"myTxMgr\") 或 @Transactional(transactionManager = \"myTxMgr\") 声明限定符，或者由一个 @Configuration 类实现 TransactionManagementConfigurer。有关在测试的 ApplicationContext 中查找事务管理器的算法详情，请查阅TestContextTransactionUtils.retrieveTransactionManager() 的 Javadoc。

所有事务相关注解的演示

以下基于 JUnit Jupiter 的示例展示了一个虚构的集成测试场景，突出显示了所有与事务相关的注解。此示例无意于展示最佳实践，而是为了演示这些注解如何使用。更多信息和配置示例请参阅注解支持部分。@Sql 的事务管理包含另一个示例，该示例使用 @Sql 进行声明式 SQL 脚本执行，具有默认的事务回滚语义。以下示例显示了相关注解

  • Java

  • Kotlin

@SpringJUnitConfig
@Transactional(transactionManager = "txMgr")
@Commit
class FictitiousTransactionalTest {

	@BeforeTransaction
	void verifyInitialDatabaseState() {
		// logic to verify the initial state before a transaction is started
	}

	@BeforeEach
	void setUpTestDataWithinTransaction() {
		// set up test data within the transaction
	}

	@Test
	// overrides the class-level @Commit setting
	@Rollback
	void modifyDatabaseWithinTransaction() {
		// logic which uses the test data and modifies database state
	}

	@AfterEach
	void tearDownWithinTransaction() {
		// run "tear down" logic within the transaction
	}

	@AfterTransaction
	void verifyFinalDatabaseState() {
		// logic to verify the final state after transaction has rolled back
	}

}
@SpringJUnitConfig
@Transactional(transactionManager = "txMgr")
@Commit
class FictitiousTransactionalTest {

	@BeforeTransaction
	fun verifyInitialDatabaseState() {
		// logic to verify the initial state before a transaction is started
	}

	@BeforeEach
	fun setUpTestDataWithinTransaction() {
		// set up test data within the transaction
	}

	@Test
	// overrides the class-level @Commit setting
	@Rollback
	fun modifyDatabaseWithinTransaction() {
		// logic which uses the test data and modifies database state
	}

	@AfterEach
	fun tearDownWithinTransaction() {
		// run "tear down" logic within the transaction
	}

	@AfterTransaction
	fun verifyFinalDatabaseState() {
		// logic to verify the final state after transaction has rolled back
	}

}
测试 ORM 代码时避免假阳性

当你测试操作 Hibernate 会话或 JPA 持久化上下文状态的应用代码时，请务必在运行该代码的测试方法中刷新底层工作单元。未能刷新底层工作单元可能会产生假阳性：你的测试通过了，但在真实的生产环境中相同的代码会抛出异常。请注意，这适用于任何维护内存中工作单元的 ORM 框架。在以下基于 Hibernate 的示例测试用例中，一个方法演示了假阳性，另一个方法正确地展示了刷新会话的结果

  • Java

  • Kotlin

// ...

@Autowired
SessionFactory sessionFactory;

@Transactional
@Test // no expected exception!
public void falsePositive() {
	updateEntityInHibernateSession();
	// False positive: an exception will be thrown once the Hibernate
	// Session is finally flushed (i.e., in production code)
}

@Transactional
@Test(expected = ...)
public void updateWithSessionFlush() {
	updateEntityInHibernateSession();
	// Manual flush is required to avoid false positive in test
	sessionFactory.getCurrentSession().flush();
}

// ...
// ...

@Autowired
lateinit var sessionFactory: SessionFactory

@Transactional
@Test // no expected exception!
fun falsePositive() {
	updateEntityInHibernateSession()
	// False positive: an exception will be thrown once the Hibernate
	// Session is finally flushed (i.e., in production code)
}

@Transactional
@Test(expected = ...)
fun updateWithSessionFlush() {
	updateEntityInHibernateSession()
	// Manual flush is required to avoid false positive in test
	sessionFactory.getCurrentSession().flush()
}

// ...

以下示例显示了 JPA 的对应方法

  • Java

  • Kotlin

// ...

@PersistenceContext
EntityManager entityManager;

@Transactional
@Test // no expected exception!
public void falsePositive() {
	updateEntityInJpaPersistenceContext();
	// False positive: an exception will be thrown once the JPA
	// EntityManager is finally flushed (i.e., in production code)
}

@Transactional
@Test(expected = ...)
public void updateWithEntityManagerFlush() {
	updateEntityInJpaPersistenceContext();
	// Manual flush is required to avoid false positive in test
	entityManager.flush();
}

// ...
// ...

@PersistenceContext
lateinit var entityManager:EntityManager

@Transactional
@Test // no expected exception!
fun falsePositive() {
	updateEntityInJpaPersistenceContext()
	// False positive: an exception will be thrown once the JPA
	// EntityManager is finally flushed (i.e., in production code)
}

@Transactional
@Test(expected = ...)
void updateWithEntityManagerFlush() {
	updateEntityInJpaPersistenceContext()
	// Manual flush is required to avoid false positive in test
	entityManager.flush()
}

// ...
测试 ORM 实体生命周期回调

与关于测试 ORM 代码时避免假阳性的注意事项类似，如果你的应用使用了实体生命周期回调（也称为实体监听器），请务必在运行该代码的测试方法中刷新底层工作单元。未能*刷新*或*清除*底层工作单元可能导致某些生命周期回调不被调用。

例如，使用 JPA 时，除非在保存或更新实体后调用了 entityManager.flush()，否则不会调用 @PostPersist、@PreUpdate 和 @PostUpdate 回调。类似地，如果一个实体已经附加到当前工作单元（与当前持久化上下文关联），除非在尝试重新加载实体之前调用了 entityManager.clear()，否则重新加载实体的尝试不会导致 @PostLoad 回调。

以下示例展示了如何刷新 EntityManager 以确保实体被持久化时调用 @PostPersist 回调。示例中使用的 Person 实体已注册了一个带有 @PostPersist 回调方法的实体监听器。

  • Java

  • Kotlin

// ...

@Autowired
JpaPersonRepository repo;

@PersistenceContext
EntityManager entityManager;

@Transactional
@Test
void savePerson() {
	// EntityManager#persist(...) results in @PrePersist but not @PostPersist
	repo.save(new Person("Jane"));

	// Manual flush is required for @PostPersist callback to be invoked
	entityManager.flush();

	// Test code that relies on the @PostPersist callback
	// having been invoked...
}

// ...
// ...

@Autowired
lateinit var repo: JpaPersonRepository

@PersistenceContext
lateinit var entityManager: EntityManager

@Transactional
@Test
fun savePerson() {
	// EntityManager#persist(...) results in @PrePersist but not @PostPersist
	repo.save(Person("Jane"))

	// Manual flush is required for @PostPersist callback to be invoked
	entityManager.flush()

	// Test code that relies on the @PostPersist callback
	// having been invoked...
}

// ...

有关使用所有 JPA 生命周期回调的实际示例，请参阅 Spring Framework 测试套件中的JpaEntityListenerTests。