对于最新的稳定版本，请使用 Spring Framework 7.0.6!spring-doc.cadn.net.cn

程序化事务管理

Spring Framework 提供了两种编程式事务管理的方式，通过使用：spring-doc.cadn.net.cn

TransactionTemplate 或 TransactionalOperator。spring-doc.cadn.net.cn
一个直接的 TransactionManager 实现。spring-doc.cadn.net.cn

Spring团队通常建议在命令式流程中使用TransactionTemplate进行编程事务管理，而在响应式代码中使用TransactionalOperator。第二种方法类似于使用JTA UserTransaction API，尽管异常处理更为简便。spring-doc.cadn.net.cn

使用 `TransactionTemplate`

TransactionTemplate 采用与其他 Spring 模板相同的思路，例如 JdbcTemplate。它使用回调方法（使应用程序代码无需执行获取和释放事务资源的样板代码），从而生成以意图为导向的代码，即你的代码只需专注于你想要完成的操作。spring-doc.cadn.net.cn

如下面的示例所示，使用 TransactionTemplate 会将您与 Spring 的事务基础设施和 API 完全耦合。是否适合您的开发需求的编程式事务管理，是您需要自己做出的决定。

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

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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 类与匿名类一起使用，如下所示：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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

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

在回调中的代码可以通过在提供的setRollbackOnly()对象上调用TransactionStatus方法来回滚事务，如下所示：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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: 的事务设置的编程自定义spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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：spring-doc.cadn.net.cn

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

然后您可以将 sharedTransactionTemplate 注入到所需数量的服务中。spring-doc.cadn.net.cn

最后，TransactionTemplate类的实例是线程安全的，因为这些实例不维护任何会话状态。TransactionTemplate实例则会维护配置状态。因此，虽然许多类可能共享一个TransactionTemplate的实例，但如果某个类需要使用具有不同设置（例如不同的隔离级别）的TransactionTemplate，则需要创建两个不同的TransactionTemplate实例。spring-doc.cadn.net.cn

使用 `TransactionalOperator`

TransactionalOperator 采用了一种与其他响应式操作符类似的运算符设计。它使用回调方法（以使应用程序代码不必执行获取和释放事务性资源的样板代码），并且生成的代码具有明确的意图，即你的代码只需专注于你想要执行的操作。spring-doc.cadn.net.cn

如下面的示例所示，使用 TransactionalOperator 会将您与 Spring 的事务基础设施和 API 完全耦合。是否适合您的开发需求的编程式事务管理，是您需要自己做出的决定。

必须在事务性上下文中运行并显式使用 TransactionalOperator 的应用程序代码类似于下面的示例：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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 可以有两种使用方式：spring-doc.cadn.net.cn

使用 Project Reactor 类型的操作符样式（mono.as(transactionalOperator::transactional)）spring-doc.cadn.net.cn
其他情况的回调样式（transactionalOperator.execute(TransactionCallback<T>)）spring-doc.cadn.net.cn

在回调中的代码可以通过在提供的setRollbackOnly()对象上调用ReactiveTransaction方法来回滚事务，如下所示：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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

取消信号

在响应式流中，Subscriber 可以取消其 Subscription 并停止其 Publisher。Project Reactor 中的运算符，以及其它库中的运算符，如 next()、take(long)、timeout(Duration) 和其他运算符，都可以发出取消信号。无法知道取消的原因，是由于错误还是仅仅因为不再有兴趣继续消费。从 5.3 版本开始，取消信号会导致回滚。因此，考虑事务下游使用的运算符非常重要 Publisher。特别是当遇到 Flux 或其他多值 Publisher 时，必须消耗全部输出才能让事务完成。spring-doc.cadn.net.cn

指定事务设置

您可以为<code>0</code>指定事务设置（例如传播模式、隔离级别、超时等）。默认情况下， <code>1</code>实例具有默认事务设置。以下示例显示了对特定 <code>2</code>的事务设置的自定义spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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`

以下各节解释了命令式和响应式事务管理器的编程用法。spring-doc.cadn.net.cn

使用 `PlatformTransactionManager`

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

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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 对象，您可以启动事务、回滚和提交。下面的示例展示了如何操作：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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`