谈谈 @Transactional 的原理和坑

r囧r小猫 2024-03-27 18:19 59阅读 0赞

这篇文章，**会先讲述 @Transactional 的 4 种不生效的 Case，然后再通过源码解读，分析 @Transactional 的执行原理，以及部分 Case 不生效的真正原因。**

![图片][67a1dd7a431e3891e973f5de06ecb4e1.png]

## 项目准备 ##

下面是 DB 数据和 DB 操作接口：

<table> 
 <thead> 
  <tr> 
   <th>uid</th> 
   <th>uname</th> 
   <th>usex</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>张三</td> 
   <td>女</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>陈恒</td> 
   <td>男</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>楼仔</td> 
   <td>男</td> 
  </tr> 
 </tbody> 
</table>

// 提供的接口
    public interface UserDao {
        // select * from user_test where uid = "#{uid}"
        public MyUser selectUserById(Integer uid);
        // update user_test set uname =#{uname},usex = #{usex} where uid = #{uid}
        public int updateUser(MyUser user);
    }

基础测试代码，testSuccess() 是事务生效的情况：

@Service
    public class UserController {
        @Autowired
        private UserDao userDao;
    
        public void update(Integer id) {
            MyUser user = new MyUser();
            user.setUid(id);
            user.setUname("张三-testing");
            user.setUsex("女");
            userDao.updateUser(user);
        }
    
        public MyUser query(Integer id) {
            MyUser user = userDao.selectUserById(id);
            return user;
        }
    
        // 正常情况
        @Transactional(rollbackFor = Exception.class)
        public void testSuccess() throws Exception {
            Integer id = 1;
            MyUser user = query(id);
            System.out.println("原记录:" + user);
            update(id);
            throw new Exception("事务生效");
        }
    }

## 事务不生效的几种 Case ##

主要讲解 4 种事务不生效的 Case：

*  **类内部访问**：A 类的 a1 方法没有标注 @Transactional，a2 方法标注 @Transactional，在 a1 里面调用 a2；
 *  **私有方法**：将 @Transactional 注解标注在非 public 方法上；
 *  **异常不匹配**：@Transactional 未设置 rollbackFor 属性，方法返回 Exception 等异常；
 *  **多线程**：主线程和子线程的调用，线程抛出异常。

### Case 1: 类内部访问 ###

我们在类 UserController 中新增一个方法 testInteralCall()：

public void testInteralCall() throws Exception {
        testSuccess();
        throw new Exception("事务不生效：类内部访问");
    }

这里 testInteralCall() 没有标注 @Transactional，我们再看一下测试用例：

public static void main(String[] args) throws Exception {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
        UserController uc = (UserController) applicationContext.getBean("userController");
        try {
            uc.testSuccess();
        } finally {
            MyUser user =  uc.query(1);
            System.out.println("修改后的记录:" + user);
        }
    }
    // 输出：
    // 原记录:MyUser(uid=1, uname=张三, usex=女)
    // 修改后的记录:MyUser(uid=1, uname=张三-testing, usex=女)

从上面的输出可以看到，事务并没有回滚，这个是什么原因呢？

因为 @Transactional 的工作机制是基于 AOP 实现，AOP 是使用动态代理实现的，如果通过代理直接调用 testSuccess()，通过 AOP 会前后进行增强，增强的逻辑其实就是在 testSuccess() 的前后分别加上开启、提交事务的逻辑，后面的源码会进行剖析。

现在是通过 testInteralCall() 去调用 testSuccess()，testSuccess() 前后不会进行任何增强操作，也就是**类内部调用，不会通过代理方式访问。**

> 如果还是不太清楚，推荐再看看这篇文章，里面有完整示例，非常完美诠释“类内部访问”不能前后增强的原因：https://blog.csdn.net/Ahuuua/article/details/123877835

### Case 2: 私有方法 ###

在私有方法上，添加 @Transactional 注解也不会生效：

