I love you three thousand

# Spring 中 @Transactional 的使用

事务管理是应用系统开发中必不可少的一部分。Spring 为事务管理提供了丰富的功能支持。

声明式事务有两种方式：

  • 一种是在配置文件（xml）中做相关的事务规则声明，

  • 另一种是基于 @Transactional 注解的方式。

注释配置是目前流行的使用方式。

# Transactional 注解管理事务的实现步骤

使用 @Transactional 注解管理事务的实现步骤分为 2 步：

  1. 在代码配置中添加事务配置信息

    @Configuration
@ComponentScan("com.example.service") // 包扫描
@EnableTransactionManagement // 开启事务支持
@EnableAspectJAutoProxy(proxyTargetClass = true)    // 强制指定使用 cglib 动态代理
public class SpringServiceConfig {

    /**
     * PlantformTransactionManager 的具体是先有 4 种：
     * 
     * - DataSourceTransactionManager for JDBC
     * - HibernateTransactionManager for Hibernate
     * - JpaTransactionManager for JPA
     * - JtaTransactionManager for JTA 
     * 
     * Mybatis 使用的是 JDBC 的那个。
     *
     * 不要无脑复制粘贴。
     */
    @Bean("txManager")
    public DataSourceTransactionManager getTXManager(DataSource ds) {
        DataSourceTransactionManager manager = new DataSourceTransactionManager();
        manager.setDataSource(ds);
        return manager;
    }
}

  2. 将 @Transactional 注解添加到合适的方法上，并设置合适的属性信息。

@Transactional 注解的属性信息

属性名 说明
name 当在配置文件中有多个 TransactionManager ，
可以用该属性指定选择哪个事务管理器。
propagation 事务的传播行为，默认值为 REQUIRED 。各种不同的值的含义见下表。
isolation 事务的隔离度，默认值采用 DEFAULT 。
timeout 事务的超时时间，默认值为 -1 。
如果超过该时间限制但事务还没有完成，则自动回滚事务。
read-only 指定事务是否为只读事务，默认值为 false ；
为了忽略那些不需要事务的方法，比如读取数据，可以设置 read-only 为 true 。
rollback-for 用于指定能够触发事务回滚的异常类型，
如果有多个异常类型需要指定，各类型之间可以通过逗号分隔。
no-rollback-for 抛出 no-rollback-for 指定的异常类型，不回滚事务。

propagation 的各种值的含义：

传播行为 含义 备注
REQUIRED 当方法调用时，如果不存在当前事务，那么就创建事务；如果之前已经存在了事物，那么就沿用之前的事务。 默认值，最常用。
SUPPORTS 当方法调用时，如果不存在当前事务，就不启用事务；如果当前启用事务，那么就沿用当前事务。 ——
MANATORY 方法必须在事务内运行。 如果不存在当前事务，则直接抛出异常。
REQUIRES_NEW 无论是否存在当前事务，方法都会在新的事务中运行 总是开启一个新事务，执行本方法。次常用。
NOT_SUPPORTED 不支持事务，不存在当前事务也不会创建新事务；如果存在当前事务则挂起它，直到方法结束后才恢复当前事务 适用于那些不支持事务的数据库和SQL语句
NEVER 不支持事务。 MANATORY 的“反面”，如果存在当前事务，就直接抛出异常。
NESTED 嵌套事务。REQUIRES_NEW 的高级版 支持当前事务中使用保存点（savepoint），可以回滚到保存点；如果当前事务没有保存点，则完全等价于 REQUIRES_NEW

传播机制本质上描述的是：在一个整体行为中，一个部分行为的失败，会不会对整体行为造成影响，以及造成何种影响。

# 使用位置

除此可以放在方法上，@Transactional 注解也可以添加到类级别上。当把 @Transactional 注解放在类级别时，表示所有该类的公共方法都配置相同的事务属性信息。

方法级别的事务属性信息会覆盖类级别的相关配置信息。

@Transactional 注解的标注于类上：

@Transactional(propagation= Propagation.SUPPORTS, readOnly=true)
@Service(value ="employeeService")
public class EmployeeService

# 注解的事务注意事项（出错未回滚）

当您对 Spring 的基于注解方式的实现步骤和事务内在实现机制有较好的理解之后，就会更好的使用注解方式的事务管理，避免当系统抛出异常，数据不能回滚的问题。

# 正确的设置 @Transactional 的 propagation 属性

本来期望目标方法进行事务管理，但若是错误的配置了 propagation 属性，使用了以下 3 个值之一，那么将会发生『出错未回滚』的 Bug ：

考虑到我们通常情况下不会去改变 propagation 属性的值，，即一般都是使用它的默认值。因此，因为这个原因导致的『出错未回滚』的情况不大。

TransactionDefinition.PROPAGATION_SUPPORTS
如果当前存在事务，则加入该事务；
如果当前没有事务，则以非事务的方式继续运行。
TransactionDefinition.PROPAGATION_NOT_SUPPORTED
以非事务方式运行，如果当前存在事务，则把当前事务挂起。
TransactionDefinition.PROPAGATION_NEVER`
以非事务方式运行，如果当前存在事务，则抛出异常。

# 正确的设置 @Transactional 的 rollbackFor 属性

默认情况下，如果在事务中抛出了未检查异常（继承自 RuntimeException 的异常）或者 Error，则 Spring 将回滚事务；除此之外的异常，Spring 都不会回滚事务！

这是造成『出错未回滚』的最常见原因！

如果在事务中抛出其他类型的异常，并期望 Spring 能够回滚事务，可以指定 rollbackFor 。例：

@Transactional(propagation= Propagation.REQUIRED, rollbackFor= MyException.class)

若在目标方法中抛出的异常是 rollbackFor 指定的异常（及其子类），事务同样会回滚。

# @Transactional 只能应用到 public 方法才有效

只有 @Transactional 注解应用到 public 方法，才能进行事务管理。

Spring AOP 会检查目标方法的修饰符是不是 public ，若不是 public ，就不会获取 @Transactional 的属性配置信息，最终会造成不会用 TransactionInterceptor 来拦截该目标方法进行事务管理。

# 避免 Spring 的 AOP 的自调用问题

在 Spring 的 AOP 代理下，只有目标方法由外部调用，目标方法才由 Spring 生成的代理对象来管理，这会造成自调用问题。

若同一类中的其他没有 @Transactional 注解的方法内部调用有 @Transactional 注解的方法，有 @Transactional 注解的方法的事务被忽略，不会发生回滚。

@Service
public class OrderService {

    private void insert() {
        insertOrder();
    }

    @Transactional
    public void insertOrder() {
        //insert log info
        //insertOrder
        //updateAccount
    }

}

.insertOrder 方法尽管有 @Transactional 注解，但它被内部方法 insert 方法调用，因此 .insertOrder 方法的事务被忽略，出现异常事务不会发生回滚。

『完』

← Spring JDBC →