编程事务管理

Spring 框架提供了两种通过编程方式管理事务的方法，分别使用

  • 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)) }
}