程序化事务管理 (Programmatic Transaction Management) | Spring Framework6.1.13中文文档|Spring官方文档|SpringBoot 教程|Spring中文网

Spring 框架提供了两种编程事务管理方法，方法是使用：spring-doc.cn

或 .TransactionTemplateTransactionalOperatorspring-doc.cn
直接实现。TransactionManagerspring-doc.cn

Spring 团队通常建议将 for programmatic 命令式流中的事务管理以及反应式代码的事务管理。第二种方法类似于使用 JTA API，但例外处理不那么麻烦。TransactionTemplateTransactionalOperatorUserTransactionspring-doc.cn

使用`TransactionTemplate`

采用与其他 Spring 模板相同的方法，例如这。它使用回调方法（使应用程序代码不必执行样板获取并释放事务资源）并导致代码是意图驱动的，因为你的代码只关注什么你想做的。TransactionTemplateJdbcTemplatespring-doc.cn

正如下面的示例所示，使用 absolute 将您耦合到 Spring 的事务基础设施和 API。无论是否为编程事务管理是否适合你的开发需求是你的决定必须自己制作。TransactionTemplate

必须在事务上下文中运行并显式使用的应用程序代码类似于下一个示例。您，作为应用程序开发人员可以编写一个实现（通常表示为 anonymous 内部类），其中包含您需要在一个交易。然后，您可以将自定义的实例传递给 .以下示例显示了如何执行此操作：TransactionTemplateTransactionCallbackTransactionCallbackexecute(..)TransactionTemplatespring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.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()
	}
}

如果没有返回值，可以使用方便的类替换为匿名类，如下所示：TransactionCallbackWithoutResultspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

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

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

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

Javaspring-doc.cn
Kotlinspring-doc.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()
		}
	}
})

指定事务设置

您可以指定事务设置（例如传播模式、隔离级别、超时，依此类推）在配置。默认情况下，实例具有默认的事务设置。这以下示例显示了一个特定的TransactionTemplateTransactionTemplateTransactionTemplate:spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.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...
	}
}

以下示例定义了具有一些自定义事务的设置：TransactionTemplatespring-doc.cn

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

然后，您可以根据需要将注入到任意数量的服务中。sharedTransactionTemplatespring-doc.cn

最后，该类的实例是线程安全的，在该实例中不要保持任何会话状态。但是，实例确实可以：维护配置状态。因此，虽然多个类可能共享一个实例中，如果类需要使用不同的设置（例如，不同的隔离级别），您需要创建两个不同的实例。TransactionTemplateTransactionTemplateTransactionTemplateTransactionTemplateTransactionTemplatespring-doc.cn

使用`TransactionalOperator`

遵循类似于其他反应式的运算符设计运营商。它使用回调方法（使应用程序代码不必执行样板获取和释放事务资源），并生成代码意图驱动，因为你的代码只关注你想要做的事情。TransactionalOperatorspring-doc.cn

正如下面的示例所示，使用 absolute 将您耦合到 Spring 的事务基础设施和 API。无论是否为编程事务管理是否适合你的开发需求是你的决定使自己。TransactionalOperator

必须在事务上下文中运行并显式使用类似于下一个示例：TransactionalOperatorspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.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.cn

使用 Project Reactor 类型（mono.as(transactionalOperator::transactional))spring-doc.cn
Callback 样式（transactionalOperator.execute(TransactionCallback<T>))spring-doc.cn

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

Javaspring-doc.cn
Kotlinspring-doc.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())
	}
})

取消信号

在 Reactive Streams 中，a 可以取消 its 并停止其 .Project Reactor 以及其他库中的运算符（如、等）可以发出取消。没有办法了解取消的原因，无论是由于错误还是仅仅缺乏利息进一步消费。从 5.3 版本开始，取消信号会导致回滚。因此，重要的是要考虑 transaction 下游使用的运算符。特别是在 a 或其他多值的情况下，必须消耗 full output 才能完成事务。SubscriberSubscriptionPublishernext()take(long)timeout(Duration)PublisherFluxPublisherspring-doc.cn

指定事务设置

您可以指定事务设置（例如传播模式、隔离级别、超时等）。默认情况下，实例具有默认的事务设置。这以下示例显示了特定TransactionalOperatorTransactionalOperatorTransactionalOperator:spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.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.cn

使用`PlatformTransactionManager`

对于命令式事务，您可以直接使用来管理交易。为此，请将 u 的通过 Bean 引用将其用于 Bean。然后，通过使用 and 对象，您可以启动事务、回滚和提交。这以下示例显示了如何执行此操作：org.springframework.transaction.PlatformTransactionManagerPlatformTransactionManagerTransactionDefinitionTransactionStatusspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.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`

在处理响应式事务时，您可以直接使用 a 来管理交易。为此，请将 u 的通过 Bean 引用将其用于 Bean。然后，通过使用 and 对象，您可以启动事务、回滚和提交。这以下示例显示了如何执行此操作：org.springframework.transaction.ReactiveTransactionManagerReactiveTransactionManagerTransactionDefinitionReactiveTransactionspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.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`