编程式事务管理

Spring Framework 提供了两种编程式事务管理方式，分别是使用

  • TransactionTemplate 或 TransactionalOperator。

  • 直接使用 TransactionManager 实现。

Spring 团队通常建议在命令式流程中使用 TransactionTemplate 进行编程式事务管理，并在响应式代码中使用 TransactionalOperator。第二种方法类似于使用 JTA UserTransaction API，尽管异常处理没那么麻烦。

使用 TransactionTemplate

TransactionTemplate 采用了与其他 Spring 模板（如 JdbcTemplate）相同的方法。它使用了回调方式（将应用代码从事务资源的样板式获取和释放中解放出来），并使代码意图明确，因为您的代码只关注您想做什么。

正如以下示例所示，使用 TransactionTemplate 会将您绝对地与 Spring 的事务基础设施和 API 耦合。编程式事务管理是否适合您的开发需求，这是您必须自己做出的决定。

必须在事务上下文运行并显式使用 TransactionTemplate 的应用代码类似于下一个示例。作为应用开发者，您可以编写一个 TransactionCallback 实现（通常表示为匿名内部类），其中包含需要在事务上下文中运行的代码。然后，您可以将自定义 TransactionCallback 的实例传递给 TransactionTemplate 上公开的 execute(..) 方法。以下示例展示了如何执行此操作

  • Java

  • Kotlin

public class SimpleService implements Service {

	// single TransactionTemplate shared amongst all methods in this instance
	private final TransactionTemplate transactionTemplate;

	// use constructor-injection to supply the PlatformTransactionManager
	public SimpleService(PlatformTransactionManager transactionManager) {
		this.transactionTemplate = new TransactionTemplate(transactionManager);
	}

	public Object someServiceMethod() {
		return transactionTemplate.execute(new TransactionCallback() {
			// the code in this method runs in a transactional context
			public Object doInTransaction(TransactionStatus status) {
				updateOperation1();
				return resultOfUpdateOperation2();
			}
		});
	}
}
// use constructor-injection to supply the PlatformTransactionManager
class SimpleService(transactionManager: PlatformTransactionManager) : Service {

	// single TransactionTemplate shared amongst all methods in this instance
	private val transactionTemplate = TransactionTemplate(transactionManager)

	fun someServiceMethod() = transactionTemplate.execute<Any?> {
		updateOperation1()
		resultOfUpdateOperation2()
	}
}

如果没有返回值，您可以像下面这样使用方便的 TransactionCallbackWithoutResult 类和匿名类

  • Java

  • Kotlin

transactionTemplate.execute(new TransactionCallbackWithoutResult() {
	protected void doInTransactionWithoutResult(TransactionStatus status) {
		updateOperation1();
		updateOperation2();
	}
});
transactionTemplate.execute(object : TransactionCallbackWithoutResult() {
	override fun doInTransactionWithoutResult(status: TransactionStatus) {
		updateOperation1()
		updateOperation2()
	}
})

回调中的代码可以通过调用提供的 TransactionStatus 对象的 setRollbackOnly() 方法来回滚事务，如下所示

  • Java

  • Kotlin

transactionTemplate.execute(new TransactionCallbackWithoutResult() {

	protected void doInTransactionWithoutResult(TransactionStatus status) {
		try {
			updateOperation1();
			updateOperation2();
		} catch (SomeBusinessException ex) {
			status.setRollbackOnly();
		}
	}
});
transactionTemplate.execute(object : TransactionCallbackWithoutResult() {

	override fun doInTransactionWithoutResult(status: TransactionStatus) {
		try {
			updateOperation1()
			updateOperation2()
		} catch (ex: SomeBusinessException) {
			status.setRollbackOnly()
		}
	}
})

指定事务设置

您可以通过编程方式或在配置中为 TransactionTemplate 指定事务设置（如传播模式、隔离级别、超时等）。默认情况下，TransactionTemplate 实例具有默认的事务设置。以下示例展示了对特定 TransactionTemplate 的事务设置进行编程式自定义：

  • Java

  • Kotlin

public class SimpleService implements Service {

	private final TransactionTemplate transactionTemplate;

