【老王读Spring Transaction-2】@Transactional是如何被 Spring 解析的？

前言

前面透过 @EnableTransactionManagement 讲解了 @Transactional 实现事注解事务功能的原理。
这一篇主要分析一下 @Transactional 的注解元数据信息是如何被扫描和解析出来的。

@EnableTransactionManagement 的详细知识可以点击: 从EnableTransactionManagement顺藤摸瓜，研究@Transactional的实现原理

Spring 版本

spring-tx 5.3.9 (通过 SpringBoot 2.5.3 间接引入的依赖)

正文

先来看一下 @Transactional 的源码注释，看一下官方的解析

@Transactional 源码注释解读

@Transactional 的作用

@Transactional 是作用在 方法 或者 类 上，用来描述事务属性(TransactionAttribute)的。

当在类上声明 @Transactional 时，它将作为默认值应用于声明类及其子类的所有方法。

注意:
@Transactional 不会作用到类层次结构上的祖先类；继承的方法需要在方法上重新声明 @Transactional。

@Transactional 通常是与当前线程绑定的事务一起工作的，通过当前线程暴露一个事务到所有的数据访问操作。（也就是使用 ThreadLocal 变量来保存事务信息）
事务通常都是通过 PlatformTransactionManager 来进行管理的。

注意: 事务不会传播到事务方法中新启动的线程上。
也就是说，在一个事务方法中，新启动一个线程去调用一个方法的话，这个方法的执行是不带事务执行的。

@Transactional 的回滚策略

默认情况下，事务会在 RuntimeException 和 Error 上回滚，而不会在 checked 的异常上回滚。

如果想让事务在 checked 异常上回滚，那么，需要指定 @Transactional 中的 rollbackFor 或者 rollbackForClassName 属性。

@Transactional 注解元数据的解析

@Transactional 注解元数据的解析是通过 TransactionAttributeSource 来进行检索的。

TransactionAttributeSource 的作用

TransactionAttributeSource 是用于事务注解元数据信息检索的策略接口。
它的实现类可以从不同的配置源（注解配置 或者 xml 配置）中获取事务属性 TransactionAttribute。

public interface TransactionAttributeSource {

    /**
     * 判断给定的类是否是一个具有事务属性的候选类。  
     * 如果返回 false，则不会遍历该类上所有的方法来执行 getTransactionAttribute()；  
     * 如果返回 true，则会遍历该类上所有的方法来执行 getTransactionAttribute()。
     */
    default boolean isCandidateClass(Class<?> targetClass) {
        return true;
    }
    
    /**
     * 返回给定方法上的 TransactionAttribute，如果有的话。（如果方法不带事务，则会返回 null）
     */
    TransactionAttribute getTransactionAttribute(Method method, @Nullable Class<?> targetClass);
}

AnnotationTransactionAttributeSource

AnnotationTransactionAttributeSource 是 TransactionAttributeSource 接口的一个实现类。
它可以获取 @Transactional 注解中的事务元数据信息 TransactionAttribute。

public AnnotationTransactionAttributeSource(boolean publicMethodsOnly) {
    this.publicMethodsOnly = publicMethodsOnly;
    if (jta12Present || ejb3Present) {
        this.annotationParsers = new LinkedHashSet<>(4);
        this.annotationParsers.add(new SpringTransactionAnnotationParser());
        if (jta12Present) {
            this.annotationParsers.add(new JtaTransactionAnnotationParser());
        }
        if (ejb3Present) {
            this.annotationParsers.add(new Ejb3TransactionAnnotationParser());
        }
    } else {
        // 处理 @Transactional 的解析
        this.annotationParsers = Collections.singleton(new SpringTransactionAnnotationParser());
    }
}

从 AnnotationTransactionAttributeSource 的构造方法中可以看到，它除了可以处理 Spring 本身的 @Transactional 之外，还可以处理 javax.transaction.Transactional、javax.ejb.TransactionAttribute 等注解。

Spring 的事务注解: org.springframework.transaction.annotation.Transactional
JTA 1.2 的事务注解: javax.transaction.Transactional
EJB3 的事务注解: javax.ejb.TransactionAttribute

SpringTransactionAnnotationParser: Spring事务注解的解析器

Spring 的 @Transactional 是通过 SpringTransactionAnnotationParser 来进行解析的。

// SpringTransactionAnnotationParser#parseTransactionAnnotation()
protected TransactionAttribute parseTransactionAnnotation(AnnotationAttributes attributes) {
    RuleBasedTransactionAttribute rbta = new RuleBasedTransactionAttribute();

    Propagation propagation = attributes.getEnum("propagation");
    rbta.setPropagationBehavior(propagation.value());
    Isolation isolation = attributes.getEnum("isolation");
    rbta.setIsolationLevel(isolation.value());

    rbta.setTimeout(attributes.getNumber("timeout").intValue());
    String timeoutString = attributes.getString("timeoutString");
    Assert.isTrue(!StringUtils.hasText(timeoutString) || rbta.getTimeout() < 0,
            "Specify 'timeout' or 'timeoutString', not both");
    rbta.setTimeoutString(timeoutString);

    rbta.setReadOnly(attributes.getBoolean("readOnly"));
    rbta.setQualifier(attributes.getString("value"));
    rbta.setLabels(Arrays.asList(attributes.getStringArray("label")));

    List<RollbackRuleAttribute> rollbackRules = new ArrayList<>();
    for (Class<?> rbRule : attributes.getClassArray("rollbackFor")) {
        rollbackRules.add(new RollbackRuleAttribute(rbRule));
    }
    for (String rbRule : attributes.getStringArray("rollbackForClassName")) {
        rollbackRules.add(new RollbackRuleAttribute(rbRule));
    }
    for (Class<?> rbRule : attributes.getClassArray("noRollbackFor")) {
        rollbackRules.add(new NoRollbackRuleAttribute(rbRule));
    }
    for (String rbRule : attributes.getStringArray("noRollbackForClassName")) {
        rollbackRules.add(new NoRollbackRuleAttribute(rbRule));
    }
    rbta.setRollbackRules(rollbackRules);

    return rbta;
}

从上面的源码中可以看到，@Transactional 被解析出来之后，里面声明的属性配置，被解析成了 RuleBasedTransactionAttribute 对象。

TransactionAttribute 是用来存放事务元数据信息的接口。后面的文章中，我们再详细分析 TransactionAttribute 的作用。

小结

@Transactional 是 Spring 默认的事务注解，通过它可以定义一系列的事务相关的配置，例如: 事务隔离级别、事务传播特性、事务超时时间、事务回滚策略等。

@Transactional 是通过 TransactionAttributeSource 来进行检索的，最终注解的解析操作是由 SpringTransactionAnnotationParser 来完成的。
@Transactional 配置的事务属性被解析出来之后，被放在了 RuleBasedTransactionAttribute 中。

---

点赞、收藏、关注不迷路…⇩↓☟⬇︎⥥…

阅读更多文章，请关注公众号: 老王学源码