@Transactional(rollbackFor = Exception.class)
    private void testPirvateMethod() throws Exception {
        Integer id = 1;
        MyUser user = query(id);
        System.out.println("原记录:" + user);
        update(id);
        throw new Exception("测试事务生效");
    }

直接使用时，下面这种场景不太容易出现，因为 IDEA 会有提醒，文案为: Methods annotated with '@Transactional' must be overridable，**至于深层次的原理，源码部分会给你解读。**

### Case 3: 异常不匹配 ###

这里的 @Transactional 没有设置 rollbackFor = Exception.class 属性：

@Transactional
    public void testExceptionNotMatch() throws Exception {
        Integer id = 1;
        MyUser user = query(id);
        System.out.println("原记录:" + user);
        update(id);
        throw new Exception("事务不生效：异常不匹配");
    }

测试方法：同 Case1
    
    // 输出：
    // 原记录:User[uid=1,uname=张三,usex=女]
    // 修改后的记录:User[uid=1,uname=张三-test,usex=女]

@Transactional 注解默认处理运行时异常，即只有抛出运行时异常时，才会触发事务回滚，否则并不会回滚，**至于深层次的原理，源码部分会给你解读。**

### Case 4: 多线程 ###

下面给出两个不同的姿势，一个是子线程抛异常，主线程 ok；一个是子线程 ok，主线程抛异常。

#### 父线程抛出异常 ####

父线程抛出异常，子线程不抛出异常：

public void testSuccess() throws Exception {
        Integer id = 1;
        MyUser user = query(id);
        System.out.println("原记录:" + user);
        update(id);
    }
    @Transactional(rollbackFor = Exception.class)
    public void testMultThread() throws Exception {
        new Thread(new Runnable() {
            @SneakyThrows
            @Override
            public void run() {
                testSuccess();
            }
        }).start();
        throw new Exception("测试事务不生效");
    }

父线程抛出线程，事务回滚，因为子线程是独立存在，和父线程不在同一个事务中，所以子线程的修改并不会被回滚，

#### 子线程抛出异常 ####

父线程不抛出异常，子线程抛出异常：

public void testSuccess() throws Exception {
        Integer id = 1;
        MyUser user = query(id);
        System.out.println("原记录:" + user);
        update(id);
        throw new Exception("测试事务不生效");
    }
    @Transactional(rollbackFor = Exception.class)
    public void testMultThread() throws Exception {
        new Thread(new Runnable() {
            @SneakyThrows
            @Override
            public void run() {
                testSuccess();
            }
        }).start();
    }

由于子线程的异常不会被外部的线程捕获，所以父线程不抛异常，事务回滚没有生效。

## 源码解读 ##

**下面我们从源码的角度，对 @Transactional 的执行机制和事务不生效的原因进行解读。**

### @Transactional 执行机制 ###

我们只看最核心的逻辑，代码中的 interceptorOrInterceptionAdvice 就是 TransactionInterceptor 的实例，入参是 this 对象。

> 红色方框有一段注释，大致翻译为 “它是一个拦截器，所以我们只需调用即可：在构造此对象之前，将静态地计算切入点。”

![图片][e452633db0c758627e96b2668e7a6da1.png]

this 是 ReflectiveMethodInvocation 对象，成员对象包含 UserController 类、testSuccess() 方法、入参和代理对象等。

![图片][49ade9f242446f1acbc3f30b302d31bc.png]

进入 invoke() 方法后：

![图片][9d7b42efdd57306451b44bb6002dbc2f.png]

**前方高能！！！这里就是事务的核心逻辑，包括判断事务是否开启、目标方法执行、事务回滚、事务提交。**

![图片][96e76da2bc38a5dcfb768c355d29b663.png]

### private 导致事务不生效原因 ###

在上面这幅图中，第一个红框区域调用了方法 getTransactionAttribute()，主要是为了获取 txAttr 变量，它是用于读取 @Transactional 的配置，如果这个 txAttr = null，后面就不会走事务逻辑，我们看一下这个变量的含义：

