## 問題產生場景

![image-20210919113927707.png](https://developer.hs.net/storage/attachments/2021/09/21/2bq8XSe56mzFjwPwokbFU8cLFxMV3WEm1Ct8xLzM_thumb.png "3152")

專案業務開發中，我們想保證資料提交的原子性，會使用事務提交的方式，比較常用的是使用的 `@Transactional` 的方式。但是，在某些情況下，會發現事務未生效的情況，本文就來詳細研究下 spring 中事務失效的原因。

## **註解@Transactional簡介**

`@Transactional` 是 spring 中宣告式事務管理的註解配置方式，相信這個註解的作用大家都很清楚。`@Transactional` 註解可以幫助我們把事務開啟、提交或者回滾的操作，透過 `aop` 的方式進行管理。

透過 `@Transactional` 註解就能讓 spring 為我們管理事務，免去了重複的事務管理邏輯，減少對業務程式碼的侵入，使我們開發人員能夠專注於業務層面開發。

![image-20210921133022725.png](https://developer.hs.net/storage/attachments/2021/09/21/ABsYW9HVLTrZ3RY7YlMijf5kC6n9lGH9cXcCVSIf_thumb.png "3153")

## 常見 Transactional 失效的場景

#### 註解標註方法修飾符為非 public

Transactional 註解標註方法修飾符為非public時，@Transactional註解將會不起作用。

![image-20210921133530406.png](https://developer.hs.net/storage/attachments/2021/09/21/DKARuDiiu13qEeST6NP72vEKLm8uKcvtDui2pnPN_thumb.png "3154")

例如以下程式碼，

```java
// 定義一個錯誤的@Transactional標註實現，修飾一個預設訪問符的方法
@Component
public class TestServiceImpl {
    @Resource
    TestMapper testMapper;
  
    @Transactional
    void insertTestWrongModifier() {
        int re = testMapper.insert(new Test(10,20,30));
        if (re > 0) {
            throw new NeedToInterceptException("need intercept");
        }
        testMapper.insert(new Test(210,20,30));
    }
}

// 同一個包，新建呼叫物件，進行訪問
@Component
public class InvokcationService {
    @Resource
    private TestServiceImpl testService;
    public void invokeInsertTestWrongModifier(){
        // 呼叫@Transactional標註的預設訪問符方法
        testService.insertTestWrongModifier();
    }
}

// 測試
@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {
   @Resource
   InvokcationService invokcationService;

@Test
   public void  testInvoke(){
      invokcationService.invokeInsertTestWrongModifier();
   }
}
```

以上的訪問方式，導致事務沒開啟，因此在方法丟擲異常時，資料庫的插入操作將不會回滾，如果將方法改為 **public** 則事務將生效並正常回滾。

**注意：`protected`、`private` 修飾的方法上使用 `@Transactional` 註解，雖然事務無效，但不會有任何報錯，這是我們很容犯錯的一點。**

#### 同一類內部呼叫標註的方法

開發中避免不了會對同一個類裡面的方法呼叫，比如有一個類Test，它的一個方法A，A再呼叫本類的方法B（不論方法B是用 public 還是 private 修飾），但方法A沒有宣告註解事務，而B方法有。則外部呼叫方法A之後，方法B的事務是不會起作用的。這也是經常犯錯誤的一個地方。

示例程式碼如下。

```java
// 設定一個內部呼叫
@Component
public class TestServiceImpl implements TestService {
    @Resource
    TestMapper testMapper;

@Transactional
    public void insertTestInnerInvoke() {
        // 正常public修飾符的事務方法
        int re = testMapper.insert(new Test(10,20,30));
        if (re > 0) {
            throw new NeedToInterceptException("need intercept");
        }
        testMapper.insert(new Test(210,20,30));
    }

public void testInnerInvoke(){
        // 類內部呼叫@Transactional標註的方法。
        insertTestInnerInvoke();
    }
}

// 測試
@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {

@Resource
   TestServiceImpl testService;

/**
    * 測試內部呼叫@Transactional標註方法
    */
   @Test
   public void  testInnerInvoke(){
       //測試外部呼叫事務方法是否正常
      //testService.insertTestInnerInvoke();
       //測試內部呼叫事務方法是否正常
      testService.testInnerInvoke();
   }
}
```

上面就是使用的測試程式碼，呼叫一個方法在類內部呼叫內部被@Transactional標註的事務方法，執行結果是事務不會正常開啟，插入操作儲存到資料庫也不會進行回滾。

#### 事務方法內部捕捉異常

事務方法內部捕捉了異常，沒有丟擲新的異常，導致事務操作不會進行回滾。

示例程式碼如下。

```java
@Component
public class TestServiceImpl implements TestService {
    @Resource
    TestMapper testMapper;

@Transactional
    public void insertTestCatchException() {
        try {
            int re = testMapper.insert(new Test(10,20,30));
            if (re > 0) {
                //執行期間拋異常
                throw new NeedToInterceptException("need intercept");
            }
            testMapper.insert(new Test(210,20,30));
        }catch (Exception e){
            System.out.println("i catch exception");
        }
    }
}

// 測試
@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {

@Resource
   TestServiceImpl testService;

@Test
   public void testCatchException(){
      testService.insertTestCatchException();
   }
}
```

執行測試用例發現，雖然丟擲異常，但是異常被捕捉了，沒有丟擲到方法外	異常後面的插入操作並沒有回滾。

在業務方法中一般不需要catch異常，如果非要catch一定要丟擲 `throw new RuntimeException()` ，或者註解中指定拋異常型別 `@Transactional(rollbackFor=Exception.class)`，否則會導致事務失效，資料 `commit` 造成資料不一致，所以有些時候 `try catch` 反倒會畫蛇添足。

## 總結

@Transactional 註解的看似簡單易用，但如果對它的用法一知半解，還是會踩到很多坑的。在實際專案開發中，需要明白其相關用法和原理，才能更好的掌握。

專案中Spring事務失效的場景問題排查

相關文章