Spring 事務@Transactional 的使用

Spring 事務@Transactional 的使用

原文鏈接：https://www.ibm.com/developerworks/cn/java/j-master-spring-transactional-use/index.html

參考文章：https://blog.csdn.net/qq_32867467/article/details/82944473

事務管理是應用系統開發中必不可少的一部分。Spring 爲事務管理提供了豐富的功能支持。Spring 事務管理分爲編碼式和聲明式的兩種方式。編程式事務指的是通過編碼方式實現事務；聲明式事務基於 AOP,將具體業務邏輯與事務處理解耦。聲明式事務管理使業務代碼邏輯不受污染, 因此在實際使用中聲明式事務用的比較多。聲明式事務有兩種方式，一種是在配置文件（xml）中做相關的事務規則聲明，另一種是基於@Transactional 註解的方式。

一、@Transactional 註解管理事務的實現步驟

使用@Transactional 註解管理事務的實現步驟分爲兩步。

第一步，在 xml 配置文件中添加如清單 1 的事務配置信息。除了用配置文件的方式，@EnableTransactionManagement 註解也可以啓用事務管理功能。這裏以簡單的 DataSourceTransactionManager 爲例。

<tx:annotation-driven />
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
	<property name="dataSource" ref="dataSource" />
</bean>

第二步，將@Transactional 註解添加到合適的方法上，並設置合適的屬性信息。@Transactional 註解的屬性信息如表 1 展示。

在Spring Boot中，當使用spring-boot-starter-jdbc或spring-boot-starter-data-jpa依賴的時候，框架會自動默認分別注入DataSourceTransactionManager或JpaTransactionManager，所以可以直接使用@Transactional 註解，無需做任何配置

@Transactional 註解的屬性信息

屬性名	說明
name	當在配置文件中有多個 TransactionManager , 可以用該屬性指定選擇哪個事務管理器。
propagation	事務的傳播行爲，默認值爲 REQUIRED。
isolation	事務的隔離度，默認值採用 DEFAULT。
timeout	事務的超時時間，默認值爲-1。如果超過該時間限制但事務還沒有完成，則自動回滾事務。
read-only	指定事務是否爲只讀事務，默認值爲 false；爲了忽略那些不需要事務的方法，比如讀取數據，可以設置 read-only 爲 true。
rollback-for	用於指定能夠觸發事務回滾的異常類型，如果有多個異常類型需要指定，各類型之間可以通過逗號分隔。
no-rollback- for	拋出 no-rollback-for 指定的異常類型，不回滾事務。

除此以外，@Transactional 註解也可以添加到類級別上。當把@Transactional 註解放在類級別時，表示所有該類的公共方法都配置相同的事務屬性信息。當類級別配置了@Transactional，方法級別也配置了@Transactional，應用程序會以方法級別的事務屬性信息來管理事務，換言之，方法級別的事務屬性信息會覆蓋類級別的相關配置信息。

優先級順序爲方法 > 實現類 > 接口

事務屬性

事務屬性包含以下五個方面：隔離級別、傳播行爲、回滾規則、事務超時、只讀。

事務隔離級別

隔離級別是指若干個併發的事務之間的隔離程度。TransactionDefinition 接口中定義了五個表示隔離級別的常量：

隔離級別常量	說明
TransactionDefinition.ISOLATION_DEFAULT	這是默認值，表示使用底層數據庫的默認隔離級別。對大部分數據庫而言，通常這值就是TransactionDefinition.ISOLATION_READ_COMMITTED
TransactionDefinition.ISOLATION_READ_UNCOMMITTED	該隔離級別表示一個事務可以讀取另一個事務修改但還沒有提交的數據。該級別不能防止髒讀，不可重複讀和幻讀，因此很少使用該隔離級別。比如PostgreSQL實際上並沒有此級別。
TransactionDefinition.ISOLATION_READ_COMMITTED	該隔離級別表示一個事務只能讀取另一個事務已經提交的數據。該級別可以防止髒讀，這也是大多數情況下的推薦值。
TransactionDefinition.ISOLATION_REPEATABLE_READ	該隔離級別表示一個事務在整個過程中可以多次重複執行某個查詢，並且每次返回的記錄都相同。該級別可以防止髒讀和不可重複讀。
TransactionDefinition.ISOLATION_SERIALIZABLE	所有的事務依次逐個執行，這樣事務之間就完全不可能產生干擾，也就是說，該級別可以防止髒讀、不可重複讀以及幻讀。但是這將嚴重影響程序的性能。通常情況下也不會用到該級別。