![图片][c22e888c9f61a1d0b380cd1cd17acfb0.png]

我们直接进入 getTransactionAttribute()，重点关注获取事务配置的方法。

![图片][78163691ac7a587fc5d8f2488dd66fb0.png]

**前方高能！！！这里就是 private 导致事务不生效的原因所在**，allowPublicMethodsOnly() 一直返回 false，所以重点只关注 isPublic() 方法。

![图片][64e3720ab28f7d3d802f2e7b388f428e.png]

下面通过位与计算，判断是否为 Public，对应的几类修饰符如下：

*  PUBLIC: 1
 *  PRIVATE: 2
 *  PROTECTED: 4

![图片][8df846b79024cd498911d8b8426c8b93.png]

看到这里，是不是豁然开朗了，有没有觉得很有意思呢~~

### 异常不匹配原因 ###

我们继续回到事务的核心逻辑，因为主方法抛出 Exception() 异常，进入事务回滚的逻辑：

![图片][4d3cf84c2987a393772b2347553ffdc7.png]

进入 rollbackOn() 方法，判断该异常是否能进行回滚，这个需要判断主方法抛出的 Exception() 异常，是否在 @Transactional 的配置中：

![图片][0a873bd375d83e9351ee682fc5f4952f.png]

我们进入 getDepth() 看一下异常规则匹配逻辑，因为我们对 @Transactional 配置了 rollbackFor = Exception.class，所以能匹配成功：

![图片][24c2aa7d4203c03c374b0e74ad841ce1.png]

示例中的 winner 不为 null，所以会跳过下面的环节。但是当 winner = null 时，也就是没有设置 rollbackFor 属性时，会走默认的异常捕获方式。

![图片][9b30bb21fd771302129a67bdc8df8c18.png]

**前方高能！！！这里就是异常不匹配原因的原因所在**，我们看一下默认的异常捕获方式：

![图片][ac553e8448621b314b72b3b08b3f38f5.png]

是不是豁然开朗，**当没有设置 rollbackFor 属性时，默认只对 RuntimeException 和 Error 的异常执行回滚。**

[67a1dd7a431e3891e973f5de06ecb4e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/cf0d40b7212542b88c11d9d50ad60f22.png
[e452633db0c758627e96b2668e7a6da1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/2310b3b04faf425bb44e451c44f4e6bd.png
[49ade9f242446f1acbc3f30b302d31bc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/7a967346169a43b4a66ad831ae0109f0.png
[9d7b42efdd57306451b44bb6002dbc2f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/7810adfd0ac046cbaa8a77fcf813e561.png
[96e76da2bc38a5dcfb768c355d29b663.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/a02a7a8c07194d8a9f5373534cd8d211.png
[c22e888c9f61a1d0b380cd1cd17acfb0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/22d8bfaf4b5d4c70bbd71e309929708e.png
[78163691ac7a587fc5d8f2488dd66fb0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/d3c39c0ea17d4faab0612a6fd5815dce.png
[64e3720ab28f7d3d802f2e7b388f428e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/6b2e661611f64d3cab3952ea1aa5e111.png
[8df846b79024cd498911d8b8426c8b93.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/59090202980e43cf94438cfd1a1fa5a0.png
[4d3cf84c2987a393772b2347553ffdc7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/aa4ba17965704ad291183ee61a678f7f.png
[0a873bd375d83e9351ee682fc5f4952f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/401b8b7d02dc41cab66d011102c553c2.png
[24c2aa7d4203c03c374b0e74ad841ce1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/1def868d28954b518cb9a3333cf67f62.png
[9b30bb21fd771302129a67bdc8df8c18.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/de4db2ea6746477f998fea5a8e99772b.png
[ac553e8448621b314b72b3b08b3f38f5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/586394d87e394e6e9e51b26025c4c0e1.png