Class R2dbcTransactionManager
- All Implemented Interfaces:
Serializable
,InitializingBean
,ConfigurableTransactionManager
,ReactiveTransactionManager
,TransactionManager
ReactiveTransactionManager
implementation
for a single R2DBC ConnectionFactory
. This class is capable of working
in any environment with any R2DBC driver, as long as the setup uses a
ConnectionFactory
as its Connection
factory mechanism.
Binds a R2DBC Connection
from the specified ConnectionFactory
to the current subscriber context, potentially allowing for one context-bound
Connection
per ConnectionFactory
.
Note: The ConnectionFactory
that this transaction manager operates
on needs to return independent Connection
s. The Connection
s
typically come from a connection pool but the ConnectionFactory
must not
return specifically scoped or constrained Connection
s. This transaction
manager will associate Connection
with context-bound transactions,
according to the specified propagation behavior. It assumes that a separate,
independent Connection
can be obtained even during an ongoing transaction.
Application code is required to retrieve the R2DBC Connection via
ConnectionFactoryUtils.getConnection(ConnectionFactory)
instead of a standard R2DBC-style ConnectionFactory.create()
call.
Spring classes such as DatabaseClient
use this strategy implicitly.
If not used in combination with this transaction manager, the
ConnectionFactoryUtils
lookup strategy behaves exactly like the native
ConnectionFactory
lookup; it can thus be used in a portable fashion.
Alternatively, you can allow application code to work with the lookup pattern
ConnectionFactory.create()
, for example for code not aware of Spring.
In that case, define a TransactionAwareConnectionFactoryProxy
for your
target ConnectionFactory
, and pass that proxy ConnectionFactory
to your DAOs which will automatically participate in Spring-managed transactions
when accessing it.
Spring's TransactionDefinition
attributes are carried forward to
R2DBC drivers using extensible R2DBC TransactionDefinition
.
Subclasses may override createTransactionDefinition(TransactionDefinition)
to customize transaction definitions for vendor-specific attributes. As of 6.0.10,
this transaction manager supports nested transactions via R2DBC savepoints as well.
- Since:
- 5.3
- Author:
- Mark Paluch, Juergen Hoeller
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManager
AbstractReactiveTransactionManager.SuspendedResourcesHolder
-
Field Summary
Fields inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManager
logger
-
Constructor Summary
ConstructorDescriptionCreate a newR2dbcTransactionManager
instance.R2dbcTransactionManager
(ConnectionFactory connectionFactory) Create a newR2dbcTransactionManager
instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.protected TransactionDefinition
createTransactionDefinition
(TransactionDefinition definition) Determine the transaction definition from ourTransactionDefinition
.protected Duration
determineTimeout
(TransactionDefinition definition) Determine the actual timeout to use for the given definition.protected 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 reactor.core.publisher.Mono<Void>
doCommit
(TransactionSynchronizationManager TransactionSynchronizationManager, GenericReactiveTransaction status) Perform an actual commit of the given transaction.protected 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 reactor.core.publisher.Mono<Void>
doRollback
(TransactionSynchronizationManager TransactionSynchronizationManager, 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.Return the R2DBCConnectionFactory
that this instance manages transactions for.boolean
Return whether to enforce the read-only nature of a transaction through an explicit statement on the transactional connection.protected boolean
isExistingTransaction
(Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).protected ConnectionFactory
Obtain theConnectionFactory
for actual use.protected reactor.core.publisher.Mono<Void>
prepareTransactionalConnection
(Connection con, TransactionDefinition definition) Prepare the transactionalConnection
right after transaction begin.protected IsolationLevel
resolveIsolationLevel
(int isolationLevel) Resolve the isolation level constant to a R2DBCIsolationLevel
.void
setConnectionFactory
(ConnectionFactory connectionFactory) Set the R2DBCConnectionFactory
that this instance should manage transactions for.void
setEnforceReadOnly
(boolean enforceReadOnly) Specify whether to enforce the read-only nature of a transaction (as indicated byTransactionDefinition.isReadOnly()
) through an explicit statement on the transactional connection: "SET TRANSACTION READ ONLY" as understood by Oracle, MySQL and Postgres.protected RuntimeException
translateException
(String task, R2dbcException ex) Translate the given R2DBC commit/rollback exception to a common Spring exception to propagate from theAbstractReactiveTransactionManager.commit(org.springframework.transaction.ReactiveTransaction)
/AbstractReactiveTransactionManager.rollback(org.springframework.transaction.ReactiveTransaction)
call.Methods inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManager
commit, getReactiveTransaction, getTransactionExecutionListeners, prepareForCommit, registerAfterCompletionWithExistingTransaction, rollback, setTransactionExecutionListeners
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.transaction.ConfigurableTransactionManager
addListener
-
Constructor Details
-
R2dbcTransactionManager
public R2dbcTransactionManager()Create a newR2dbcTransactionManager
instance. AConnectionFactory
has to be set to be able to use it. -
R2dbcTransactionManager
Create a newR2dbcTransactionManager
instance.- Parameters:
connectionFactory
- the R2DBC ConnectionFactory to manage transactions for
-
-
Method Details
-
setConnectionFactory
Set the R2DBCConnectionFactory
that this instance should manage transactions for. This will typically be a locally definedConnectionFactory
, for example an R2DBC connection pool.The
ConnectionFactory
passed in here needs to return independentConnection
s. TheConnection
s typically come from a connection pool but theConnectionFactory
must not return specifically scoped or constrainedConnection
s. -
getConnectionFactory
Return the R2DBCConnectionFactory
that this instance manages transactions for. -
obtainConnectionFactory
Obtain theConnectionFactory
for actual use.- Returns:
- the
ConnectionFactory
(nevernull
) - Throws:
IllegalStateException
- in case of no ConnectionFactory set
-
setEnforceReadOnly
public void setEnforceReadOnly(boolean enforceReadOnly) Specify whether to enforce the read-only nature of a transaction (as indicated byTransactionDefinition.isReadOnly()
) through an explicit statement on the transactional connection: "SET TRANSACTION READ ONLY" as understood by Oracle, MySQL and Postgres.The exact treatment, including any SQL statement executed on the connection, can be customized through
prepareTransactionalConnection(io.r2dbc.spi.Connection, org.springframework.transaction.TransactionDefinition)
. -
isEnforceReadOnly
public boolean isEnforceReadOnly()Return whether to enforce the read-only nature of a transaction through an explicit statement on the transactional connection.- See Also:
-
afterPropertiesSet
public void afterPropertiesSet()Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
-
doGetTransaction
Description copied from class:AbstractReactiveTransactionManager
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.- Specified by:
doGetTransaction
in classAbstractReactiveTransactionManager
- Parameters:
synchronizationManager
- the synchronization manager bound to the current transaction- Returns:
- the current transaction object
- See Also:
-
AbstractReactiveTransactionManager.doBegin(org.springframework.transaction.reactive.TransactionSynchronizationManager, java.lang.Object, org.springframework.transaction.TransactionDefinition)
AbstractReactiveTransactionManager.doCommit(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
AbstractReactiveTransactionManager.doRollback(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
GenericReactiveTransaction.getTransaction()
-
isExistingTransaction
Description copied from class:AbstractReactiveTransactionManager
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.- Overrides:
isExistingTransaction
in classAbstractReactiveTransactionManager
- Parameters:
transaction
- the transaction object returned by doGetTransaction- Returns:
- if there is an existing transaction
- See Also:
-
doBegin
protected reactor.core.publisher.Mono<Void> doBegin(TransactionSynchronizationManager synchronizationManager, Object transaction, TransactionDefinition definition) Description copied from class:AbstractReactiveTransactionManager
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.
- Specified by:
doBegin
in classAbstractReactiveTransactionManager
- Parameters:
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
-
createTransactionDefinition
Determine the transaction definition from ourTransactionDefinition
. Can be overridden to wrap the R2DBCTransactionDefinition
to adjust or enhance transaction attributes.- Parameters:
definition
- the transaction definition- Returns:
- the actual transaction definition to use
- Since:
- 6.0
- See Also:
-
determineTimeout
Determine the actual timeout to use for the given definition. Will fall back to this manager's default timeout if the transaction definition doesn't specify a non-default value.- Parameters:
definition
- the transaction definition- Returns:
- the actual timeout to use
- See Also:
-
doSuspend
protected reactor.core.publisher.Mono<Object> doSuspend(TransactionSynchronizationManager synchronizationManager, Object transaction) Description copied from class:AbstractReactiveTransactionManager
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.
- Overrides:
doSuspend
in classAbstractReactiveTransactionManager
- Parameters:
synchronizationManager
- the synchronization manager bound to the current transactiontransaction
- the transaction object returned bydoGetTransaction
- Returns:
- an object that holds suspended resources (will be kept unexamined for passing it into doResume)
- See Also:
-
doResume
protected reactor.core.publisher.Mono<Void> doResume(TransactionSynchronizationManager synchronizationManager, @Nullable Object transaction, Object suspendedResources) Description copied from class:AbstractReactiveTransactionManager
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.
- Overrides:
doResume
in classAbstractReactiveTransactionManager
- Parameters:
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- See Also:
-
doCommit
protected reactor.core.publisher.Mono<Void> doCommit(TransactionSynchronizationManager TransactionSynchronizationManager, GenericReactiveTransaction status) Description copied from class:AbstractReactiveTransactionManager
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.
- Specified by:
doCommit
in classAbstractReactiveTransactionManager
- Parameters:
TransactionSynchronizationManager
- the synchronization manager bound to the current transactionstatus
- the status representation of the transaction- See Also:
-
doRollback
protected reactor.core.publisher.Mono<Void> doRollback(TransactionSynchronizationManager TransactionSynchronizationManager, GenericReactiveTransaction status) Description copied from class:AbstractReactiveTransactionManager
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.
- Specified by:
doRollback
in classAbstractReactiveTransactionManager
- Parameters:
TransactionSynchronizationManager
- the synchronization manager bound to the current transactionstatus
- the status representation of the transaction- See Also:
-
doSetRollbackOnly
protected reactor.core.publisher.Mono<Void> doSetRollbackOnly(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status) Description copied from class:AbstractReactiveTransactionManager
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.
- Overrides:
doSetRollbackOnly
in classAbstractReactiveTransactionManager
- Parameters:
synchronizationManager
- the synchronization manager bound to the current transactionstatus
- the status representation of the transaction
-
doCleanupAfterCompletion
protected reactor.core.publisher.Mono<Void> doCleanupAfterCompletion(TransactionSynchronizationManager synchronizationManager, Object transaction) Description copied from class:AbstractReactiveTransactionManager
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.
- Overrides:
doCleanupAfterCompletion
in classAbstractReactiveTransactionManager
- Parameters:
synchronizationManager
- the synchronization manager bound to the current transactiontransaction
- the transaction object returned bydoGetTransaction
-
prepareTransactionalConnection
protected reactor.core.publisher.Mono<Void> prepareTransactionalConnection(Connection con, TransactionDefinition definition) Prepare the transactionalConnection
right after transaction begin.The default implementation executes a "SET TRANSACTION READ ONLY" statement if the
"enforceReadOnly"
flag is set totrue
and the transaction definition indicates a read-only transaction.The "SET TRANSACTION READ ONLY" is understood by Oracle, MySQL and Postgres and may work with other databases as well. If you'd like to adapt this treatment, override this method accordingly.
- Parameters:
con
- the transactional R2DBC Connectiondefinition
- the current transaction definition- Since:
- 5.3.22
- See Also:
-
resolveIsolationLevel
Resolve the isolation level constant to a R2DBCIsolationLevel
. If you'd like to extend isolation level translation for vendor-specificIsolationLevel
s, override this method accordingly.- Parameters:
isolationLevel
- the isolation level to translate.- Returns:
- the resolved isolation level. Can be
null
if not resolvable or the isolation level should remaindefault
. - See Also:
-
translateException
Translate the given R2DBC commit/rollback exception to a common Spring exception to propagate from theAbstractReactiveTransactionManager.commit(org.springframework.transaction.ReactiveTransaction)
/AbstractReactiveTransactionManager.rollback(org.springframework.transaction.ReactiveTransaction)
call.- Parameters:
task
- the task description (commit or rollback).ex
- the SQLException thrown from commit/rollback.- Returns:
- the translated exception to emit
-