Spring源码系列文章
Spring源码解析(一):环境搭建
Spring源码解析(二):bean容器的创建、默认后置处理器、扫描包路径bean
Spring源码解析(三):bean容器的刷新
Spring源码解析(四):单例bean的创建流程
Spring源码解析(五):循环依赖
Spring源码解析(六):bean工厂后置处理器ConfigurationClassPostProcessor
Spring源码解析(七):bean后置处理器AutowiredAnnotationBeanPostProcessor
Spring源码解析(八):bean后置处理器CommonAnnotationBeanPostProcessor
Spring源码解析(九):AOP源码之@Aspect所有相关注解解析
Spring源码解析(十):spring整合mybatis源码
Spring源码解析(十一):spring事务配置类源码
Spring源码解析(十二):TransactionInterceptor事务拦截器
TransactionInterceptor
实现了MethodInterceptor
,核心方法就是invoke
方法// invocation:代表了要进行事务管理的方法
public Object invoke(MethodInvocation invocation) throws Throwable {
Class<?> targetClass = (invocation.getThis() != null ? AopUtils.getTargetClass(invocation.getThis()) : null);
// 核心方法就是invokeWithinTransaction
return invokeWithinTransaction(invocation.getMethod(), targetClass, invocation::proceed);
}
TransactionAspectSupport#invokeWithinTransaction方法分析
响应式事务管理
、标准事务管理
、通过回调实现事务管理
protected Object invokeWithinTransaction(Method method, @Nullable Class<?> targetClass,
final InvocationCallback invocation) throws Throwable {
// 之前在配置类中注册了一个AnnotationTransactionAttributeSource
// 这里就是直接返回了之前注册的那个Bean,通过它去获取事务属性
// 创建事务拦截器时候就把AnnotationTransactionAttributeSource set进来了,这里直接获取
TransactionAttributeSource tas = getTransactionAttributeSource();
// 解析@Transactional注解获取事务属性
final TransactionAttribute txAttr = (tas != null ? tas.getTransactionAttribute(method, targetClass) : null);
// 获取对应的事务管理器
// 可以做在注解属性transactionManager中指定事务管理器
// 配置类@Bean new DataSourceTransactionManager();
final TransactionManager tm = determineTransactionManager(txAttr);
// ...
// 忽略响应式的事务管理
// ...
// 做了个强转PlatformTransactionManager
// 这里是DataSourceTransactionManager转为PlatformTransactionManager
PlatformTransactionManager ptm = asPlatformTransactionManager(tm);
// 切点名称(类名+方法名),会被作为事务的名称
final String joinpointIdentification = methodIdentification(method, targetClass, txAttr);
if (txAttr == null || !(ptm instanceof CallbackPreferringPlatformTransactionManager)) {
// 创建事务
TransactionInfo txInfo = createTransactionIfNecessary(ptm, txAttr, joinpointIdentification);
Object retVal;
try {
// 这里执行真正的业务逻辑
retVal = invocation.proceedWithInvocation();
}
catch (Throwable ex) {
// 方法执行出现异常,在异常情况下完成事务
completeTransactionAfterThrowing(txInfo, ex);
throw ex;
}
finally {
// 清除线程中的事务信息
cleanupTransactionInfo(txInfo);
}
// ...
// 省略不重要代码
// ...
// 提交事务
commitTransactionAfterReturning(txInfo);
return retVal;
}
// ....
// 省略回调实现事务管理相关代码
// ....
return result;
}
}
总结:
// getTransactionAttribute:先从拦截的方法上找@Transactional注解
// 如果方法上没有的话,再从方法所在的类上找,如果类上还没有的话尝试从接口或者父类上找
public TransactionAttribute getTransactionAttribute(Method method, @Nullable Class<?> targetClass) {
if (method.getDeclaringClass() == Object.class) {
return null;
}
// 在缓存中查找
Object cacheKey = getCacheKey(method, targetClass);
TransactionAttribute cached = this.attributeCache.get(cacheKey);
if (cached != null) {
if (cached == NULL_TRANSACTION_ATTRIBUTE) {
return null;
}
else {
return cached;
}
}
else {
// 这里真正的去执行解析
TransactionAttribute txAttr = computeTransactionAttribute(method, targetClass);
// 缓存解析的结果,如果为事务属性为null,也放入一个标志
// 代表这个方法不需要进行事务管理
if (txAttr == null) {
// NULL_TRANSACTION_ATTRIBUTE = new DefaultTransactionAttribute()
this.attributeCache.put(cacheKey, NULL_TRANSACTION_ATTRIBUTE);
}
else {
String methodIdentification = ClassUtils.getQualifiedMethodName(method, targetClass);
if (txAttr instanceof DefaultTransactionAttribute) {
((DefaultTransactionAttribute) txAttr).setDescriptor(methodIdentification);
}
this.attributeCache.put(cacheKey, txAttr);
}
return txAttr;
}
}
真正解析注解时调用了computeTransactionAttribute方法
allowPublicMethodsOnly为true
,如果方法不是public
,属性返回空,那么@Transactional不生效优先级最高
)protected TransactionAttribute computeTransactionAttribute(Method method, @Nullable Class<?> targetClass) {
// 默认情况下allowPublicMethodsOnly为true
// 这意味着@Transactional如果放在非public方法上不会生效
if (allowPublicMethodsOnly() && !Modifier.isPublic(method.getModifiers())) {
return null;
}
// method是接口中的方法
// specificMethod是具体实现类的方法
Method specificMethod = AopUtils.getMostSpecificMethod(method, targetClass);
// 先在目标类方法上找
TransactionAttribute txAttr = findTransactionAttribute(specificMethod);
if (txAttr != null) {
return txAttr;
}
// 再在目标类上找
txAttr = findTransactionAttribute(specificMethod.getDeclaringClass());
if (txAttr != null && ClassUtils.isUserLevelMethod(method)) {
return txAttr;
}
// 到这里表示没有在目标方法或者类上找到事务注解,如果最终的目标方法和当前方法不一致,那么在当前方法中查找
// 实际上很难走到这一步,在此前的查找中基本上就返回了
// 最后到接口跟接口中的方法上找这个注解
if (specificMethod != method) {
txAttr = findTransactionAttribute(method);
if (txAttr != null) {
return txAttr;
}
txAttr = findTransactionAttribute(method.getDeclaringClass());
if (txAttr != null && ClassUtils.isUserLevelMethod(method)) {
return txAttr;
}
}
//以上都找不到事务注解,那么将返回null,表示当前方法不会进行事务代理
return null;
}
@Transactional
注解的的属性,并包装成RuleBasedTransactionAttribute
对象返回RuleBasedTransactionAttribute类图:
获取对应的事务管理器
@Transactional
注解属性transactionManager
中指定事务管理器@Nullable
protected TransactionManager determineTransactionManager(@Nullable TransactionAttribute txAttr) {
// 如果没有事务属性,那么直接获取手动设置的事务管理器,可能返回null
//编程式事务也会调用该方法,并且没有事务属性
if (txAttr == null || this.beanFactory == null) {
return getTransactionManager();
}
//获取限定符,也就是每一个@Transactional注解的value属性或者transactionManager属性
String qualifier = txAttr.getQualifier();
//如果设置了该属性,那么通过限定符从容器中查找指定的事务管理器
//一般都是注解设置的,基于XML的 标签没有配置该属性
if (StringUtils.hasText(qualifier)) {
return determineQualifiedTransactionManager(this.beanFactory, qualifier);
}
//否则,如果设置了transactionManagerBeanName属性,那么通过限定符查找指定的事务管理器
//一般都是基于XML的 标签的transaction-manager属性
else if (StringUtils.hasText(this.transactionManagerBeanName)) {
return determineQualifiedTransactionManager(this.beanFactory, this.transactionManagerBeanName);
}
//否则,将会查找事务管理器,这个就是现在最常见的逻辑
else {
//获取手动设置的事务管理器
TransactionManager defaultTransactionManager = getTransactionManager();
//如果没有,那么获取默认的事务管理器
if (defaultTransactionManager == null) {
//从缓存中通过默认key尝试获取默认的事务管理器
defaultTransactionManager = this.transactionManagerCache.get(DEFAULT_TRANSACTION_MANAGER_KEY);
//如果为null
if (defaultTransactionManager == null) {
//那么尝试从容器中查找TransactionManager类型的bean,并且作为默认事务管理器
//这就是基于注解配置的最常见的逻辑,该方法如果找不到事务管理器或者找到多个事务管理器,那么将抛出异常
defaultTransactionManager = this.beanFactory.getBean(TransactionManager.class);
//找到了之后存入缓存,key就是默认key
this.transactionManagerCache.putIfAbsent(
DEFAULT_TRANSACTION_MANAGER_KEY, defaultTransactionManager);
}
}
//返回事务管理器
return defaultTransactionManager;
}
}
TransactionInfo
protected TransactionInfo createTransactionIfNecessary(@Nullable PlatformTransactionManager tm,
@Nullable TransactionAttribute txAttr,
final String joinpointIdentification) {
// 如果没有为事务指定名称,使用切点作为事务名称("com.xc.aop.Calculatorlmpl.add")
if (txAttr != null && txAttr.getName() == null) {
txAttr = new DelegatingTransactionAttribute(txAttr) {
@Override
public String getName() {
return joinpointIdentification;
}
};
}
TransactionStatus status = null;
if (txAttr != null) {
if (tm != null) {
// 调用事务管理器的方法,获取一个事务并返回事务的状态
status = tm.getTransaction(txAttr);
}
// ....省略日志
}
// 将事务相关信息封装到TransactionInfo对象中
// 并将TransactionInfo绑定到当前线程
return prepareTransactionInfo(tm, txAttr, joinpointIdentification, status);
}
直接调用
)嵌套调用
)public final TransactionStatus getTransaction(@Nullable TransactionDefinition definition)
throws TransactionException {
// 事务的属性(TransactionAttribute),通过解析@Transacational注解的属性及一些默认属性
TransactionDefinition def = (definition != null ? definition : TransactionDefinition.withDefaults());
// 获取一个数据库事务对象(DataSourceTransactionObject),
// 这个对象中封装了一个从当前线程上下文中获取到的连接
Object transaction = doGetTransaction();
boolean debugEnabled = logger.isDebugEnabled();
// 判断是否存在事务
// 如果之前获取到的连接不为空,并且连接上激活了事务,那么就为true
if (isExistingTransaction(transaction)) {
// 如果已经存在了事务,需要根据不同传播机制进行不同的处理
return handleExistingTransaction(def, transaction, debugEnabled);
}
/*
* 到这里表示没有已存在的事务,进入第一个事务方法时将会走这个逻辑
*/
// 设置的事务超时时间如果小于默认超时时间(-1),将会抛出异常:无效的超时时间
if (def.getTimeout() < TransactionDefinition.TIMEOUT_DEFAULT) {
throw new InvalidTimeoutException("Invalid transaction timeout", def.getTimeout());
}
// 如果配置的事务的传播行为是mandatory,直接抛出异常
// 该传播行为的含义是:必须运行在一个事务中,如果当前没有事务正在发生,将抛出一个异常
if (def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_MANDATORY) {
throw new IllegalTransactionStateException(
"No existing transaction found for transaction marked with propagation 'mandatory'");
}
// 否则,如果配置的事务的传播行为是required或者requires_new或者nested
// 这几个传播行为的含义的共同点之一就是:如果当前不存在事务,就创建一个新事务运行
// 那么这里将开启一个新事物
else if (def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_REQUIRED ||
def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_REQUIRES_NEW ||
def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NESTED) {
// 如果存在同步,将注册的同步挂起,获取挂起的资源,这里为空
// 挂起操作,但是此时没事务也没激活同步,反正就是啥也没干
SuspendedResourcesHolder suspendedResources = suspend(null);
if (debugEnabled) {
logger.debug("Creating new transaction with name [" + def.getName() + "]: " + def);
}
try {
// 开启一个新事务
return startTransaction(def, transaction, debugEnabled, suspendedResources);
}
catch (RuntimeException | Error ex) {
// 唤醒此前挂起的事务和资源
resume(null, suspendedResources);
throw ex;
}
}
// 否则,配置的事务的传播行为就是剩下的三种:supports或never或not_supported
// 这几个传播行为的含义的共同点之一就是:当前方法一定以非事务的方式运行
else {
// 创建一个空事务,没有实际的事务提交以及回滚机制
// 会激活同步:将数据库连接绑定到当前线程上
boolean newSynchronization = (getTransactionSynchronization() == SYNCHRONIZATION_ALWAYS);
return prepareTransactionStatus(def, null, true, newSynchronization, debugEnabled, null);
}
}
数据库事务连接资源
和事务同步器
(TransactionSynchronization)一个线程当前只能激活一个连接资源
,因此如果需要绑定新的连接资源,那么需要将此前绑定的资源删除(或者说保存起来,等新资源使用完毕之后再恢复此前的连接资源)/**
* 事务资源管理器
*/
public abstract class TransactionSynchronizationManager {
/**
* 事务资源
* 一个ThreadLocal属性,用于存放线程当前使用的数据库资源
* value是一个Map
private static final ThreadLocal<Map<Object, Object>> resources =
new NamedThreadLocal<>("Transactional resources");
/**
* 事务同步
* 一个ThreadLocal属性,用于存放线程当前激活的事务同步器TransactionSynchronization
* 每个线程都可以开启多个事物同步,用于在处理事务的各个阶段进行自定义扩展或者回调
* TransactionSynchronization的同步回调功能类似于此前学习的@TransactionalEventListener
*/
private static final ThreadLocal<Set<TransactionSynchronization>> synchronizations =
new NamedThreadLocal<>("Transaction synchronizations");
/**
* 当前事务的名称
* 一个ThreadLocal属性,用于存放线程当前的事务的名称
*/
private static final ThreadLocal<String> currentTransactionName =
new NamedThreadLocal<>("Current transaction name");
/**
* 当前事务的只读状态
* 一个ThreadLocal属性,用于存放线程当前的事务的只读状态
*/
private static final ThreadLocal<Boolean> currentTransactionReadOnly =
new NamedThreadLocal<>("Current transaction read-only status");
/**
* 当前事务的隔离级别
* 一个ThreadLocal属性,用于存放线程当前的当前事务的隔离级别
*/
private static final ThreadLocal<Integer> currentTransactionIsolationLevel =
new NamedThreadLocal<>("Current transaction isolation level");
/**
* 当前事务是否开启
* 一个ThreadLocal属性,用于存放线程当前是否开启了事务
*/
private static final ThreadLocal<Boolean> actualTransactionActive =
new NamedThreadLocal<>("Actual transaction active");
//与事务资源相关的管理方法
//………………
}
TransactionSynchronization事务同步
执行状态
,并且可以在某个状态转变时执行各种回调操作
public interface TransactionSynchronization extends Flushable {
/** 事务提交状态 */
int STATUS_COMMITTED = 0;
/** 事务回滚状态 */
int STATUS_ROLLED_BACK = 1;
/**系统异常状态 */
int STATUS_UNKNOWN = 2;
//在spring开启新事务,获取connection之前会调用(未执行registCustomer)
void suspend();
//开启新事务失败时会调用(未执行registCustomer)
void resume();
//没调用
void flush();
// 事务提交之前
void beforeCommit(boolean readOnly);
// 事务成功或者事务回滚之前
void beforeCompletion();
// 事务成功提交之后
void afterCommit();
// 操作完成之后(包含事务成功或者事务回滚)
void afterCompletion(int status);
}
流程图:
DataSourceTransactionObject
对象,内部持有ConnectionHolder
(数据连接持有对象)DriverManagerDataSource
ThreadLocal
获取连接持有对象ConnectionHolder,因为此时还没有获取连接及绑定到当前线程,所以ConnectionHolder对象为空@Override
protected Object doGetTransaction() {
//创建一个DataSourceTransactionObject,由DataSourceTransactionManager用作内部事务对象
//内部可能会持有一个ConnectionHolder对象,还具有创建、回滚、释放保存点的功能
DataSourceTransactionObject txObject = new DataSourceTransactionObject();
//设置是否允许保存点,DataSourceTransactionManager默认会允许,用于实现嵌套事务
txObject.setSavepointAllowed(isNestedTransactionAllowed());
//obtainDataSource方法用于获取配置的数据源,就是我们自己配置的数据源DriverManagerDataSource
//getResource用于获取此线程在当前数据源中已拥有JDBC连接资源持有者ConnectionHolder
//如果此前没有获取过连接,则返回null;如果此前开启了过事务(外层事务),那么肯定不会获取null
ConnectionHolder conHolder =
(ConnectionHolder) TransactionSynchronizationManager.getResource(obtainDataSource());
//设置连接信息,newConnectionHolder属性设置为false,这表示默认此前已经存在ConnectionHolder
//但实际上可能并没有,因此后面的步骤中会再次判断该值
txObject.setConnectionHolder(conHolder, false);
return txObject;
}
// 检查是否有现有事务(即已经开启过事务)
protected boolean isExistingTransaction(Object transaction) {
DataSourceTransactionObject txObject = (DataSourceTransactionObject) transaction;
// 只有在存在连接并且连接上已经激活了事务才会返回true
return (txObject.hasConnectionHolder() && txObject.getConnectionHolder().isTransactionActive());
}
required
或者requires_new
或者nested
则开启事务DefaultTransactionStatus
实现并返回,内部持有我们为当前方法配置的事务属性或者默认属性,以及保存着此前挂起的资源private TransactionStatus startTransaction(TransactionDefinition definition, Object transaction,
boolean debugEnabled, @Nullable SuspendedResourcesHolder suspendedResources) {
//判断是否需要开启新同步,默认都是SYNCHRONIZATION_ALWAYS,即需要开启
boolean newSynchronization = (getTransactionSynchronization() != SYNCHRONIZATION_NEVER);
// 根据之前的事务定义等相关信息构造一个事务状态对象
DefaultTransactionStatus status = newTransactionStatus(
definition, transaction, true, newSynchronization, debugEnabled, suspendedResources);
// 真正开启事务,会从数据源中获取连接并绑定到线程上
doBegin(transaction, definition);
// 在这里会激活同步
prepareSynchronization(status, definition);
return status;
}
/**
* AbstractPlatformTransactionManager的方法
* 为给定参数新创建一个TransactionStatus实例,实际类型为DefaultTransactionStatus
*
* @param definition 为当前方法配置的事务定义
* @param transaction 获取的事务对象
* @param newTransaction 是否是新事物
* @param newSynchronization 是否开启事务同步
* @param debug 是否支持debug级别的日志
* @param suspendedResources 被挂起的资源,比如此前的事务同步
* @return DefaultTransactionStatus对象
*/
protected DefaultTransactionStatus newTransactionStatus(
TransactionDefinition definition, @Nullable Object transaction, boolean newTransaction,
boolean newSynchronization, boolean debug, @Nullable Object suspendedResources) {
//如果newSynchronization为true并且当前线程没有绑定的事务同步,那么确定开启新事物同步
//由于此前调用了suspend方法清理了此前的事务同步,因此一般都是需要开启新事务同步,即为true
boolean actualNewSynchronization = newSynchronization &&
!TransactionSynchronizationManager.isSynchronizationActive();
//返回一个新建的DefaultTransactionStatus对象,该对象被用来表示新开启的事务,是TransactionStatus的默认实现
//内部包括了各种新开启的事务状态,当然包括此前挂起的事务的资源
return new DefaultTransactionStatus(
transaction, newTransaction, actualNewSynchronization,
definition.isReadOnly(), debug, suspendedResources);
}
doBegin真正开启事务
隔离级别
,只读标志属性
autoCommit=false
数据库连接绑定到当前线程
上,即ThreadLocalprotected void doBegin(Object transaction, TransactionDefinition definition) {
// 强转为内部事务对象
DataSourceTransactionObject txObject = (DataSourceTransactionObject) transaction;
Connection con = null;
try {
// 判断txObject中是否存在连接并且连接上已经激活了事务
// txObject是通过之前的doGetTransaction方法得到的
// 直接调用的情况下,这个判断肯定为true
if (!txObject.hasConnectionHolder() ||
txObject.getConnectionHolder().isSynchronizedWithTransaction()) {
// 从数据源中获取一个连接
Connection newCon = obtainDataSource().getConnection();
// 将连接放入到txObject中
// 第二个参数为true,标志这是一个新连接
txObject.setConnectionHolder(new ConnectionHolder(newCon), true);
}
// 获取事务对象的连接持有者,将synchronizedWithTransaction设置为true,即资源标记为与事务同步
txObject.getConnectionHolder().setSynchronizedWithTransaction(true);
// 获取内部保存的连接
con = txObject.getConnectionHolder().getConnection();
// 设置数据库事务的隔离级别,只读标志属性(下面细说)
Integer previousIsolationLevel = DataSourceUtils.prepareConnectionForTransaction(con, definition);
txObject.setPreviousIsolationLevel(previousIsolationLevel);
txObject.setReadOnly(definition.isReadOnly());
// 一般数据源默认自动提交,这会会修改为autoCommit=false,手动提交
if (con.getAutoCommit()) {
txObject.setMustRestoreAutoCommit(true);
con.setAutoCommit(false);
}
// 只读事务优化(下面细说)
prepareTransactionalConnection(con, definition);
// 设置事务ConnectionHolder的transactionActive属性为true,表示激活当前连接的事务
// 此前判断是否有开启事务的isExistingTransaction方法就会判断这个属性
txObject.getConnectionHolder().setTransactionActive(true);
// 设置超时时间
int timeout = determineTimeout(definition);
if (timeout != TransactionDefinition.TIMEOUT_DEFAULT) {
txObject.getConnectionHolder().setTimeoutInSeconds(timeout);
}
// 如果是新的连接持有者,即newConnectionHolder属性为true
if (txObject.isNewConnectionHolder()) {
// 将连接绑定到当前线程上
// 绑定ConnectionHolder资源到TransactionSynchronizationManager的resources属性中
// key就是当前的属性源,value就是ConnectionHolder
TransactionSynchronizationManager.bindResource(obtainDataSource(), txObject.getConnectionHolder());
}
}
catch (Throwable ex) {
// 出现异常的话,需要归还连接
if (txObject.isNewConnectionHolder()) {
DataSourceUtils.releaseConnection(con, obtainDataSource());
txObject.setConnectionHolder(null, false);
}
throw new CannotCreateTransactionException("Could not open JDBC Connection for transaction", ex);
}
}
prepareConnectionForTransaction 设置隔离级别和只读属性:
@Nullable
public static Integer prepareConnectionForTransaction(Connection con, @Nullable TransactionDefinition definition)
throws SQLException {
boolean debugEnabled = logger.isDebugEnabled();
// 设置只读标志。
if (definition != null && definition.isReadOnly()) {
try {
//设置连接只读属性
con.setReadOnly(true);
} catch (SQLException | RuntimeException ex) {
Throwable exToCheck = ex;
while (exToCheck != null) {
if (exToCheck.getClass().getSimpleName().contains("Timeout")) {
throw ex;
}
exToCheck = exToCheck.getCause();
}
}
}
// 以前的隔离级别
Integer previousIsolationLevel = null;
//如果存在隔离级别并且不等于默认配置,即不等于ISOLATION_DEFAULT(该级别的意思是使用数据库的默认级别)
if (definition != null && definition.getIsolationLevel() != TransactionDefinition.ISOLATION_DEFAULT) {
//获取当前连接的隔离级别
int currentIsolation = con.getTransactionIsolation();
// 如果手动设置的隔离级别不等于连接的隔离级别
if (currentIsolation != definition.getIsolationLevel()) {
//记录连接的隔离级别
previousIsolationLevel = currentIsolation;
//连接的隔离级别手动设置为我们配置的隔离级别
con.setTransactionIsolation(definition.getIsolationLevel());
}
}
//返回此前的连接的隔离级别,可能为null
return previousIsolationLevel;
}
prepareTransactionalConnection优化只读事务:
mysql支持
Spring的readOnly参数,即支持JDBC的con.setReadOnly(true),因此就没必要再设置enforceReadOnly为trueoracle不支持
con.setReadOnly(true),Spring的readOnly配置对于Oracle无效,需要通过stmt.executeUpdate(“SET TRANSACTION READ ONLY”);实现只读事务protected void prepareTransactionalConnection(Connection con, TransactionDefinition definition)
throws SQLException {
//如果将"enforceReadOnly"标志设置为true,并且事务定义指示只读事务
if (isEnforceReadOnly() && definition.isReadOnly()) {
//那么获取Statement,并且执行"SET TRANSACTION READ ONLY"sql语句
try (Statement stmt = con.createStatement()) {
stmt.executeUpdate("SET TRANSACTION READ ONLY");
}
}
}
/**
* DataSourceTransactionManager的属性
* 表示是否通过对事务连接显式执行sql语句强制执行事务的只读性质,默认为false
*/
private boolean enforceReadOnly = false;
bindResource绑定资源到resources:
TransactionSynchronizationManager
的resources
线程本地变量属性中DataSource(DriverManagerDataSource)
,value就是ConnectionHolder
/**
* 事务资源
*/
private static final ThreadLocal<Map<Object, Object>> resources =
new NamedThreadLocal<>("Transactional resources");
/**
* TransactionSynchronizationManager的方法
* 将给定key的给定资源value绑定到当前线程。
* 对于DataSourceTransactionManager,key就是DataSource实例,value就是ConnectionHolder
*/
public static void bindResource(Object key, Object value) throws IllegalStateException {
Object actualKey = TransactionSynchronizationUtils.unwrapResourceIfNecessary(key);
Assert.notNull(value, "Value must not be null");
//获取当前线程的本地资源map
Map<Object, Object> map = resources.get();
//如果找不到,则设置一个Map
if (map == null) {
map = new HashMap<>();
resources.set(map);
}
//将actualKey和value存入map中,返回旧的value
Object oldValue = map.put(actualKey, value);
// Transparently suppress a ResourceHolder that was marked as void...
if (oldValue instanceof ResourceHolder && ((ResourceHolder) oldValue).isVoid()) {
oldValue = null;
}
//如果已经有绑定到线程的当前key的值,则抛出异常
if (oldValue != null) {
throw new IllegalStateException("Already value [" + oldValue + "] for key [" +
actualKey + "] bound to thread [" + Thread.currentThread().getName() + "]");
}
if (logger.isTraceEnabled()) {
logger.trace("Bound value [" + value + "] for key [" + actualKey + "] to thread [" +
Thread.currentThread().getName() + "]");
}
}
prepareSynchronization准备事务同步
protected void prepareSynchronization(DefaultTransactionStatus status, TransactionDefinition definition) {
//是否是新同步,在真正的开启新事务的时候,一般都是true
if (status.isNewSynchronization()) {
// 到这里真正激活了事务
TransactionSynchronizationManager.setActualTransactionActive(status.hasTransaction());
// 隔离级别
// 只有在不是默认隔离级别的情况下才会绑定到线程上,否则绑定一个null
TransactionSynchronizationManager.setCurrentTransactionIsolationLevel(
definition.getIsolationLevel() != TransactionDefinition.ISOLATION_DEFAULT ?
definition.getIsolationLevel() : null);
// 只读状态
TransactionSynchronizationManager.setCurrentTransactionReadOnly(definition.isReadOnly());
// 事务名称
TransactionSynchronizationManager.setCurrentTransactionName(definition.getName());
// 初始化同步-ThreadLocal设置一个空LinkedHashSet
TransactionSynchronizationManager.initSynchronization();
}
}
private static final ThreadLocal<Set<TransactionSynchronization>> synchronizations =
new NamedThreadLocal<>("Transaction synchronizations");
/**
* TransactionSynchronizationManager的方法
* 激活当前线程的事务同步。由事务管理器在事务开始时调用。
* 初始化就是设置一个空LinkedHashSet
*/
public static void initSynchronization() throws IllegalStateException {
// synchronizations绑定内容不为空,isSynchronizationActive()返回true
// 如果同步已处于活动状态,即synchronizations保存的线程本地变量不为null,则抛出异常
if (isSynchronizationActive()) {
throw new IllegalStateException("Cannot activate transaction synchronization - already active");
}
logger.trace("Initializing transaction synchronization");
//否则就为当前初始化一个线程本地变量,这是一个空的LinkedHashSet
//虽然没有任何的TransactionSynchronization,但是已经不为null了
synchronizations.set(new LinkedHashSet<>());
}
DefaultTransactionStatus
事务状态对象返回没有开启事务
,仅仅是做了一个同步的初始化public final TransactionStatus getTransaction(@Nullable TransactionDefinition definition)
throws TransactionException {
// ......
// mandatory抛出异常
// required、requires_new、nested调用startTransaction开启事务
// supports、not_supported、never会进入下面这个判断
else {
// 默认同步级别就是always
boolean newSynchronization = (getTransactionSynchronization() == SYNCHRONIZATION_ALWAYS);
// 直接调用prepareTransactionStatus返回一个事务状态对象
return prepareTransactionStatus(def, null, true, newSynchronization, debugEnabled, null);
}
}
// prepareTransactionStatus方法
protected final DefaultTransactionStatus prepareTransactionStatus(
TransactionDefinition definition, @Nullable Object transaction, boolean newTransaction,
boolean newSynchronization, boolean debug, @Nullable Object suspendedResources) {
// 调用这个方法时
// definition:传入的是解析@Transactional注解得到的事务属性
// transaction:写死的传入为null,意味着没有真正的事务()
// newTransaction:写死的传入为true
// newSynchronization:默认同步级别为always,在没有真正事务的时候也进行同步
// suspendedResources:写死了,传入为null,不挂起任何资源
DefaultTransactionStatus status = newTransactionStatus(
definition, transaction, newTransaction, newSynchronization, debug, suspendedResources);
prepareSynchronization(status, definition);
return status;
}
总结直接调用情况下
mandatory
会直接抛出异常required
、requires_new
、nested
时,会调用startTransaction真正开启一个事务supports
、not_supported
、never
时,会开启一个空事务流程图:
required
、requires_new
、nested
时,isExistingTransaction才会成立,因为只有在这些传播级别下才会真正的开启事务,才会将连接绑定到当前线程public final TransactionStatus getTransaction(@Nullable TransactionDefinition definition)
throws TransactionException {
// 事务的属性(TransactionAttribute)
TransactionDefinition def = (definition != null ? definition : TransactionDefinition.withDefaults());
// 从线程上下文中获取到一个连接,并封装到一个DataSourceTransactionObject对象中
Object transaction = doGetTransaction();
boolean debugEnabled = logger.isDebugEnabled();
// 判断之前获取到的事务上是否有连接,并且连接上激活了事务
if (isExistingTransaction(transaction))
// 嵌套调用处理在这里
return handleExistingTransaction(def, transaction, debugEnabled);
}
// ...
// 下面是直接调用的情况,前文已经分析过了
// 省略直接调用的相关代码
}
protected boolean isExistingTransaction(Object transaction) {
DataSourceTransactionObject txObject = (DataSourceTransactionObject) transaction;
// 首先判断txObject中是否已经绑定了连接
// 其次判断这个连接上是否已经激活了事务
return (txObject.hasConnectionHolder() && txObject.getConnectionHolder().isTransactionActive());
}
处理嵌套事务 handleExistingTransaction
never
,那么直接抛出异常not_soupported
,那么挂起外围事务,开启一个新的空事务requires_new
,那么挂起外围事务,并且新建一个新的事务
nested
,会获取当前线程绑定的数据库连接创建一个保存点
supports、required、mandatory
时,校验嵌套事务的属性
private TransactionStatus handleExistingTransaction(
TransactionDefinition definition, Object transaction, boolean debugEnabled)
throws TransactionException {
// 如果嵌套的事务的传播级别为never,那么直接抛出异常
if (definition.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NEVER) {
throw new IllegalTransactionStateException(
"Existing transaction found for transaction marked with propagation 'never'");
}
// 如果嵌套的事务的传播级别为not_soupported,那么挂起外围事务
if (definition.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NOT_SUPPORTED) {
if (debugEnabled) {
logger.debug("Suspending current transaction");
}
// 挂起外围事务
Object suspendedResources = suspend(transaction);
boolean newSynchronization = (getTransactionSynchronization() == SYNCHRONIZATION_ALWAYS);
// 开启一个新的空事务
return prepareTransactionStatus(
definition, null, false, newSynchronization, debugEnabled, suspendedResources);
}
// 如果嵌套的事务传播级别为requires_new,那么挂起外围事务,并且新建一个新的事务
if (definition.getPropagationBehavior() == TransactionDefinition.PROPAGATION_REQUIRES_NEW) {
SuspendedResourcesHolder suspendedResources = suspend(transaction);
try {
return startTransaction(definition, transaction, debugEnabled, suspendedResources);
}
catch (RuntimeException | Error beginEx) {
resumeAfterBeginException(transaction, suspendedResources, beginEx);
throw beginEx;
}
}
// 如果嵌套事务的传播级别为nested,会获取当前线程绑定的数据库连接
// 并通过数据库连接创建一个保存点(save point)
// 其实就是调用Connection的setSavepoint方法
if (definition.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NESTED) {
// 默认是允许的,所以这个判断不会成立
if (!isNestedTransactionAllowed()) {
throw new NestedTransactionNotSupportedException(
"Transaction manager does not allow nested transactions by default - " +
"specify 'nestedTransactionAllowed' property with value 'true'");
}
// 默认是true
if (useSavepointForNestedTransaction()) {
DefaultTransactionStatus status =
prepareTransactionStatus(definition, transaction, false, false, debugEnabled, null);
status.createAndHoldSavepoint();
return status;
}
else {
// JTA进行事务管理才会进入这这里,我们不做考虑
return startTransaction(definition, transaction, debugEnabled, null);
}
}
if (debugEnabled) {
logger.debug("Participating in existing transaction");
}
// 嵌套事务传播级别为supports、required、mandatory时,是否需要校验嵌套事务的属性
// 主要校验的是个隔离级别跟只读属性
// 默认是不需要校验的
// 如果开启了校验,那么会判断如果外围事务的隔离级别跟嵌套事务的隔离级别是否一致
// 如果不一致,直接抛出异常
if (isValidateExistingTransaction()) {
if (definition.getIsolationLevel() != TransactionDefinition.ISOLATION_DEFAULT) {
Integer currentIsolationLevel = TransactionSynchronizationManager.getCurrentTransactionIsolationLevel();
if (currentIsolationLevel == null || currentIsolationLevel != definition.getIsolationLevel()) {
Constants isoConstants = DefaultTransactionDefinition.constants;
// 这里会抛出异常
}
}
// 嵌套事务的只读为false
if (!definition.isReadOnly()) {
// 但是外围事务的只读为true,那么直接抛出异常
if (TransactionSynchronizationManager.isCurrentTransactionReadOnly()) {
// 这里会抛出异常
}
}
}
boolean newSynchronization = (getTransactionSynchronization() != SYNCHRONIZATION_NEVER);
return prepareTransactionStatus(definition, transaction, false, newSynchronization, debugEnabled, null);
}
protected final SuspendedResourcesHolder suspend(@Nullable Object transaction) throws TransactionException {
// 如果当前线程的事务同步处于活动状态,即存在绑定的TransactionSynchronization,则返回true。
// 嵌套调用下,同步是已经被激活了的
if (TransactionSynchronizationManager.isSynchronizationActive()) {
// 解绑线程上绑定的同步回调,并返回
List<TransactionSynchronization> suspendedSynchronizations = doSuspendSynchronization();
try {
Object suspendedResources = null;
if (transaction != null) {
// 这里实际上就是解绑线程上绑定的数据库连接
// 同时返回这个连接
suspendedResources = doSuspend(transaction);
}
// 解绑线程上绑定的事务属性
// 获取并清空(设置为null)事物名称
String name = TransactionSynchronizationManager.getCurrentTransactionName();
TransactionSynchronizationManager.setCurrentTransactionName(null);
// 获取并清空(设置为false)事物只读状态
boolean readOnly = TransactionSynchronizationManager.isCurrentTransactionReadOnly();
TransactionSynchronizationManager.setCurrentTransactionReadOnly(false);
// 获取并清空(设置为null)事物隔离级别
Integer isolationLevel = TransactionSynchronizationManager.getCurrentTransactionIsolationLevel();
TransactionSynchronizationManager.setCurrentTransactionIsolationLevel(null);
// 获取并清空(设置为false)事物是否激活
boolean wasActive = TransactionSynchronizationManager.isActualTransactionActive();
TransactionSynchronizationManager.setActualTransactionActive(false);
// 最后集中封装为一个SuspendedResourcesHolder返回
// 之后再commit后或者rollback后使用
return new SuspendedResourcesHolder(
suspendedResources, suspendedSynchronizations, name, readOnly, isolationLevel, wasActive);
}
catch (RuntimeException | Error ex) {
// 出现异常的话,恢复
doResumeSynchronization(suspendedSynchronizations);
throw ex;
}
}
// 如果没有事务同步但是开启了事务,那么挂起事务
// 不知道什么情况会进到这里
else if (transaction != null) {
// 如果没有激活同步,那么也需要将连接挂起
Object suspendedResources = doSuspend(transaction);
// 将挂起的资源存入一个SuspendedResourcesHolder对象中返回
return new SuspendedResourcesHolder(suspendedResources);
}
else {
// 事务或者事务同步均未激活,返回null,什么也不干
return null;
}
}
doSuspendSynchronization挂起事务同步
/**
* AbstractPlatformTransactionManager的方法
* 挂起所有当前同步,并停用当前线程的事务同步。
*
* @return 挂起的TransactionSynchronization对象的列表
*/
private List<TransactionSynchronization> doSuspendSynchronization() {
//获取线程的当前的所有事务同步列表
List<TransactionSynchronization> suspendedSynchronizations =
TransactionSynchronizationManager.getSynchronizations();
//遍历,依次挂起每一个事务同步
for (TransactionSynchronization synchronization : suspendedSynchronizations) {
synchronization.suspend();
}
//清除synchronizations属性中保存的的当前线程的当前事务同步集合的引用
TransactionSynchronizationManager.clearSynchronization();
//返回被挂起的事务同步
return suspendedSynchronizations;
}
/**
* TransactionSynchronizationManager的方法
* 调用该方法时一定要保证当前线程存在事务同步,否则将抛出异常
* 因此需要先调用isSynchronizationActive方法来校验
* 返回当前线程的所有已注册的事务同步的无法修改的快照列表
*/
public static List<TransactionSynchronization> getSynchronizations() throws IllegalStateException {
// 获取当前线程的事务同步列表
Set<TransactionSynchronization> synchs = synchronizations.get();
// 为null就抛出IllegalStateException异常
if (synchs == null) {
throw new IllegalStateException("Transaction synchronization is not active");
}
// 返回不可修改的快照,以避免在迭代和调用可能进一步注册同步的同步回调时抛出ConcurrentModificationExceptions。
if (synchs.isEmpty()) {
return Collections.emptyList();
} else {
//在获取的之后对快照进行排序
List<TransactionSynchronization> sortedSynchs = new ArrayList<>(synchs);
AnnotationAwareOrderComparator.sort(sortedSynchs);
return Collections.unmodifiableList(sortedSynchs);
}
}
/**
* TransactionSynchronizationManager的方法
* 调用该方法时一定要保证当前线程存在事务同步,否则将抛出异常
* 因此需要先调用isSynchronizationActive方法来校验
* 停用当前线程的事务同步,由事务管理器在事务清理中调用
*
* @throws IllegalStateException 如果同步未激活
*/
public static void clearSynchronization() throws IllegalStateException {
// 如果没有激活事务同步,同样抛出异常
if (!isSynchronizationActive()) {
throw new IllegalStateException("Cannot deactivate transaction synchronization - not active");
}
logger.trace("Clearing transaction synchronization");
// 移除当前线程绑定到synchronizations属性的值
synchronizations.remove();
}
TransactionInfo
保存
旧事务信息,并将新事务信息TransactionInfo绑定到当前线程ThreadLocal transactionInfoHolder
/**
* TransactionAspectSupport的方法
* 为给定的属性和状态对象准备一个TransactionInfo
*
* @param txAttr TransactionAttribute,可能为null
* @param joinpointIdentification 完全限定的方法名称,用于记录日志
* @param status 当前事务的TransactionStat
*/
protected TransactionInfo prepareTransactionInfo(@Nullable PlatformTransactionManager tm,
@Nullable TransactionAttribute txAttr,
String joinpointIdentification,
@Nullable TransactionStatus status) {
/*
* 根据给定的事务属性、事务管理器、方法连接点描述字符串(全限定方法名)信息创建一个事务信息对象TransactionInfo
*/
TransactionInfo txInfo = new TransactionInfo(tm, txAttr, joinpointIdentification);
// 如果事务属性不为null
if (txAttr != null) {
//那么设置事务状态,这里就表示为当前方法创建了一个事务
txInfo.newTransactionStatus(status);
}
else {
}
//将TransactionInfo绑定到当前线程
txInfo.bindToThread();
return txInfo;
}
// 将旧的事务信息赋值,以后恢复时候使用
private TransactionInfo oldTransactionInfo;
// 将新事务信息绑定当前线程的ThreadLocal
private static final ThreadLocal<TransactionInfo> transactionInfoHolder =
new NamedThreadLocal<>("Current aspect-driven transaction");
private void bindToThread() {
// Expose current TransactionStatus, preserving any existing TransactionStatus
// for restoration after this transaction is complete.
this.oldTransactionInfo = transactionInfoHolder.get();
transactionInfoHolder.set(this);
}
resources
变量synchronizations
变量,事务的状态,挂起、回调方法等会用到事务同步对象Connection
,当初创建事务放入本地线程Threadlocal的连接rollbackFor
属性是如何配置的,如果不进行配置的话,默认只会对RuntimeException
或者Error
进行回滚protected void completeTransactionAfterThrowing(@Nullable TransactionInfo txInfo, Throwable ex) {
if (txInfo != null && txInfo.getTransactionStatus() != null) {
// transactionAttribute是从@Transactional注解中解析得来的
if (txInfo.transactionAttribute != null && txInfo.transactionAttribute.rollbackOn(ex)) {
try {
// 回滚
txInfo.getTransactionManager().rollback(txInfo.getTransactionStatus());
}
// 省略异常处理
}
else {
try {
// 即使出现异常仍然提交事务
txInfo.getTransactionManager().commit(txInfo.getTransactionStatus());
}
// 省略异常处理
}
}
}
在进行回滚时会调用事务管理器的rollback方法
public final void rollback(TransactionStatus status) throws TransactionException {
// 如果当前事务已完成,即已提交或者回滚,那么抛出异常
if (status.isCompleted()) {
throw new IllegalTransactionStateException(
"Transaction is already completed - do not call commit or rollback more than once per transaction");
}
DefaultTransactionStatus defStatus = (DefaultTransactionStatus) status;
// 这里真正处理回滚
processRollback(defStatus, false);
}
private void processRollback(DefaultTransactionStatus status, boolean unexpected) {
try {
// 传入时写死的为false
boolean unexpectedRollback = unexpected;
try {
// 完成前触发操作-删除本地线程的ThreadLoacl的资源信息resources
triggerBeforeCompletion(status);
// 存在保存点,根据我们之前的分析,说明这是一个嵌套调用的事务
// 并且内部事务的传播级别为nested
if (status.hasSavepoint()) {
// 这里会回滚到定义的保存点
status.rollbackToHeldSavepoint();
}
// 根据我们之前的分析有两种情况会满足下面这个判断
// 1.直接调用,传播级别为nested、required、requires_new
// 2.嵌套调用,并且内部事务的传播级别为requires_new
else if (status.isNewTransaction()) {
// 直接获取当前线程上绑定的数据库连接并调用其rollback方法
doRollback(status);
}
else {
// 到这里说明存在事务,但不是一个新事务并且没有保存点
// 也就是嵌套调用并且内部事务的传播级别为supports、required、mandatory
if (status.hasTransaction()) {
// status.isLocalRollbackOnly,代表事务的结果只能为回滚
// 默认是false的,在整个流程中没有看到修改这个属性
// isGlobalRollbackOnParticipationFailure
// 这个属性的含义是在加入的事务失败时是否回滚整个事务,默认为true
if (status.isLocalRollbackOnly() || isGlobalRollbackOnParticipationFailure()) {
// 从这里可以看出,但内部的事务发生异常时会将整个大事务标记成回滚
doSetRollbackOnly(status);
}
else {
// 进入这个判断说明修改了全局配置isGlobalRollbackOnParticipationFailure
// 内部事务异常并不影响外部事务
}
}
else {
// 不存在事务,回滚不做任何操作
logger.debug("Should roll back transaction but cannot - no transaction available");
}
// isFailEarlyOnGlobalRollbackOnly这个参数默认为false
// unexpectedRollback的值一开始就被赋值成了false
if (!isFailEarlyOnGlobalRollbackOnly()) {
unexpectedRollback = false;
}
}
}
catch (RuntimeException | Error ex) {
triggerAfterCompletion(status, TransactionSynchronization.STATUS_UNKNOWN);
throw ex;
}
// 完成后触发操作-删除本地线程ThreadLocal的同步信息synchronizations
triggerAfterCompletion(status, TransactionSynchronization.STATUS_ROLLED_BACK);
// unexpectedRollback是false
// 这个值如果为true,说明
if (unexpectedRollback) {
throw new UnexpectedRollbackException(
"Transaction rolled back because it has been marked as rollback-only");
}
}
finally {
// 在事务完成后需要执行一些清理动作
cleanupAfterCompletion(status);
}
}
SqlSession
/**
* AbstractPlatformTransactionManager的方法
*/
protected final void triggerBeforeCompletion(DefaultTransactionStatus status) {
//如果存在事务同步
if (status.isNewSynchronization()) {
if (status.isDebug()) {
logger.trace("Triggering beforeCompletion synchronization");
}
//在所有当前已注册的TransactionSynchronization上触发beforeCompletion回调
TransactionSynchronizationUtils.triggerBeforeCompletion();
}
}
/**
* TransactionSynchronizationUtils的方法
* 在所有当前已注册的TransactionSynchronization上触发beforeCompletion回调。
*/
public static void triggerBeforeCompletion() {
//遍历synchronizations中绑定到当前线程的TransactionSynchronization集合
for (TransactionSynchronization synchronization : TransactionSynchronizationManager.getSynchronizations()) {
try {
//依次调用beforeCompletion回调方法
synchronization.beforeCompletion();
} catch (Throwable tsex) {
logger.error("TransactionSynchronization.beforeCompletion threw exception", tsex);
}
}
}
// SqlSessionUtils的方法
@Override
public void beforeCompletion() {
if (!this.holder.isOpen()) {
TransactionSynchronizationManager.unbindResource(sessionFactory);
this.holderActive = false;
this.holder.getSqlSession().close();
}
}
nested
事务方法会开启保存点/**
* AbstractTransactionStatus的方法
*
* 回滚到为事务保留的保存点,然后立即释放该保存点。
*
* 我们在invokeWithinTransaction方法中知道,completeTransactionAfterThrowing
* 方法执行完毕仍然会抛出异常到外层事务中,因此仍然可能导致外层事务的回滚
*/
public void rollbackToHeldSavepoint() throws TransactionException {
//获取保存点
Object savepoint = getSavepoint();
if (savepoint == null) {
throw new TransactionUsageException(
"Cannot roll back to savepoint - no savepoint associated with current transaction");
}
//使用保存点管理器来执行回滚保存点的操作,实际上SavepointManager就是当前的内部事务对象
//比如DataSourceTransactionManager的DataSourceTransactionObject
//DataSourceTransactionObject继承了JdbcTransactionObjectSupport
//回滚操作
getSavepointManager().rollbackToSavepoint(savepoint);
//释放保存点
getSavepointManager().releaseSavepoint(savepoint);
//设置保存点为null
setSavepoint(null);
}
/**
* JdbcTransactionObjectSupport的方法
*
* 回滚到给定的JDBC 3.0保存点。
*/
@Override
public void rollbackToSavepoint(Object savepoint) throws TransactionException {
//获取连接持有者
ConnectionHolder conHolder = getConnectionHolderForSavepoint();
try {
//获取连接Connection并调用rollback方法参数为当前的保存点
conHolder.getConnection().rollback((Savepoint) savepoint);
//重置当前连接的rollbackOnly为false
conHolder.resetRollbackOnly();
} catch (Throwable ex) {
//回滚失败抛出异常
throw new TransactionSystemException("Could not roll back to JDBC savepoint", ex);
}
}
/**
* JdbcTransactionObjectSupport的方法
*
* 释放给定的JDBC 3.0保存点。
*/
@Override
public void releaseSavepoint(Object savepoint) throws TransactionException {
//获取连接持有者
ConnectionHolder conHolder = getConnectionHolderForSavepoint();
try {
//获取连接Connection并调用releaseSavepoint方法参数为当前的保存点
conHolder.getConnection().releaseSavepoint((Savepoint) savepoint);
} catch (Throwable ex) {
logger.debug("Could not explicitly release JDBC savepoint", ex);
}
}
Connection#rollback
方法执行回滚操作/**
* DataSourceTransactionManager的方法
*
* @param status 事务状态,代表当前事务
*/
@Override
protected void doRollback(DefaultTransactionStatus status) {
//获取内部事务对象
DataSourceTransactionObject txObject = (DataSourceTransactionObject) status.getTransaction();
//获取内部的连接
Connection con = txObject.getConnectionHolder().getConnection();
if (status.isDebug()) {
logger.debug("Rolling back JDBC transaction on Connection [" + con + "]");
}
try {
//很简单,调用Connection的rollback方法执行回滚
con.rollback();
} catch (SQLException ex) {
throw new TransactionSystemException("Could not roll back JDBC transaction", ex);
}
}
rollbackOnly
属性为true/**
* DataSourceTransactionManager的方法
* 设置给定的事务仅回滚。仅当当前事务参与现有事务时才回滚调用。
*/
@Override
protected void doSetRollbackOnly(DefaultTransactionStatus status) {
DataSourceTransactionObject txObject = (DataSourceTransactionObject) status.getTransaction();
if (status.isDebug()) {
logger.debug("Setting JDBC transaction [" + txObject.getConnectionHolder().getConnection() +
"] rollback-only");
}
//设置为仅回滚,就是设置ResourceHolderSupport的rollbackOnly属性为true,外层事务也将必定回滚
txObject.setRollbackOnly();
}
/**
* 设置ConnectionHolder的rollbackOnly属性为true
*/
public void setRollbackOnly() {
getConnectionHolder().setRollbackOnly();
}
TransactionSynchronization
事务同步对象集合/**
* AbstractPlatformTransactionManager的方法
*
* 触发afterCompletion回调。
*
* @param status 事务状态,代表着当前事务
* @param completionStatus TransactionSynchronization常量表示的事务完成状态
* 如果回滚处理成功则是STATUS_ROLLED_BACK,回滚过程中抛出异常则是STATUS_UNKNOWN
*/
private void triggerAfterCompletion(DefaultTransactionStatus status, int completionStatus) {
//如果是新事务同步
if (status.isNewSynchronization()) {
//获取目前注册的TransactionSynchronization集合
List<TransactionSynchronization> synchronizations = TransactionSynchronizationManager.getSynchronizations();
//清空当前线程绑定的TransactionSynchronization集合
TransactionSynchronizationManager.clearSynchronization();
//如果没有事务或者是新事物
if (!status.hasTransaction() || status.isNewTransaction()) {
if (status.isDebug()) {
logger.trace("Triggering afterCompletion synchronization");
}
//立即调用afterCompletion回调
invokeAfterCompletion(synchronizations, completionStatus);
} else if (!synchronizations.isEmpty()) {
//否则表示有事务但不是新事务
//我们参与的现有事务在此Spring事务管理器的范围之外进行了控制,
//那么尝试向现有(JTA)事务注册一个afterCompletion回调。
registerAfterCompletionWithExistingTransaction(status.getTransaction(), synchronizations);
}
}
}
/**
* AbstractPlatformTransactionManager的方法
*
* @param synchronizations 当前事务同步
* @param completionStatus 事务执行结果
*/
protected final void invokeAfterCompletion(List<TransactionSynchronization> synchronizations, int completionStatus) {
TransactionSynchronizationUtils.invokeAfterCompletion(synchronizations, completionStatus);
}
public static void invokeAfterCompletion(@Nullable List<TransactionSynchronization> synchronizations,
int completionStatus) {
if (synchronizations != null) {
//遍历
for (TransactionSynchronization synchronization : synchronizations) {
try {
//依次调用afterCompletion方法
synchronization.afterCompletion(completionStatus);
} catch (Throwable tsex) {
logger.error("TransactionSynchronization.afterCompletion threw exception", tsex);
}
}
}
}
// AbstractPlatformTransactionManager的方法
private void cleanupAfterCompletion(DefaultTransactionStatus status) {
// 将事务状态修改为已完成
status.setCompleted();
// 是否是新的同步
// 清理掉线程绑定的所有同步信息
// 直接调用时,在任意传播级别下这个条件都是满足的
// 嵌套调用时,只有传播级别为not_supported、requires_new才会满足
if (status.isNewSynchronization()) {
TransactionSynchronizationManager.clear();
}
// 是否是一个新的事务
// 直接调用下,required、requires_new、nested都是新开的一个事务
// 嵌套调用下,只有requires_new会新起一个事务
if (status.isNewTransaction()) {
// 真正执行清理
doCleanupAfterCompletion(status.getTransaction());
}
// 如果存在挂起的资源,将挂起的资源恢复
// 恢复的操作跟挂起的操作正好相反
// 就是将之前从线程解绑的资源(数据库连接等)已经同步回调重新绑定到线程上
if (status.getSuspendedResources() != null) {
if (status.isDebug()) {
logger.debug("Resuming suspended transaction after completion of inner transaction");
}
Object transaction = (status.hasTransaction() ? status.getTransaction() : null);
resume(transaction, (SuspendedResourcesHolder) status.getSuspendedResources());
}
}
// TransactionSynchronizationManager的方法
public static void clear() {
//清除事务同步
synchronizations.remove();
//清除事务名
currentTransactionName.remove();
//清除事务只读状态
currentTransactionReadOnly.remove();
//清除事务隔离级别
currentTransactionIsolationLevel.remove();
//清除事务有效状态
actualTransactionActive.remove();
}
// DataSourceTransactionManager实现的方法
protected void doCleanupAfterCompletion(Object transaction) {
DataSourceTransactionObject txObject = (DataSourceTransactionObject) transaction;
// 先判断是否是一个新连接
// 直接调用,如果真正开启了一个事务必定是个连接
// 但是嵌套调用时,只有requires_new会新起一个连接,其余的都是复用外部事务的连接
// 这种情况下不能将连接从线程上下文中清除,因为外部事务还需要使用
if (txObject.isNewConnectionHolder()) {
TransactionSynchronizationManager.unbindResource(obtainDataSource());
}
// 恢复连接的状态
// 1.重新将连接设置为自动提交
// 2.恢复隔离级别
// 3.将read only重新设置为false
Connection con = txObject.getConnectionHolder().getConnection();
try {
if (txObject.isMustRestoreAutoCommit()) {
con.setAutoCommit(true);
}
DataSourceUtils.resetConnectionAfterTransaction(
con, txObject.getPreviousIsolationLevel(), txObject.isReadOnly());
}
catch (Throwable ex) {
logger.debug("Could not reset JDBC Connection after transaction", ex);
}
// 最后,因为事务已经完成了所以归还连接(关闭连接)
if (txObject.isNewConnectionHolder()) {
DataSourceUtils.releaseConnection(con, this.dataSource);
}
// 清除当前连接持有者的属性,比如transactionActive重置为false,rollbackOnly置为false等等
txObject.getConnectionHolder().clear();
}
“挂起”
事务,实际上就是将绑定到当前线程的连接对象替换为一个新的连接对象,并且被替换的连接对象保存起来“恢复”
的概念就好理解了,由于此前保存了被“挂起”的资源suspendedResources,那么在当前事务或者方法完成之后,我们直接将保存的连接资源再次绑定为当前线程正在使用资源即可,也就是绑定到resources线程本地变量/**
* AbstractPlatformTransactionManager的方法
*
* 恢复给定的事务。首先委托doResume模板方法,然后恢复事务同步。
*
* @param transaction 当前事务对象
* @param resourcesHolder 此前被挂起的资源
*/
protected final void resume(@Nullable Object transaction, @Nullable SuspendedResourcesHolder resourcesHolder)
throws TransactionException {
if (resourcesHolder != null) {
//被挂起的事务资源
Object suspendedResources = resourcesHolder.suspendedResources;
if (suspendedResources != null) {
//首先调用doResume恢复当前事务的资源。事务同步将在此后恢复。
//该方法作为模版方法,由子类来实现
doResume(transaction, suspendedResources);
}
//被挂起的事物同步
List<TransactionSynchronization> suspendedSynchronizations = resourcesHolder.suspendedSynchronizations;
//如果存在此前被挂起的事务同步
if (suspendedSynchronizations != null) {
//那么这里恢复绑定此前的各种事务属性
TransactionSynchronizationManager.setActualTransactionActive(resourcesHolder.wasActive);
TransactionSynchronizationManager.setCurrentTransactionIsolationLevel(resourcesHolder.isolationLevel);
TransactionSynchronizationManager.setCurrentTransactionReadOnly(resourcesHolder.readOnly);
TransactionSynchronizationManager.setCurrentTransactionName(resourcesHolder.name);
///唤醒事务同步
doResumeSynchronization(suspendedSynchronizations);
}
}
}
/**
* DataSourceTransactionManager的方法
*
* @param transaction 当前事务,DataSourceTransactionManager的实现中,该属性没有用到
* @param suspendedResources 被挂起的资源
*/
@Override
protected void doResume(@Nullable Object transaction, Object suspendedResources) {
//重新将此前挂起的事务以当前数据源为key绑定到当前线程的事务,bindResource方法我们此前就见过了
//这就表示"激活"了这个挂起的事务,是不是很简单?
TransactionSynchronizationManager.bindResource(obtainDataSource(), suspendedResources);
}
// AbstractPlatformTransactionManager的方法
private void doResumeSynchronization(List<TransactionSynchronization> suspendedSynchronizations) {
TransactionSynchronizationManager.initSynchronization();
for (TransactionSynchronization synchronization : suspendedSynchronizations) {
// SqlSessionUtils的方法
// 解绑当前线程ThreadLoacl的resources的SqlSession
synchronization.resume();
// 添加事务同步对象
TransactionSynchronizationManager.registerSynchronization(synchronization);
}
}
/**
* TransactionAspectSupport
* 重置TransactionInfo的ThreadLocal
* 无论是方法正常还是异常完成,都会调用该方法
*/
protected void cleanupTransactionInfo(@Nullable TransactionAspectSupport.TransactionInfo txInfo) {
if (txInfo != null) {
//使用堆栈还原旧的事务TransactionInfo。如果未设置,则为null。
txInfo.restoreThreadLocalStatus();
}
}
/**
* TransactionAspectSupport内部类TransactionInfo的方法
*/
private void restoreThreadLocalStatus() {
//使用堆栈还原旧的事务TransactionInfo。
//每一个当前的TransactionInfo都通过oldTransactionInfo属性保留了对前一个TransactionInfo的引用
transactionInfoHolder.set(this.oldTransactionInfo);
}
// TransactionAspectSupport的方法的方法
protected void commitTransactionAfterReturning(@Nullable TransactionAspectSupport.TransactionInfo txInfo) {
if (txInfo != null && txInfo.getTransactionStatus() != null) {
if (logger.isTraceEnabled()) {
logger.trace("Completing transaction for [" + txInfo.getJoinpointIdentification() + "]");
}
//通过事务管理器执行commit提交事务操作
//但是如果TransactionStatus.isRollbackOnly()方法被设置为true,那么仍然会回滚
txInfo.getTransactionManager().commit(txInfo.getTransactionStatus());
}
}
/**
1. AbstractPlatformTransactionManager的骨干实现
2.
3. 尝试提交事务,但仍可能会回滚
4. 内部委托给isRollbackOnly,doCommit和rollback方法
*/
@Override
public final void commit(TransactionStatus status) throws TransactionException {
//如果事务已完成,则抛出异常
if (status.isCompleted()) {
throw new IllegalTransactionStateException(
"Transaction is already completed - do not call commit or rollback more than once per transaction");
}
//获取当前事务状态
DefaultTransactionStatus defStatus = (DefaultTransactionStatus) status;
/*
* 1 如果事务明确被设置为仅回滚,那么执行回滚
*/
if (defStatus.isLocalRollbackOnly()) {
if (defStatus.isDebug()) {
logger.debug("Transactional code has requested rollback");
}
//处理回滚,该方法此前就见过了
processRollback(defStatus, false);
return;
}
/*
* shouldCommitOnGlobalRollbackOnly方法用于判断返回是否以全局方式对已标记为仅回滚的事务调用doCommit提交,
* 默认实现返回false,即不会提交,而是一起回滚,但是JtaTransactionManager重写返回true
* 并且如果当前事务被设置为全局回滚,对于DataSourceTransactionObject来说就是判断内部的ConnectionHolder的rollbackOnly属性
*
* 2 以上条件都返回true,那么表示会执行回滚
*/
if (!shouldCommitOnGlobalRollbackOnly() && defStatus.isGlobalRollbackOnly()) {
if (defStatus.isDebug()) {
logger.debug("Global transaction is marked as rollback-only but transactional code requested commit");
}
/*
* 处理回滚,该方法此前就见过了。注意这里的unexpected参数为true
* 对于加入到外层事务的行为,如果在内层方法中进行了回滚,即使异常被捕获,由于被设置为了仅回滚,那么该事物的所有操作仍然会回滚
* 并且还会在处理最外层事务方法时抛出UnexpectedRollbackException异常,来提醒开发者所有的外部和内部操作都已被回滚!
*
* 这一般对于内层PROPAGATION_SUPPORTS或者内层PROPAGATION_REQUIRED或者内层PROPAGATION_MANDATORY生效,
* 对于内层PROPAGATION_NOT_SUPPORTED则无效。
*/
processRollback(defStatus, true);
return;
}
/*
* 3 最后才会真正的提交
*/
processCommit(defStatus);
}
private void processCommit(DefaultTransactionStatus status) throws TransactionException {
try {
boolean beforeCompletionInvoked = false;
try {
boolean unexpectedRollback = false;
// 留给子类复写的一个方法,没有做实质性的事情
prepareForCommit(status);
// 触发同步回调
triggerBeforeCommit(status);
triggerBeforeCompletion(status);
beforeCompletionInvoked = true;
// 存在保存点,将事务中的保存点清理掉
if (status.hasSavepoint()) {
if (status.isDebug()) {
logger.debug("Releasing transaction savepoint");
}
unexpectedRollback = status.isGlobalRollbackOnly();
status.releaseHeldSavepoint();
}
// 直接调用,传播级别为required、nested、requires_new
// 嵌套调用,且传播级别为requires_new
else if (status.isNewTransaction()) {
if (status.isDebug()) {
logger.debug("Initiating transaction commit");
}
// 虽然前面已经检查过rollbackOnly了,在shouldCommitOnGlobalRollbackOnly为true时
// 仍然需要提交事务,将unexpectedRollback设置为true,意味着提交事务后仍要抛出异常
unexpectedRollback = status.isGlobalRollbackOnly();
// 提交的逻辑很简单,调用了connection的commit方法
doCommit(status);
}
else if (isFailEarlyOnGlobalRollbackOnly()) {
unexpectedRollback = status.isGlobalRollbackOnly();
}
if (unexpectedRollback) {
throw new UnexpectedRollbackException(
"Transaction silently rolled back because it has been marked as rollback-only");
}
}
catch (UnexpectedRollbackException ex) {
// unexpectedRollback为true时,进入这个catch块
// 触发同步回调
triggerAfterCompletion(status, TransactionSynchronization.STATUS_ROLLED_BACK);
throw ex;
}
catch (TransactionException ex) {
// connection的doCommit方法抛出SqlException时进入这里
if (isRollbackOnCommitFailure()) {
// 在doCommit方法失败后是否进行回滚,默认为false
doRollbackOnCommitException(status, ex);
}
else {
// 触发同步回调
triggerAfterCompletion(status, TransactionSynchronization.STATUS_UNKNOWN);
}
throw ex;
}
catch (RuntimeException | Error ex) {
// 剩余其它异常进入这个catch块
if (!beforeCompletionInvoked) {
triggerBeforeCompletion(status);
}
doRollbackOnCommitException(status, ex);
throw ex;
}
// 触发同步回调
try {
triggerAfterCommit(status);
}
finally {
triggerAfterCompletion(status, TransactionSynchronization.STATUS_COMMITTED);
}
}
finally {
// 跟回滚时一样,做一些清理动作
cleanupAfterCompletion(status);
}
}
核心类作用
TransactionDefinition
:通过@Transactional注解指定的事务的属性,包括是否只读、超时、回滚等TransactionStatus
:事务的状态,这个状态分为很多方面,比如事务的运行状态(是否完成、是否被标记为rollbakOnly),事务的同步状态(这个事务是否开启了一个新的同步),还有事务是否设置了保存点。更准确的来说,TransactionStatus代表的是被@Transactional注解修饰的方法的状态,只要被@Transactional注解修饰了,在执行通知逻辑时就会生成一个TransactionStatus对象,即使这个方法没有真正的开启一个数据库事务DataSourceTransactionObject
:一个数据库事务对象,实际上保存的就是一个数据库连接以及这个连接的状态TransactionInfo
:事务相关的所有信息,组合了事务管理器,事务状态,事务定义并持有一个旧的TransactionInfo引用,这个对象在事务管理的流程中其实没有实际的作用,主要的目的是为了让我们在事务的运行过程中获取到事务的相关信息,我们可以直接调用TransactionAspectSupport的currentTransactionInfo方法获取到当前线程绑定的TransactionInfo对象事务的挂起和恢复
事务的传播机制
传播级别 | 运行方式 |
---|---|
requires_new | 新建事务 |
nested | 新建事务 |
required | 新建事务 |
supports | 非事务的方式运行 |
not_supported | 非事务的方式运行 |
never | 非事务的方式运行 |
mandatory | 抛出异常 |
requires_new,nested或者required
)传播级别 | 运行方式 |
---|---|
requires_new | 新建事务 |
nested | “新建”事务 |
required | 直接加入到外部事务 |
supports | 直接加入到外部事务 |
not_supported | 挂起外部事务,以非事务的方式运行 |
never | 抛出异常 |
mandatory | 直接加入到外部事务 |
nested:其实没有新建事务,与外围共用一个事务,只是自己新建了保存点,自己可以回滚提交不影响外围事务,但是外围事务回滚,内层事务也会随之回滚,因为使用的同一个事务