程序化事务管理

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来管理您的事务。为此，请将您使用的PlatformTransactionManager的实现通过 Bean 引用传递给您的 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)) }
}

程序化事务管理

使用TransactionTemplate

指定事务设置

使用TransactionalOperator

取消信号

指定事务设置

使用TransactionManager

使用PlatformTransactionManager

使用ReactiveTransactionManager

使用`TransactionTemplate`

使用`TransactionalOperator`

使用`TransactionManager`

使用`PlatformTransactionManager`

使用`ReactiveTransactionManager`