类 DataSourceTransactionManager
- java.lang.Object
- org.springframework.transaction.support.AbstractPlatformTransactionManager
- org.springframework.jdbc.datasource.DataSourceTransactionManager
public class DataSourceTransactionManager extends AbstractPlatformTransactionManager implements ResourceTransactionManager, InitializingBean
PlatformTransactionManager
implementation for a single JDBCDataSource
. This class is capable of working in any environment with any JDBC driver, as long as the setup uses ajavax.sql.DataSource
as itsConnection
factory mechanism. Binds a JDBC Connection from the specified DataSource to the current thread, potentially allowing for one thread-bound Connection per DataSource.Note: The DataSource that this transaction manager operates on needs to return independent Connections. The Connections may come from a pool (the typical case), but the DataSource must not return thread-scoped / request-scoped Connections or the like. This transaction manager will associate Connections with thread-bound transactions itself, 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 JDBC Connection via
DataSourceUtils.getConnection(DataSource)
instead of a standard Java EE-styleDataSource.getConnection()
call. Spring classes such asJdbcTemplate
use this strategy implicitly. If not used in combination with this transaction manager, theDataSourceUtils
lookup strategy behaves exactly like the native DataSource lookup; it can thus be used in a portable fashion.Alternatively, you can allow application code to work with the standard Java EE-style lookup pattern
DataSource.getConnection()
, for example for legacy code that is not aware of Spring at all. In that case, define aTransactionAwareDataSourceProxy
for your target DataSource, and pass that proxy DataSource to your DAOs, which will automatically participate in Spring-managed transactions when accessing it.Supports custom isolation levels, and timeouts which get applied as appropriate JDBC statement timeouts. To support the latter, application code must either use
JdbcTemplate
, callDataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)
for each created JDBC Statement, or go through aTransactionAwareDataSourceProxy
which will create timeout-aware JDBC Connections and Statements automatically.Consider defining a
LazyConnectionDataSourceProxy
for your target DataSource, pointing both this transaction manager and your DAOs to it. This will lead to optimized handling of "empty" transactions, i.e. of transactions without any JDBC statements executed. A LazyConnectionDataSourceProxy will not fetch an actual JDBC Connection from the target DataSource until a Statement gets executed, lazily applying the specified transaction settings to the target Connection.This transaction manager supports nested transactions via the JDBC 3.0
Savepoint
mechanism. The"nestedTransactionAllowed"
flag defaults to "true", since nested transactions will work without restrictions on JDBC drivers that support savepoints (such as the Oracle JDBC driver).This transaction manager can be used as a replacement for the
JtaTransactionManager
in the single resource case, as it does not require a container that supports JTA, typically in combination with a locally defined JDBC DataSource (e.g. an Apache Commons DBCP connection pool). Switching between this local strategy and a JTA environment is just a matter of configuration!As of 4.3.4, this transaction manager triggers flush callbacks on registered transaction synchronizations (if synchronization is generally active), assuming resources operating on the underlying JDBC
Connection
. This allows for setup analogous toJtaTransactionManager
, in particular with respect to lazily registered ORM resources (e.g. a HibernateSession
).- 从以下版本开始:
- 02.05.2003
- 作者:
- Juergen Hoeller
- 另请参阅:
AbstractPlatformTransactionManager.setNestedTransactionAllowed(boolean)
,Savepoint
,DataSourceUtils.getConnection(javax.sql.DataSource)
,DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)
,DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)
,TransactionAwareDataSourceProxy
,LazyConnectionDataSourceProxy
,JdbcTemplate
, 序列化表格
嵌套类概要
从类继承的嵌套类/接口 org.springframework.transaction.support.AbstractPlatformTransactionManager
AbstractPlatformTransactionManager.SuspendedResourcesHolder
字段概要
从类继承的字段 org.springframework.transaction.support.AbstractPlatformTransactionManager
logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION
构造器概要
构造器 构造器 说明 DataSourceTransactionManager()
Create a new DataSourceTransactionManager instance.DataSourceTransactionManager(DataSource dataSource)
Create a new DataSourceTransactionManager instance.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.protected void
doBegin(Object transaction, TransactionDefinition definition)
Begin a new transaction with semantics according to the given transaction definition.protected void
doCleanupAfterCompletion(Object transaction)
Cleanup resources after transaction completion.protected void
doCommit(DefaultTransactionStatus status)
Perform an actual commit of the given transaction.protected Object
doGetTransaction()
Return a transaction object for the current transaction state.protected void
doResume(Object transaction, Object suspendedResources)
Resume the resources of the current transaction.protected void
doRollback(DefaultTransactionStatus status)
Perform an actual rollback of the given transaction.protected void
doSetRollbackOnly(DefaultTransactionStatus status)
Set the given transaction rollback-only.protected Object
doSuspend(Object transaction)
Suspend the resources of the current transaction.DataSource
getDataSource()
Return the JDBC DataSource that this instance manages transactions for.Object
getResourceFactory()
Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory.boolean
isEnforceReadOnly()
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 void
prepareTransactionalConnection(Connection con, TransactionDefinition definition)
Prepare the transactionalConnection
right after transaction begin.void
setDataSource(DataSource dataSource)
Set the JDBC DataSource 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.从类继承的方法 org.springframework.transaction.support.AbstractPlatformTransactionManager
commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareForCommit, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransaction
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.transaction.PlatformTransactionManager
commit, getTransaction, rollback
构造器详细资料
DataSourceTransactionManager
public DataSourceTransactionManager()
Create a new DataSourceTransactionManager instance. A DataSource has to be set to be able to use it.
DataSourceTransactionManager
public DataSourceTransactionManager(DataSource dataSource)
Create a new DataSourceTransactionManager instance.- 参数:
dataSource
- the JDBC DataSource to manage transactions for
方法详细资料
setDataSource
public void setDataSource(DataSource dataSource)
Set the JDBC DataSource that this instance should manage transactions for.This will typically be a locally defined DataSource, for example an Apache Commons DBCP connection pool. Alternatively, you can also drive transactions for a non-XA J2EE DataSource fetched from JNDI. For an XA DataSource, use JtaTransactionManager.
The DataSource specified here should be the target DataSource to manage transactions for, not a TransactionAwareDataSourceProxy. Only data access code may work with TransactionAwareDataSourceProxy, while the transaction manager needs to work on the underlying target DataSource. If there's nevertheless a TransactionAwareDataSourceProxy passed in, it will be unwrapped to extract its target DataSource.
The DataSource passed in here needs to return independent Connections. The Connections may come from a pool (the typical case), but the DataSource must not return thread-scoped / request-scoped Connections or the like.
getDataSource
public DataSource getDataSource()
Return the JDBC DataSource that this instance manages transactions for.
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(java.sql.Connection, org.springframework.transaction.TransactionDefinition)
.This mode of read-only handling goes beyond the
Connection.setReadOnly(boolean)
hint that Spring applies by default. In contrast to that standard JDBC hint, "SET TRANSACTION READ ONLY" enforces an isolation-level-like connection mode where data manipulation statements are strictly disallowed. Also, on Oracle, this read-only mode provides read consistency for the entire transaction.Note that older Oracle JDBC drivers (9i, 10g) used to enforce this read-only mode even for
Connection.setReadOnly(true
. However, with recent drivers, this strong enforcement needs to be applied explicitly, e.g. through this flag.
isEnforceReadOnly
public boolean isEnforceReadOnly()
Return whether to enforce the read-only nature of a transaction through an explicit statement on the transactional connection.- 从以下版本开始:
- 4.3.7
- 另请参阅:
setEnforceReadOnly(boolean)
afterPropertiesSet
public void afterPropertiesSet()
从接口复制的说明: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.
- 指定者:
afterPropertiesSet
在接口中InitializingBean
getResourceFactory
public Object getResourceFactory()
从接口复制的说明:ResourceTransactionManager
Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory.This target resource factory is usually used as resource key for
TransactionSynchronizationManager
's resource bindings per thread.- 指定者:
getResourceFactory
在接口中ResourceTransactionManager
- 返回:
- the target resource factory (never
null
) - 另请参阅:
TransactionSynchronizationManager.bindResource(java.lang.Object, java.lang.Object)
,TransactionSynchronizationManager.getResource(java.lang.Object)
doGetTransaction
protected Object doGetTransaction()
从类复制的说明:AbstractPlatformTransactionManager
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 DefaultTransactionStatus 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.- 指定者:
doGetTransaction
在类中AbstractPlatformTransactionManager
- 返回:
- the current transaction object
- 另请参阅:
AbstractPlatformTransactionManager.doBegin(java.lang.Object, org.springframework.transaction.TransactionDefinition)
,AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus)
,AbstractPlatformTransactionManager.doRollback(org.springframework.transaction.support.DefaultTransactionStatus)
,DefaultTransactionStatus.getTransaction()
isExistingTransaction
protected boolean isExistingTransaction(Object transaction)
从类复制的说明:AbstractPlatformTransactionManager
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.- 覆盖:
isExistingTransaction
在类中AbstractPlatformTransactionManager
- 参数:
transaction
- transaction object returned by doGetTransaction- 返回:
- if there is an existing transaction
- 另请参阅:
AbstractPlatformTransactionManager.doGetTransaction()
doBegin
protected void doBegin(Object transaction, TransactionDefinition definition)
从类复制的说明:AbstractPlatformTransactionManager
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 without savepoint: If
useSavepointForNestedTransaction()
returns "false", 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.- 指定者:
doBegin
在类中AbstractPlatformTransactionManager
- 参数:
transaction
- transaction object returned bydoGetTransaction
definition
- TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name
doSuspend
protected Object doSuspend(Object transaction)
从类复制的说明:AbstractPlatformTransactionManager
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.
- 覆盖:
doSuspend
在类中AbstractPlatformTransactionManager
- 参数:
transaction
- transaction object returned bydoGetTransaction
- 返回:
- an object that holds suspended resources (will be kept unexamined for passing it into doResume)
- 另请参阅:
AbstractPlatformTransactionManager.doResume(java.lang.Object, java.lang.Object)
doResume
protected void doResume(Object transaction, Object suspendedResources)
从类复制的说明:AbstractPlatformTransactionManager
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.
- 覆盖:
doResume
在类中AbstractPlatformTransactionManager
- 参数:
transaction
- transaction object returned bydoGetTransaction
suspendedResources
- the object that holds suspended resources, as returned by doSuspend- 另请参阅:
AbstractPlatformTransactionManager.doSuspend(java.lang.Object)
doCommit
protected void doCommit(DefaultTransactionStatus status)
从类复制的说明:AbstractPlatformTransactionManager
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.
- 指定者:
doCommit
在类中AbstractPlatformTransactionManager
- 参数:
status
- the status representation of the transaction- 另请参阅:
DefaultTransactionStatus.getTransaction()
doRollback
protected void doRollback(DefaultTransactionStatus status)
从类复制的说明:AbstractPlatformTransactionManager
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.
- 指定者:
doRollback
在类中AbstractPlatformTransactionManager
- 参数:
status
- the status representation of the transaction- 另请参阅:
DefaultTransactionStatus.getTransaction()
doSetRollbackOnly
protected void doSetRollbackOnly(DefaultTransactionStatus status)
从类复制的说明:AbstractPlatformTransactionManager
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.
- 覆盖:
doSetRollbackOnly
在类中AbstractPlatformTransactionManager
- 参数:
status
- the status representation of the transaction
doCleanupAfterCompletion
protected void doCleanupAfterCompletion(Object transaction)
从类复制的说明:AbstractPlatformTransactionManager
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.
- 覆盖:
doCleanupAfterCompletion
在类中AbstractPlatformTransactionManager
- 参数:
transaction
- transaction object returned bydoGetTransaction
prepareTransactionalConnection
protected void prepareTransactionalConnection(Connection con, TransactionDefinition definition) throws SQLException
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.
- 参数:
con
- the transactional JDBC Connectiondefinition
- the current transaction definition- 抛出:
SQLException
- if thrown by JDBC API- 从以下版本开始:
- 4.3.7
- 另请参阅:
setEnforceReadOnly(boolean)