	public SimpleService(PlatformTransactionManager transactionManager) {
		this.transactionTemplate = new TransactionTemplate(transactionManager);

		// the transaction settings can be set here explicitly if so desired
		this.transactionTemplate.setIsolationLevel(TransactionDefinition.ISOLATION_READ_UNCOMMITTED);
		this.transactionTemplate.setTimeout(30); // 30 seconds
		// and so forth...
	}
}
class SimpleService(transactionManager: PlatformTransactionManager) : Service {

	private val transactionTemplate = TransactionTemplate(transactionManager).apply {
		// the transaction settings can be set here explicitly if so desired
		isolationLevel = TransactionDefinition.ISOLATION_READ_UNCOMMITTED
		timeout = 30 // 30 seconds
		// and so forth...
	}
}

以下示例使用 Spring XML 配置定义了一个具有一些自定义事务设置的 TransactionTemplate

<bean id="sharedTransactionTemplate"
		class="org.springframework.transaction.support.TransactionTemplate">
	<property name="isolationLevelName" value="ISOLATION_READ_UNCOMMITTED"/>
	<property name="timeout" value="30"/>
</bean>

然后，您可以将 sharedTransactionTemplate 注入到所需的任意数量的服务中。

最后，TransactionTemplate 类的实例是线程安全的，因为它们不维护任何会话状态。然而，TransactionTemplate 实例确实维护配置状态。因此，虽然许多类可以共享一个 TransactionTemplate 实例，但如果一个类需要使用具有不同设置（例如，不同的隔离级别）的 TransactionTemplate，您需要创建两个不同的 TransactionTemplate 实例。

使用 TransactionalOperator

TransactionalOperator 遵循与其他响应式操作符相似的操作符设计。它使用了回调方式（将应用代码从事务资源的样板式获取和释放中解放出来），并使代码意图明确，因为您的代码只关注您想做什么。

正如以下示例所示，使用 TransactionalOperator 会将您绝对地与 Spring 的事务基础设施和 API 耦合。编程式事务管理是否适合您的开发需求，这是您必须自己做出的决定。

必须在事务上下文运行并显式使用 TransactionalOperator 的应用代码类似于下一个示例

  • Java

  • Kotlin

public class SimpleService implements Service {

	// single TransactionalOperator shared amongst all methods in this instance
	private final TransactionalOperator transactionalOperator;

	// use constructor-injection to supply the ReactiveTransactionManager
	public SimpleService(ReactiveTransactionManager transactionManager) {
		this.transactionalOperator = TransactionalOperator.create(transactionManager);
	}

	public Mono<Object> someServiceMethod() {

		// the code in this method runs in a transactional context

		Mono<Object> update = updateOperation1();

		return update.then(resultOfUpdateOperation2).as(transactionalOperator::transactional);
	}
}
// use constructor-injection to supply the ReactiveTransactionManager
class SimpleService(transactionManager: ReactiveTransactionManager) : Service {

	// single TransactionalOperator shared amongst all methods in this instance
	private val transactionalOperator = TransactionalOperator.create(transactionManager)

	suspend fun someServiceMethod() = transactionalOperator.executeAndAwait<Any?> {
		updateOperation1()
		resultOfUpdateOperation2()
	}
}

TransactionalOperator 可以通过两种方式使用

  • 操作符风格，使用 Project Reactor 类型 (mono.as(transactionalOperator::transactional))

  • 回调风格，用于所有其他情况 (transactionalOperator.execute(TransactionCallback<T>))

回调中的代码可以通过调用提供的 ReactiveTransaction 对象的 setRollbackOnly() 方法来回滚事务，如下所示

  • Java

  • Kotlin

transactionalOperator.execute(new TransactionCallback<>() {

	public Mono<Object> doInTransaction(ReactiveTransaction status) {
		return updateOperation1().then(updateOperation2)
					.doOnError(SomeBusinessException.class, e -> status.setRollbackOnly());
		}
	}
});
transactionalOperator.execute(object : TransactionCallback() {

	override fun doInTransactionWithoutResult(status: ReactiveTransaction) {
		updateOperation1().then(updateOperation2)
					.doOnError(SomeBusinessException.class, e -> status.setRollbackOnly())
	}
})

取消信号

在 Reactive Streams 中，Subscriber 可以取消其 Subscription 并停止其 Publisher。Project Reactor 以及其他库中的操作符，例如 next()、take(long)、timeout(Duration) 等，都可以发出取消信号。无法知道取消的原因，无论是由于错误还是仅仅缺乏继续消费的兴趣。从 5.3 版本开始，取消信号会导致回滚。因此，考虑事务 Publisher 的下游使用的操作符非常重要。特别是在 Flux 或其他多值 Publisher 的情况下，必须完全消费输出才能让事务完成。