事務傳播行爲

所謂事務的傳播行爲是指，如果在開始當前事務之前，一個事務上下文已經存在，此時有若干選項可以指定一個事務性方法的執行行爲。在TransactionDefinition定義中包括瞭如下幾個表示傳播行爲的常量：

傳播行爲常量	說明
TransactionDefinition.PROPAGATION_REQUIRED	如果當前存在事務，則加入該事務；如果當前沒有事務，則創建一個新的事務。這是默認值。
TransactionDefinition.PROPAGATION_REQUIRES_NEW	創建一個新的事務，如果當前存在事務，則把當前事務掛起。
TransactionDefinition.PROPAGATION_SUPPORTS	如果當前存在事務，則加入該事務；如果當前沒有事務，則以非事務的方式繼續運行。
TransactionDefinition.PROPAGATION_NOT_SUPPORTED	以非事務方式運行，如果當前存在事務，則把當前事務掛起。
TransactionDefinition.PROPAGATION_NEVER	以非事務方式運行，如果當前存在事務，則拋出異常。
TransactionDefinition.PROPAGATION_MANDATORY	如果當前存在事務，則加入該事務；如果當前沒有事務，則拋出異常。
TransactionDefinition.PROPAGATION_NESTED	如果當前存在事務，則創建一個事務作爲當前事務的嵌套事務來運行；如果當前沒有事務，則該取值等價於TransactionDefinition.PROPAGATION_REQUIRED。

事務超時

所謂事務超時，就是指一個事務所允許執行的最長時間，如果超過該時間限制但事務還沒有完成，則自動回滾事務。在 TransactionDefinition 中以 int 的值來表示超時時間，其單位是秒。
默認設置爲底層事務系統的超時值，如果底層數據庫事務系統沒有設置超時值，那麼就是none，沒有超時限制。

事務只讀屬性

只讀事務用於客戶代碼只讀但不修改數據的情形，只讀事務用於特定情景下的優化，比如使用Hibernate的時候。
默認爲讀寫事務。

實例

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    UserMapper userMapper;

    @Transactional
    public int testTxAdd() {
        int i = 0;
        i = userMapper.add(new User("tx_test1", "2020-06-01 09:40:10"));
        i = userMapper.add(new User("tx_test2", "2020-06-01 09:40:10"));
        i = userMapper.add(new User("tx_test3", "abc"));
        i = userMapper.add(new User("tx_test4", "2020-06-01 09:40:10"));
        i = userMapper.add(new User("tx_test4", "2020-06-01 09:40:10"));
        return i;
    }

}

i = userMapper.add(new User(“tx_test3”, “abc”));這一行代碼會發生錯誤，第二個參數無法轉換成時間，所以加入事務控制之後，所有的添加用戶的操作都會回滾。

二、Spring 的註解方式的事務實現機制

在應用系統調用聲明@Transactional 的目標方法時，Spring Framework 默認使用 AOP 代理，在代碼運行時生成一個代理對象，根據@Transactional 的屬性配置信息，這個代理對象決定該聲明@Transactional 的目標方法是否由攔截器 TransactionInterceptor 來使用攔截，在 TransactionInterceptor 攔截時，會在在目標方法開始執行之前創建並加入事務，並執行目標方法的邏輯, 最後根據執行情況是否出現異常，利用抽象事務管理器(圖 2 有相關介紹)AbstractPlatformTransactionManager 操作數據源 DataSource 提交或回滾事務, 如圖 1 所示。

圖 1. Spring 事務實現機制

