类 JpaTransactionManager
- java.lang.Object
- org.springframework.transaction.support.AbstractPlatformTransactionManager
- org.springframework.orm.jpa.JpaTransactionManager
- 所有已实现的接口:
Serializable
,Aware
,BeanFactoryAware
,InitializingBean
,PlatformTransactionManager
,ResourceTransactionManager
public class JpaTransactionManager extends AbstractPlatformTransactionManager implements ResourceTransactionManager, BeanFactoryAware, InitializingBean
PlatformTransactionManager
implementation for a single JPAEntityManagerFactory
. Binds a JPA EntityManager from the specified factory to the thread, potentially allowing for one thread-bound EntityManager per factory.SharedEntityManagerCreator
and@PersistenceContext
are aware of thread-bound entity managers and participate in such transactions automatically. Using either is required for JPA access code supporting this transaction management mechanism.This transaction manager is appropriate for applications that use a single JPA EntityManagerFactory for transactional data access. JTA (usually through
JtaTransactionManager
) is necessary for accessing multiple transactional resources within the same transaction. Note that you need to configure your JPA provider accordingly in order to make it participate in JTA transactions.This transaction manager also supports direct DataSource access within a transaction (i.e. plain JDBC code working with the same DataSource). This allows for mixing services which access JPA and services which use plain JDBC (without being aware of JPA)! Application code needs to stick to the same simple Connection lookup pattern as with
DataSourceTransactionManager
(i.e.DataSourceUtils.getConnection(javax.sql.DataSource)
or going through aTransactionAwareDataSourceProxy
). Note that this requires a vendor-specificJpaDialect
to be configured.Note: To be able to register a DataSource's Connection for plain JDBC code, this instance needs to be aware of the DataSource (
setDataSource(javax.sql.DataSource)
). The given DataSource should obviously match the one used by the given EntityManagerFactory. This transaction manager will autodetect the DataSource used as the connection factory of the EntityManagerFactory, so you usually don't need to explicitly specify the "dataSource" property.This transaction manager supports nested transactions via JDBC 3.0 Savepoints. The
"nestedTransactionAllowed"
flag defaults tofalse
though, since nested transactions will just apply to the JDBC Connection, not to the JPA EntityManager and its cached entity objects and related context. You can manually set the flag totrue
if you want to use nested transactions for JDBC access code which participates in JPA transactions (provided that your JDBC driver supports Savepoints). Note that JPA itself does not support nested transactions! Hence, do not expect JPA access code to semantically participate in a nested transaction.- 从以下版本开始:
- 2.0
- 作者:
- Juergen Hoeller
- 另请参阅:
setEntityManagerFactory(javax.persistence.EntityManagerFactory)
,setDataSource(javax.sql.DataSource)
,LocalEntityManagerFactoryBean
,SharedEntityManagerBean
,DataSourceUtils.getConnection(javax.sql.DataSource)
,DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)
,JdbcTemplate
,DataSourceTransactionManager
,JtaTransactionManager
, 序列化表格
字段概要
从类继承的字段 org.springframework.transaction.support.AbstractPlatformTransactionManager
logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION
构造器概要
构造器 构造器 说明 JpaTransactionManager()
Create a new JpaTransactionManager instance.JpaTransactionManager(EntityManagerFactory emf)
Create a new JpaTransactionManager instance.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Eagerly initialize the JPA dialect, creating a default one for the specified EntityManagerFactory if none set.protected void
closeEntityManagerAfterFailedBegin(org.springframework.orm.jpa.JpaTransactionManager.JpaTransactionObject txObject)
Close the current transaction's EntityManager.protected EntityManager
createEntityManagerForTransaction()
Create a JPA EntityManager to be used for a transaction.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.EntityManagerFactory
getEntityManagerFactory()
Return the EntityManagerFactory that this instance should manage transactions for.JpaDialect
getJpaDialect()
Return the JPA dialect to use for this transaction manager.Map<String,Object>
getJpaPropertyMap()
Allow Map access to the JPA properties to be passed to the persistence provider, with the option to add or override specific entries.String
getPersistenceUnitName()
Return the name of the persistence unit to manage transactions for, if any.Object
getResourceFactory()
Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory.protected boolean
isExistingTransaction(Object transaction)
Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).void
setBeanFactory(BeanFactory beanFactory)
Retrieves an EntityManagerFactory by persistence unit name, if none set explicitly.void
setDataSource(DataSource dataSource)
Set the JDBC DataSource that this instance should manage transactions for.void
setEntityManagerFactory(EntityManagerFactory emf)
Set the EntityManagerFactory that this instance should manage transactions for.void
setJpaDialect(JpaDialect jpaDialect)
Set the JPA dialect to use for this transaction manager.void
setJpaProperties(Properties jpaProperties)
Specify JPA properties, to be passed intoEntityManagerFactory.createEntityManager(Map)
(if any).void
setJpaPropertyMap(Map<String,?> jpaProperties)
Specify JPA properties as a Map, to be passed intoEntityManagerFactory.createEntityManager(Map)
(if any).void
setPersistenceUnitName(String persistenceUnitName)
Set the name of the persistence unit to manage transactions for.protected boolean
shouldCommitOnGlobalRollbackOnly()
This implementation returns "true": a JPA commit will properly handle transactions that have been marked rollback-only at a global level.从类继承的方法 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, 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
构造器详细资料
JpaTransactionManager
public JpaTransactionManager()
Create a new JpaTransactionManager instance.An EntityManagerFactory has to be set to be able to use it.
JpaTransactionManager
public JpaTransactionManager(EntityManagerFactory emf)
Create a new JpaTransactionManager instance.- 参数:
emf
- the EntityManagerFactory to manage transactions for
方法详细资料
setEntityManagerFactory
public void setEntityManagerFactory(EntityManagerFactory emf)
Set the EntityManagerFactory that this instance should manage transactions for.Alternatively, specify the persistence unit name of the target EntityManagerFactory. By default, a default EntityManagerFactory will be retrieved by finding a single unique bean of type EntityManagerFactory in the containing BeanFactory.
getEntityManagerFactory
public EntityManagerFactory getEntityManagerFactory()
Return the EntityManagerFactory that this instance should manage transactions for.
setPersistenceUnitName
public void setPersistenceUnitName(String persistenceUnitName)
Set the name of the persistence unit to manage transactions for.This is an alternative to specifying the EntityManagerFactory by direct reference, resolving it by its persistence unit name instead. If no EntityManagerFactory and no persistence unit name have been specified, a default EntityManagerFactory will be retrieved by finding a single unique bean of type EntityManagerFactory.
getPersistenceUnitName
public String getPersistenceUnitName()
Return the name of the persistence unit to manage transactions for, if any.
setJpaProperties
public void setJpaProperties(Properties jpaProperties)
Specify JPA properties, to be passed intoEntityManagerFactory.createEntityManager(Map)
(if any).Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.
setJpaPropertyMap
public void setJpaPropertyMap(Map<String,?> jpaProperties)
Specify JPA properties as a Map, to be passed intoEntityManagerFactory.createEntityManager(Map)
(if any).Can be populated with a "map" or "props" element in XML bean definitions.
getJpaPropertyMap
public Map<String,Object> getJpaPropertyMap()
Allow Map access to the JPA properties to be passed to the persistence provider, with the option to add or override specific entries.Useful for specifying entries directly, for example via "jpaPropertyMap[myKey]".
setDataSource
public void setDataSource(DataSource dataSource)
Set the JDBC DataSource that this instance should manage transactions for. The DataSource should match the one used by the JPA EntityManagerFactory: for example, you could specify the same JNDI DataSource for both.If the EntityManagerFactory uses a known DataSource as its connection factory, the DataSource will be autodetected: You can still explicitly specify the DataSource, but you don't need to in this case.
A transactional JDBC Connection for this DataSource will be provided to application code accessing this DataSource directly via DataSourceUtils or JdbcTemplate. The Connection will be taken from the JPA EntityManager.
Note that you need to use a JPA dialect for a specific JPA implementation to allow for exposing JPA transactions as JDBC transactions.
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.
getDataSource
public DataSource getDataSource()
Return the JDBC DataSource that this instance manages transactions for.
setJpaDialect
public void setJpaDialect(JpaDialect jpaDialect)
Set the JPA dialect to use for this transaction manager. Used for vendor-specific transaction management and JDBC connection exposure.If the EntityManagerFactory uses a known JpaDialect, it will be autodetected: You can still explicitly specify the DataSource, but you don't need to in this case.
The dialect object can be used to retrieve the underlying JDBC connection and thus allows for exposing JPA transactions as JDBC transactions.
getJpaDialect
public JpaDialect getJpaDialect()
Return the JPA dialect to use for this transaction manager.
setBeanFactory
public void setBeanFactory(BeanFactory beanFactory) throws BeansException
Retrieves an EntityManagerFactory by persistence unit name, if none set explicitly. Falls back to a default EntityManagerFactory bean if no persistence unit specified.- 指定者:
setBeanFactory
在接口中BeanFactoryAware
- 参数:
beanFactory
- owning BeanFactory (nevernull
). The bean can immediately call methods on the factory.- 抛出:
BeansException
- in case of initialization errors- 另请参阅:
setPersistenceUnitName(java.lang.String)
afterPropertiesSet
public void afterPropertiesSet()
Eagerly initialize the JPA dialect, creating a default one for the specified EntityManagerFactory if none set. Auto-detect the EntityManagerFactory's DataSource, if any.- 指定者:
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
createEntityManagerForTransaction
protected EntityManager createEntityManagerForTransaction()
Create a JPA EntityManager to be used for a transaction.The default implementation checks whether the EntityManagerFactory is a Spring proxy and unwraps it first.
closeEntityManagerAfterFailedBegin
protected void closeEntityManagerAfterFailedBegin(org.springframework.orm.jpa.JpaTransactionManager.JpaTransactionObject txObject)
Close the current transaction's EntityManager. Called after a transaction begin attempt failed.- 参数:
txObject
- the current transaction
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)
shouldCommitOnGlobalRollbackOnly
protected boolean shouldCommitOnGlobalRollbackOnly()
This implementation returns "true": a JPA commit will properly handle transactions that have been marked rollback-only at a global level.- 覆盖:
shouldCommitOnGlobalRollbackOnly
在类中AbstractPlatformTransactionManager
- 另请参阅:
AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus)
,DefaultTransactionStatus.isGlobalRollbackOnly()
,AbstractTransactionStatus.isLocalRollbackOnly()
,TransactionStatus.setRollbackOnly()
,UnexpectedRollbackException
,UserTransaction.commit()
,RollbackException
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