类 AbstractReactiveTransactionManager
- java.lang.Object
- org.springframework.transaction.reactive.AbstractReactiveTransactionManager
public abstract class AbstractReactiveTransactionManager extends Object implements ReactiveTransactionManager, Serializable
Abstract base class that implements Spring's standard reactive transaction workflow, serving as basis for concrete platform transaction managers.This base class provides the following workflow handling:
- determines if there is an existing transaction;
- applies the appropriate propagation behavior;
- suspends and resumes transactions if necessary;
- checks the rollback-only flag on commit;
- applies the appropriate modification on rollback (actual rollback or setting rollback-only);
- triggers registered synchronization callbacks.
Subclasses have to implement specific template methods for specific states of a transaction, e.g.: begin, suspend, resume, commit, rollback. The most important of them are abstract and must be provided by a concrete implementation; for the rest, defaults are provided, so overriding is optional.
Transaction synchronization is a generic mechanism for registering callbacks that get invoked at transaction completion time. This is mainly used internally by the data access support classes for R2DBC, MongoDB, etc. The same mechanism can also be leveraged for custom synchronization needs in an application.
The state of this class is serializable, to allow for serializing the transaction strategy along with proxies that carry a transaction interceptor. It is up to subclasses if they wish to make their state to be serializable too. They should implement the
java.io.Serializable
marker interface in that case, and potentially a privatereadObject()
method (according to Java serialization rules) if they need to restore any transient state.- 从以下版本开始:
- 5.2
- 作者:
- Mark Paluch, Juergen Hoeller
- 另请参阅:
TransactionSynchronizationManager
, 序列化表格
嵌套类概要
嵌套类 修饰符和类型 类 说明 protected static class
AbstractReactiveTransactionManager.SuspendedResourcesHolder
Holder for suspended resources.
构造器概要
构造器 构造器 说明 AbstractReactiveTransactionManager()
方法概要
所有方法 实例方法 抽象方法 具体方法 修饰符和类型 方法 说明 reactor.core.publisher.Mono<Void>
commit(ReactiveTransaction transaction)
This implementation of commit handles participating in existing transactions and programmatic rollback requests.protected abstract reactor.core.publisher.Mono<Void>
doBegin(TransactionSynchronizationManager synchronizationManager, Object transaction, TransactionDefinition definition)
Begin a new transaction with semantics according to the given transaction definition.protected reactor.core.publisher.Mono<Void>
doCleanupAfterCompletion(TransactionSynchronizationManager synchronizationManager, Object transaction)
Cleanup resources after transaction completion.protected abstract reactor.core.publisher.Mono<Void>
doCommit(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status)
Perform an actual commit of the given transaction.protected abstract Object
doGetTransaction(TransactionSynchronizationManager synchronizationManager)
Return a transaction object for the current transaction state.protected reactor.core.publisher.Mono<Void>
doResume(TransactionSynchronizationManager synchronizationManager, Object transaction, Object suspendedResources)
Resume the resources of the current transaction.protected abstract reactor.core.publisher.Mono<Void>
doRollback(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status)
Perform an actual rollback of the given transaction.protected reactor.core.publisher.Mono<Void>
doSetRollbackOnly(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status)
Set the given transaction rollback-only.protected reactor.core.publisher.Mono<Object>
doSuspend(TransactionSynchronizationManager synchronizationManager, Object transaction)
Suspend the resources of the current transaction.reactor.core.publisher.Mono<ReactiveTransaction>
getReactiveTransaction(TransactionDefinition definition)
This implementation handles propagation behavior.protected boolean
isExistingTransaction(Object transaction)
Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).protected reactor.core.publisher.Mono<Void>
prepareForCommit(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status)
Make preparations for commit, to be performed before thebeforeCommit
synchronization callbacks occur.protected reactor.core.publisher.Mono<Void>
registerAfterCompletionWithExistingTransaction(TransactionSynchronizationManager synchronizationManager, Object transaction, List<TransactionSynchronization> synchronizations)
Register the given list of transaction synchronizations with the existing transaction.reactor.core.publisher.Mono<Void>
rollback(ReactiveTransaction transaction)
This implementation of rollback handles participating in existing transactions.
构造器详细资料
AbstractReactiveTransactionManager
public AbstractReactiveTransactionManager()
方法详细资料
getReactiveTransaction
public final reactor.core.publisher.Mono<ReactiveTransaction> getReactiveTransaction(@Nullable TransactionDefinition definition) throws TransactionException
This implementation handles propagation behavior. Delegates todoGetTransaction
,isExistingTransaction
anddoBegin
.- 指定者:
getReactiveTransaction
在接口中ReactiveTransactionManager
- 参数:
definition
- the TransactionDefinition instance, describing propagation behavior, isolation level, timeout etc.- 返回:
- transaction status object representing the new or current transaction
- 抛出:
TransactionException
- in case of lookup, creation, or system errorsIllegalTransactionStateException
- if the given transaction definition cannot be executed (for example, if a currently active transaction is in conflict with the specified propagation behavior)- 另请参阅:
doGetTransaction(org.springframework.transaction.reactive.TransactionSynchronizationManager)
,isExistingTransaction(java.lang.Object)
,doBegin(org.springframework.transaction.reactive.TransactionSynchronizationManager, java.lang.Object, org.springframework.transaction.TransactionDefinition)
commit
public final reactor.core.publisher.Mono<Void> commit(ReactiveTransaction transaction) throws TransactionException
This implementation of commit handles participating in existing transactions and programmatic rollback requests. Delegates toisRollbackOnly
,doCommit
androllback
.- 指定者:
commit
在接口中ReactiveTransactionManager
- 参数:
transaction
- object returned by thegetTransaction
method- 抛出:
UnexpectedRollbackException
- in case of an unexpected rollback that the transaction coordinator initiatedHeuristicCompletionException
- in case of a transaction failure caused by a heuristic decision on the side of the transaction coordinatorTransactionSystemException
- in case of commit or system errors (typically caused by fundamental resource failures)IllegalTransactionStateException
- if the given transaction is already completed (that is, committed or rolled back)TransactionException
- 另请参阅:
TransactionExecution.isRollbackOnly()
,doCommit(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
,rollback(org.springframework.transaction.ReactiveTransaction)
rollback
public final reactor.core.publisher.Mono<Void> rollback(ReactiveTransaction transaction) throws TransactionException
This implementation of rollback handles participating in existing transactions. Delegates todoRollback
anddoSetRollbackOnly
.- 指定者:
rollback
在接口中ReactiveTransactionManager
- 参数:
transaction
- object returned by thegetTransaction
method- 抛出:
TransactionSystemException
- in case of rollback or system errors (typically caused by fundamental resource failures)IllegalTransactionStateException
- if the given transaction is already completed (that is, committed or rolled back)TransactionException
- 另请参阅:
doRollback(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
,doSetRollbackOnly(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
doGetTransaction
protected abstract Object doGetTransaction(TransactionSynchronizationManager synchronizationManager) throws TransactionException
Return a transaction object for the current transaction state.The returned object will usually be specific to the concrete transaction manager implementation, carrying corresponding transaction state in a modifiable fashion. This object will be passed into the other template methods (e.g. doBegin and doCommit), either directly or as part of a DefaultReactiveTransactionStatus instance.
The returned object should contain information about any existing transaction, that is, a transaction that has already started before the current
getTransaction
call on the transaction manager. Consequently, adoGetTransaction
implementation will usually look for an existing transaction and store corresponding state in the returned transaction object.- 参数:
synchronizationManager
- the synchronization manager bound to the current transaction- 返回:
- the current transaction object
- 抛出:
CannotCreateTransactionException
- if transaction support is not availableTransactionException
- in case of lookup or system errors- 另请参阅:
doBegin(org.springframework.transaction.reactive.TransactionSynchronizationManager, java.lang.Object, org.springframework.transaction.TransactionDefinition)
,doCommit(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
,doRollback(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
,GenericReactiveTransaction.getTransaction()
isExistingTransaction
protected boolean isExistingTransaction(Object transaction) throws TransactionException
Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).The result will be evaluated according to the specified propagation behavior for the new transaction. An existing transaction might get suspended (in case of PROPAGATION_REQUIRES_NEW), or the new transaction might participate in the existing one (in case of PROPAGATION_REQUIRED).
The default implementation returns
false
, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.- 参数:
transaction
- the transaction object returned by doGetTransaction- 返回:
- if there is an existing transaction
- 抛出:
TransactionException
- in case of system errors- 另请参阅:
doGetTransaction(org.springframework.transaction.reactive.TransactionSynchronizationManager)
doBegin
protected abstract reactor.core.publisher.Mono<Void> doBegin(TransactionSynchronizationManager synchronizationManager, Object transaction, TransactionDefinition definition) throws TransactionException
Begin a new transaction with semantics according to the given transaction definition. Does not have to care about applying the propagation behavior, as this has already been handled by this abstract manager.This method gets called when the transaction manager has decided to actually start a new transaction. Either there wasn't any transaction before, or the previous transaction has been suspended.
A special scenario is a nested transaction: This method will be called to start a nested transaction when necessary. In such a context, there will be an active transaction: The implementation of this method has to detect this and start an appropriate nested transaction.
- 参数:
synchronizationManager
- the synchronization manager bound to the new transactiontransaction
- the transaction object returned bydoGetTransaction
definition
- a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name- 抛出:
TransactionException
- in case of creation or system errorsNestedTransactionNotSupportedException
- if the underlying transaction does not support nesting (e.g. through savepoints)
doSuspend
protected reactor.core.publisher.Mono<Object> doSuspend(TransactionSynchronizationManager synchronizationManager, Object transaction) throws TransactionException
Suspend the resources of the current transaction. Transaction synchronization will already have been suspended.The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
- 参数:
synchronizationManager
- the synchronization manager bound to the current transactiontransaction
- the transaction object returned bydoGetTransaction
- 返回:
- an object that holds suspended resources (will be kept unexamined for passing it into doResume)
- 抛出:
TransactionSuspensionNotSupportedException
- if suspending is not supported by the transaction manager implementationTransactionException
- in case of system errors- 另请参阅:
doResume(org.springframework.transaction.reactive.TransactionSynchronizationManager, java.lang.Object, java.lang.Object)
doResume
protected reactor.core.publisher.Mono<Void> doResume(TransactionSynchronizationManager synchronizationManager, @Nullable Object transaction, Object suspendedResources) throws TransactionException
Resume the resources of the current transaction. Transaction synchronization will be resumed afterwards.The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
- 参数:
synchronizationManager
- the synchronization manager bound to the current transactiontransaction
- the transaction object returned bydoGetTransaction
suspendedResources
- the object that holds suspended resources, as returned by doSuspend- 抛出:
TransactionSuspensionNotSupportedException
- if suspending is not supported by the transaction manager implementationTransactionException
- in case of system errors- 另请参阅:
doSuspend(org.springframework.transaction.reactive.TransactionSynchronizationManager, java.lang.Object)
prepareForCommit
protected reactor.core.publisher.Mono<Void> prepareForCommit(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status)
Make preparations for commit, to be performed before thebeforeCommit
synchronization callbacks occur.Note that exceptions will get propagated to the commit caller and cause a rollback of the transaction.
- 参数:
synchronizationManager
- the synchronization manager bound to the current transactionstatus
- the status representation of the transaction- 抛出:
RuntimeException
- in case of errors; will be propagated to the caller (note: do not throw TransactionException subclasses here!)
doCommit
protected abstract reactor.core.publisher.Mono<Void> doCommit(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status) throws TransactionException
Perform an actual commit of the given transaction.An implementation does not need to check the "new transaction" flag or the rollback-only flag; this will already have been handled before. Usually, a straight commit will be performed on the transaction object contained in the passed-in status.
- 参数:
synchronizationManager
- the synchronization manager bound to the current transactionstatus
- the status representation of the transaction- 抛出:
TransactionException
- in case of commit or system errors- 另请参阅:
GenericReactiveTransaction.getTransaction()
doRollback
protected abstract reactor.core.publisher.Mono<Void> doRollback(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status) throws TransactionException
Perform an actual rollback of the given transaction.An implementation does not need to check the "new transaction" flag; this will already have been handled before. Usually, a straight rollback will be performed on the transaction object contained in the passed-in status.
- 参数:
synchronizationManager
- the synchronization manager bound to the current transactionstatus
- the status representation of the transaction- 抛出:
TransactionException
- in case of system errors- 另请参阅:
GenericReactiveTransaction.getTransaction()
doSetRollbackOnly
protected reactor.core.publisher.Mono<Void> doSetRollbackOnly(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status) throws TransactionException
Set the given transaction rollback-only. Only called on rollback if the current transaction participates in an existing one.The default implementation throws an IllegalTransactionStateException, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.
- 参数:
synchronizationManager
- the synchronization manager bound to the current transactionstatus
- the status representation of the transaction- 抛出:
TransactionException
- in case of system errors
registerAfterCompletionWithExistingTransaction
protected reactor.core.publisher.Mono<Void> registerAfterCompletionWithExistingTransaction(TransactionSynchronizationManager synchronizationManager, Object transaction, List<TransactionSynchronization> synchronizations) throws TransactionException
Register the given list of transaction synchronizations with the existing transaction.Invoked when the control of the Spring transaction manager and thus all Spring transaction synchronizations end, without the transaction being completed yet. This is for example the case when participating in an existing JTA or EJB CMT transaction.
The default implementation simply invokes the
afterCompletion
methods immediately, passing in "STATUS_UNKNOWN". This is the best we can do if there's no chance to determine the actual outcome of the outer transaction.- 参数:
synchronizationManager
- the synchronization manager bound to the current transactiontransaction
- the transaction object returned bydoGetTransaction
synchronizations
- a List of TransactionSynchronization objects- 抛出:
TransactionException
- in case of system errors- 另请参阅:
invokeAfterCompletion(TransactionSynchronizationManager, List, int)
,TransactionSynchronization.afterCompletion(int)
,TransactionSynchronization.STATUS_UNKNOWN
doCleanupAfterCompletion
protected reactor.core.publisher.Mono<Void> doCleanupAfterCompletion(TransactionSynchronizationManager synchronizationManager, Object transaction)
Cleanup resources after transaction completion.Called after
doCommit
anddoRollback
execution, on any outcome. The default implementation does nothing.Should not throw any exceptions but just issue warnings on errors.
- 参数:
synchronizationManager
- the synchronization manager bound to the current transactiontransaction
- the transaction object returned bydoGetTransaction