public abstract class TransactionAspectSupport extends Object implements BeanFactoryAware, InitializingBean
TransactionInterceptor
or an AspectJ aspect.
This enables the underlying Spring transaction infrastructure to be used easily to implement an aspect for any aspect system.
Subclasses are responsible for calling methods in this class in the correct order.
If no transaction name has been specified in the TransactionAttribute
,
the exposed name will be the fully-qualified class name + "." + method name
(by default).
Uses the Strategy design pattern. A PlatformTransactionManager
or
ReactiveTransactionManager
implementation will perform the actual transaction
management, and a TransactionAttributeSource
(e.g. annotation-based) is used
for determining transaction definitions for a particular class or method.
A transaction aspect is serializable if its TransactionManager
and
TransactionAttributeSource
are serializable.
PlatformTransactionManager
,
ReactiveTransactionManager
,
setTransactionManager(org.springframework.transaction.TransactionManager)
,
setTransactionAttributes(java.util.Properties)
,
setTransactionAttributeSource(org.springframework.transaction.interceptor.TransactionAttributeSource)
Modifier and Type | Class and Description |
---|---|
protected static interface |
TransactionAspectSupport.CoroutinesInvocationCallback
Coroutines-supporting extension of the callback interface.
|
protected static interface |
TransactionAspectSupport.InvocationCallback
Simple callback interface for proceeding with the target invocation.
|
protected static class |
TransactionAspectSupport.TransactionInfo
Opaque object used to hold transaction information.
|
Modifier | Constructor and Description |
---|---|
protected |
TransactionAspectSupport() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Check that required properties were set.
|
protected void |
cleanupTransactionInfo(TransactionAspectSupport.TransactionInfo txInfo)
Reset the TransactionInfo ThreadLocal.
|
protected void |
clearTransactionManagerCache()
Clear the transaction manager cache.
|
protected void |
commitTransactionAfterReturning(TransactionAspectSupport.TransactionInfo txInfo)
Execute after successful completion of call, but not after an exception was handled.
|
protected void |
completeTransactionAfterThrowing(TransactionAspectSupport.TransactionInfo txInfo,
Throwable ex)
Handle a throwable, completing the transaction.
|
protected TransactionAspectSupport.TransactionInfo |
createTransactionIfNecessary(PlatformTransactionManager tm,
TransactionAttribute txAttr,
String joinpointIdentification)
Create a transaction if necessary based on the given TransactionAttribute.
|
protected static TransactionAspectSupport.TransactionInfo |
currentTransactionInfo()
Subclasses can use this to return the current TransactionInfo.
|
static TransactionStatus |
currentTransactionStatus()
Return the transaction status of the current method invocation.
|
protected TransactionManager |
determineTransactionManager(TransactionAttribute txAttr)
Determine the specific transaction manager to use for the given transaction.
|
protected BeanFactory |
getBeanFactory()
Return the BeanFactory to use for retrieving
TransactionManager beans. |
TransactionAttributeSource |
getTransactionAttributeSource()
Return the transaction attribute source.
|
TransactionManager |
getTransactionManager()
Return the default transaction manager, or
null if unknown. |
protected String |
getTransactionManagerBeanName()
Return the name of the default transaction manager bean.
|
protected Object |
invokeWithinTransaction(Method method,
Class<?> targetClass,
TransactionAspectSupport.InvocationCallback invocation)
General delegate for around-advice-based subclasses, delegating to several other template
methods on this class.
|
protected String |
methodIdentification(Method method,
Class<?> targetClass)
Convenience method to return a String representation of this Method
for use in logging.
|
protected TransactionAspectSupport.TransactionInfo |
prepareTransactionInfo(PlatformTransactionManager tm,
TransactionAttribute txAttr,
String joinpointIdentification,
TransactionStatus status)
Prepare a TransactionInfo for the given attribute and status object.
|
void |
setBeanFactory(BeanFactory beanFactory)
Set the BeanFactory to use for retrieving
TransactionManager beans. |
void |
setTransactionAttributes(Properties transactionAttributes)
Set properties with method names as keys and transaction attribute
descriptors (parsed via TransactionAttributeEditor) as values:
e.g.
|
void |
setTransactionAttributeSource(TransactionAttributeSource transactionAttributeSource)
Set the transaction attribute source which is used to find transaction
attributes.
|
void |
setTransactionAttributeSources(TransactionAttributeSource... transactionAttributeSources)
Set multiple transaction attribute sources which are used to find transaction
attributes.
|
void |
setTransactionManager(TransactionManager transactionManager)
Specify the default transaction manager to use to drive transactions.
|
void |
setTransactionManagerBeanName(String transactionManagerBeanName)
Specify the name of the default transaction manager bean.
|
protected final Log logger
@Nullable protected static TransactionAspectSupport.TransactionInfo currentTransactionInfo() throws NoTransactionException
A TransactionInfo will be returned even if no transaction was created.
The TransactionInfo.hasTransaction()
method can be used to query this.
To find out about specific transaction characteristics, consider using
TransactionSynchronizationManager's isSynchronizationActive()
and/or isActualTransactionActive()
methods.
null
if noneNoTransactionException
TransactionAspectSupport.TransactionInfo.hasTransaction()
,
TransactionSynchronizationManager.isSynchronizationActive()
,
TransactionSynchronizationManager.isActualTransactionActive()
public static TransactionStatus currentTransactionStatus() throws NoTransactionException
NoTransactionException
- if the transaction info cannot be found,
because the method was invoked outside an AOP invocation contextpublic void setTransactionManagerBeanName(@Nullable String transactionManagerBeanName)
This can either point to a traditional PlatformTransactionManager
or a
ReactiveTransactionManager
for reactive transaction management.
@Nullable protected final String getTransactionManagerBeanName()
public void setTransactionManager(@Nullable TransactionManager transactionManager)
This can either be a traditional PlatformTransactionManager
or a
ReactiveTransactionManager
for reactive transaction management.
The default transaction manager will be used if a qualifier has not been declared for a given transaction or if an explicit name for the default transaction manager bean has not been specified.
@Nullable public TransactionManager getTransactionManager()
null
if unknown.
This can either be a traditional PlatformTransactionManager
or a
ReactiveTransactionManager
for reactive transaction management.
public void setTransactionAttributes(Properties transactionAttributes)
Note: Method names are always applied to the target class, no matter if defined in an interface or the class itself.
Internally, a NameMatchTransactionAttributeSource will be created from the given properties.
public void setTransactionAttributeSources(TransactionAttributeSource... transactionAttributeSources)
public void setTransactionAttributeSource(@Nullable TransactionAttributeSource transactionAttributeSource)
@Nullable public TransactionAttributeSource getTransactionAttributeSource()
public void setBeanFactory(@Nullable BeanFactory beanFactory)
TransactionManager
beans.setBeanFactory
in interface BeanFactoryAware
beanFactory
- owning BeanFactory (never null
).
The bean can immediately call methods on the factory.BeanInitializationException
@Nullable protected final BeanFactory getBeanFactory()
TransactionManager
beans.public void afterPropertiesSet()
afterPropertiesSet
in interface InitializingBean
@Nullable protected Object invokeWithinTransaction(Method method, @Nullable Class<?> targetClass, TransactionAspectSupport.InvocationCallback invocation) throws Throwable
CallbackPreferringPlatformTransactionManager
as well as regular PlatformTransactionManager
implementations and
ReactiveTransactionManager
implementations for reactive return types.method
- the Method being invokedtargetClass
- the target class that we're invoking the method oninvocation
- the callback to use for proceeding with the target invocationThrowable
- propagated from the target invocationprotected void clearTransactionManagerCache()
@Nullable protected TransactionManager determineTransactionManager(@Nullable TransactionAttribute txAttr)
@Nullable protected String methodIdentification(Method method, @Nullable Class<?> targetClass)
The default implementation returns null
, indicating the
use of DefaultTransactionAttribute.getDescriptor()
instead,
ending up as ClassUtils.getQualifiedMethodName(Method, Class)
.
method
- the method we're interested intargetClass
- the class that the method is being invoked onClassUtils.getQualifiedMethodName(java.lang.reflect.Method)
protected TransactionAspectSupport.TransactionInfo createTransactionIfNecessary(@Nullable PlatformTransactionManager tm, @Nullable TransactionAttribute txAttr, String joinpointIdentification)
Allows callers to perform custom TransactionAttribute lookups through the TransactionAttributeSource.
txAttr
- the TransactionAttribute (may be null
)joinpointIdentification
- the fully qualified method name
(used for monitoring and logging purposes)hasTransaction()
method on TransactionInfo can be used to
tell if there was a transaction created.getTransactionAttributeSource()
protected TransactionAspectSupport.TransactionInfo prepareTransactionInfo(@Nullable PlatformTransactionManager tm, @Nullable TransactionAttribute txAttr, String joinpointIdentification, @Nullable TransactionStatus status)
txAttr
- the TransactionAttribute (may be null
)joinpointIdentification
- the fully qualified method name
(used for monitoring and logging purposes)status
- the TransactionStatus for the current transactionprotected void commitTransactionAfterReturning(@Nullable TransactionAspectSupport.TransactionInfo txInfo)
txInfo
- information about the current transactionprotected void completeTransactionAfterThrowing(@Nullable TransactionAspectSupport.TransactionInfo txInfo, Throwable ex)
txInfo
- information about the current transactionex
- throwable encounteredprotected void cleanupTransactionInfo(@Nullable TransactionAspectSupport.TransactionInfo txInfo)
Call this in all cases: exception or normal return!
txInfo
- information about the current transaction (may be null
)