Spring AOP 代理有 CglibAopProxy 和 JdkDynamicAopProxy 兩種，圖 1 是以 CglibAopProxy 爲例，對於 CglibAopProxy，需要調用其內部類的 DynamicAdvisedInterceptor 的 intercept 方法。對於 JdkDynamicAopProxy，需要調用其 invoke 方法。

正如上文提到的，事務管理的框架是由抽象事務管理器 AbstractPlatformTransactionManager 來提供的，而具體的底層事務處理實現，由 PlatformTransactionManager 的具體實現類來實現，如事務管理器 DataSourceTransactionManager。不同的事務管理器管理不同的數據資源 DataSource，比如 DataSourceTransactionManager 管理 JDBC 的 Connection。

PlatformTransactionManager，AbstractPlatformTransactionManager 及具體實現類關係如圖 2 所示。

圖 2. TransactionManager 類結構

三、註解方式的事務使用注意事項

對 Spring 的基於註解方式的實現步驟和事務內在實現機制有較好的理解之後，就會更好的使用註解方式的事務管理，避免當系統拋出異常，數據不能回滾的問題。

正確的設置@Transactional 的 propagation 屬性

需要注意下面三種 propagation 可以不啓動事務。本來期望目標方法進行事務管理，但若是錯誤的配置這三種 propagation，事務將不會發生回滾。

1. TransactionDefinition.PROPAGATION_SUPPORTS：如果當前存在事務，則加入該事務；如果當前沒有事務，則以非事務的方式繼續運行。
2. TransactionDefinition.PROPAGATION_NOT_SUPPORTED：以非事務方式運行，如果當前存在事務，則把當前事務掛起。
3. TransactionDefinition.PROPAGATION_NEVER：以非事務方式運行，如果當前存在事務，則拋出異常。

正確的設置@Transactional 的 rollbackFor 屬性

默認情況下，如果在事務中拋出了未檢查異常（繼承自 RuntimeException 的異常）或者 Error，則 Spring 將回滾事務；除此之外，Spring 不會回滾事務。

如果在事務中拋出其他類型的異常，並期望 Spring 能夠回滾事務，可以指定 rollbackFor。例：

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

通過分析 Spring 源碼可以知道，若在目標方法中拋出的異常是 rollbackFor 指定的異常的子類，事務同樣會回滾。

RollbackRuleAttribute 的 getDepth 方法

private int getDepth(Class<?> exceptionClass, int depth) {
    if (exceptionClass.getName().contains(this.exceptionName)) {
        // Found it!
        return depth;
    }
    // If we've gone as far as we can go and haven't found it...
    if (exceptionClass == Throwable.class) {
        return -1;
    }
    return getDepth(exceptionClass.getSuperclass(), depth + 1);
}

@Transactional 只能應用到 public 方法纔有效

只有@Transactional 註解應用到 public 方法，才能進行事務管理。這是因爲在使用 Spring AOP 代理時，Spring 在調用在圖 1 中的 TransactionInterceptor 在目標方法執行前後進行攔截之前，DynamicAdvisedInterceptor（CglibAopProxy 的內部類）的的 intercept 方法或 JdkDynamicAopProxy 的 invoke 方法會間接調用 AbstractFallbackTransactionAttributeSource（Spring 通過這個類獲取表 1. @Transactional 註解的事務屬性配置屬性信息）的 computeTransactionAttribute 方法。

AbstractFallbackTransactionAttributeSource

protected TransactionAttribute computeTransactionAttribute(Method method, Class<?> targetClass) {
    // Don't allow no-public methods as required.
    if (allowPublicMethodsOnly() && !Modifier.isPublic(method.getModifiers())) {
		return null;
    }
}

這個方法會檢查目標方法的修飾符是不是 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 調用，事務被忽略，出現異常事務不會發生回滾。

上面的兩個問題@Transactional 註解只應用到 public 方法和自調用問題，是由於使用 Spring AOP 代理造成的。爲解決這兩個問題，使用 AspectJ 取代 Spring AOP 代理。