@Transactional 四種不生效的 case 分析

skyarthur發表於2022-07-18

背景

在我們工作中,經常會用到 @Transactional 宣告事務,不正確的使用姿勢會導致註解失效,下面就來分析四種最常見的@Transactional事務不生效的 Case:

  • 類內部訪問:A 類的 a1 方法沒有標註 @Transactional,a2 方法標註 @Transactional,在 a1 裡面呼叫 a2;
  • 私有方法:將 @Transactional 註解標註在非 public 方法上;
  • 異常不匹配:@Transactional 未設定 rollbackFor 屬性,方法返回 Exception 等異常;
  • 多執行緒:主執行緒和子執行緒的呼叫,執行緒丟擲異常。

示例程式碼

UserDao 介面,運算元據庫;UserController 實現業務邏輯,宣告事務,呼叫 UserController.testSuccess 方法,事務宣告生效

// 提供的介面
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);
}
@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("事務生效");
    }
}
為了快速說明問題,直接在controller中實現了業務邏輯和事務宣告,不代表生產環境中的程式碼分層

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() 前後不會進行任何增強操作,也就是類內部呼叫,不會通過代理方式訪問。

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,至於深層次的原理,原始碼部分會給你解讀。

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("事務不生效:異常不匹配");
}

@Transactional 註解預設處理執行時異常,即只有丟擲執行時異常時,才會觸發事務回滾,否則並不會回滾,至於深層次的原理,原始碼部分會給你解讀。

4. 多執行緒

父執行緒丟擲異常

父執行緒丟擲異常,子執行緒不丟擲異常:

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 執行機制

我們只看最核心的邏輯,程式碼中的 interceptorOrInterceptionAdvice 就是 TransactionInterceptor 的例項,入參是 this 物件。

紅色方框有一段註釋,大致翻譯為 “它是一個攔截器,所以我們只需呼叫即可:在構造此物件之前,將靜態地計算切入點。”

transactional_1.png

this 是 ReflectiveMethodInvocation 物件,成員物件包含 UserController 類、testSuccess() 方法、入參和代理物件等。

transactional_2.png

進入 invoke() 方法後:

transactional_3.png

前方高能!!!這裡就是事務的核心邏輯,包括判斷事務是否開啟、目標方法執行、事務回滾、事務提交。

transactional_4.png

private 導致事務不生效原因

在上面這幅圖中,第一個紅框區域呼叫了方法 getTransactionAttribute(),主要是為了獲取 txAttr 變數,它是用於讀取 @Transactional 的配置,如果這個 txAttr = null,後面就不會走事務邏輯,我們看一下這個變數的含義:

transactional_5.png

我們直接進入 getTransactionAttribute(),重點關注獲取事務配置的方法。

transactional_6.png

前方高能!!!這裡就是 private 導致事務不生效的原因所在,allowPublicMethodsOnly() 一直返回 false,所以重點只關注 isPublic() 方法。

transactional_7.png

異常不匹配原因

我們繼續回到事務的核心邏輯,因為主方法丟擲 Exception() 異常,進入事務回滾的邏輯:

transactional_8.png

進入 rollbackOn() 方法,判斷該異常是否能進行回滾,這個需要判斷主方法丟擲的 Exception() 異常,是否在 @Transactional 的配置中:

transactional_9.png

我們進入 getDepth() 看一下異常規則匹配邏輯,因為我們對 @Transactional 配置了 rollbackFor = Exception.class,所以能匹配成功:

transactional_10.png

示例中的 winner 不為 null,所以會跳過下面的環節。但是當 winner = null 時,也就是沒有設定 rollbackFor 屬性時,會走預設的異常捕獲方式。

transactional_11.png

前方高能!!!這裡就是異常不匹配原因的原因所在,我們看一下預設的異常捕獲方式:

transactional_12.png

是不是豁然開朗,當沒有設定 rollbackFor 屬性時,預設只對 RuntimeException 和 Error 的異常執行回滾。

相關文章