指定事务设置

您可以为 TransactionalOperator 指定事务设置（如传播模式、隔离级别、超时等）。默认情况下，TransactionalOperator 实例具有默认的事务设置。以下示例展示了对特定 TransactionalOperator 的事务设置进行自定义：

  • Java

  • Kotlin

public class SimpleService implements Service {

	private final TransactionalOperator transactionalOperator;

	public SimpleService(ReactiveTransactionManager transactionManager) {
		DefaultTransactionDefinition definition = new DefaultTransactionDefinition();

		// the transaction settings can be set here explicitly if so desired
		definition.setIsolationLevel(TransactionDefinition.ISOLATION_READ_UNCOMMITTED);
		definition.setTimeout(30); // 30 seconds
		// and so forth...

		this.transactionalOperator = TransactionalOperator.create(transactionManager, definition);
	}
}
class SimpleService(transactionManager: ReactiveTransactionManager) : Service {

	private val definition = DefaultTransactionDefinition().apply {
		// the transaction settings can be set here explicitly if so desired
		isolationLevel = TransactionDefinition.ISOLATION_READ_UNCOMMITTED
		timeout = 30 // 30 seconds
		// and so forth...
	}
	private val transactionalOperator = TransactionalOperator(transactionManager, definition)
}

使用 TransactionManager

以下部分解释了命令式和响应式事务管理器的编程式用法。

使用 PlatformTransactionManager

对于命令式事务，您可以直接使用 org.springframework.transaction.PlatformTransactionManager 来管理事务。为此，通过 bean 引用将您使用的 PlatformTransactionManager 实现传递给您的 bean。然后，通过使用 TransactionDefinition 和 TransactionStatus 对象，您可以启动事务、回滚和提交。以下示例展示了如何执行此操作

  • Java

  • Kotlin

DefaultTransactionDefinition def = new DefaultTransactionDefinition();
// explicitly setting the transaction name is something that can be done only programmatically
def.setName("SomeTxName");
def.setPropagationBehavior(TransactionDefinition.PROPAGATION_REQUIRED);

TransactionStatus status = txManager.getTransaction(def);
try {
	// put your business logic here
} catch (MyException ex) {
	txManager.rollback(status);
	throw ex;
}
txManager.commit(status);
val def = DefaultTransactionDefinition()
// explicitly setting the transaction name is something that can be done only programmatically
def.setName("SomeTxName")
def.propagationBehavior = TransactionDefinition.PROPAGATION_REQUIRED

val status = txManager.getTransaction(def)
try {
	// put your business logic here
} catch (ex: MyException) {
	txManager.rollback(status)
	throw ex
}

txManager.commit(status)

使用 ReactiveTransactionManager

在使用响应式事务时，您可以直接使用 org.springframework.transaction.ReactiveTransactionManager 来管理事务。为此，通过 bean 引用将您使用的 ReactiveTransactionManager 实现传递给您的 bean。然后，通过使用 TransactionDefinition 和 ReactiveTransaction 对象，您可以启动事务、回滚和提交。以下示例展示了如何执行此操作

  • Java

  • Kotlin

DefaultTransactionDefinition def = new DefaultTransactionDefinition();
// explicitly setting the transaction name is something that can be done only programmatically
def.setName("SomeTxName");
def.setPropagationBehavior(TransactionDefinition.PROPAGATION_REQUIRED);

Mono<ReactiveTransaction> reactiveTx = txManager.getReactiveTransaction(def);

reactiveTx.flatMap(status -> {

	Mono<Object> tx = ...; // put your business logic here

	return tx.then(txManager.commit(status))
			.onErrorResume(ex -> txManager.rollback(status).then(Mono.error(ex)));
});
val def = DefaultTransactionDefinition()
// explicitly setting the transaction name is something that can be done only programmatically
def.setName("SomeTxName")
def.propagationBehavior = TransactionDefinition.PROPAGATION_REQUIRED

val reactiveTx = txManager.getReactiveTransaction(def)
reactiveTx.flatMap { status ->

	val tx = ... // put your business logic here

	tx.then(txManager.commit(status))
			.onErrorResume { ex -> txManager.rollback(status).then(Mono.error(ex)) }
}