Spring框架 註解配置事務控制的流程

Posted on by

寫在前面：雖然使用註解方式配置事務控制很簡單，用起來也很爽，但是在每個方法前都加上@xxx形式的註解，顯然並不美觀，也不利於代碼的規范與維護，所以XML的配置方式是才是重點。

基於註解的事務控制

基於註解配置事務控制，相較XML配置來說更加簡單，但仍需要XML提供依賴，不能完全擺脫XML。前期準備工作和XML配置大同小異，這裡不做贅述，建議學習基於註解配置前先學習XML配置事務控制。

這裡給出本次測試的全部XML配置，具體細節在後面依次介紹。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xmlns:aop="http://www.springframework.org/schema/aop"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans 
		http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context
		http://www.springframework.org/schema/context/spring-context.xsd
		http://www.springframework.org/schema/aop
		http://www.springframework.org/schema/aop/spring-aop.xsd 
		http://www.springframework.org/schema/tx
		http://www.springframework.org/schema/tx/spring-tx.xsd ">
	<!-- 配置c3p0數據源 -->
	<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
		<property name="driverClass" value="com.mysql.jdbc.Driver" />
		<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/mybase2" />
		<property name="user" value="root" />
		<property name="password" value="Hudie" />
	</bean>
	
	<!-- 配置JdbcTemplate模板對象 -->
	<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
		<property name="dataSource" ref="dataSource"></property>
	</bean>
	<!-- 配置service層 -->
	<bean id="userService" class="com.gql.service.UserServiceImp">
		<property name="userDao" ref="userDao"></property>
	</bean>
	
	<!-- 配置dao層 -->
	<bean id="userDao" class="com.gql.dao.UserDaoImp">
		<property name="jdbcTemplate" ref="jdbcTemplate"></property>
	</bean>
	
	<!-- 事務管理器 -->
	<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
		<!-- 註入 DataSource-->
		<property name="dataSource" ref="dataSource"></property>
	</bean>
	<!-- 註解掃描器 -->
	<context:component-scan base-package="com.gql.service"></context:component-scan>
	<!-- 註解的事務配置 -->
	<tx:annotation-driven transaction-manager="transactionManager"/>
</beans>

1.配置事務管理器

 <!-- 事務管理器 -->
 <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <!-- 註入 DataSource-->
  <property name="dataSource" ref="dataSource"></property>
 </bean>

2.在業務層使用@Transactional 註解

隻需要在業務層實現類上加上@Transactional即可。

該註解的屬性和 xml 中的屬性含義一致。該註解可以出現在接口上，類上和方法上。

  • 出現接口上，表示該接口的所有實現類都有事務支持。
  • 出現在類上，表示類中所有方法有事務支持
  • 出現在方法上，表示方法有事務支持。
  • 以上三個位置的優先級：方法>類>接口
package com.gql.service;
import java.util.List;
import org.springframework.transaction.annotation.Transactional;
import com.gql.dao.UserDao;
import com.gql.entity.User;
/**
 * 類說明:
 *		業務層實現類
 * @guoqianliang1998.
 */
@Transactional
public class UserServiceImp implements UserService {
	private UserDao userDao;
	
	public void setUserDao(UserDao userDao) {
		this.userDao = userDao;
	}
	@Override
	public void save(User user) {
		userDao.save(user);
		int i = 1/0;
	}
	@Override
	public void update(int id, User user) {
		userDao.update(id, user);
	}
	@Override
	public void delete(int id) {
		userDao.delete(id);
	}
	@Override
	public User getUser(int id) {
		User user = userDao.getUser(id);
		return user;
	}
	@Override
	public List<User> getUserList(int[] ids) {
		List<User> userList = userDao.getUserList(ids);
		return userList;
	}
	@Override
	public List<User> getUserList() {
		List<User> list = userDao.getUserList();
		return list;
	}
}

3.開啟 spring 對註解事務的支持

<!-- 開啟 spring 對註解事務的支持 -->
 <tx:annotation-driven transaction-manager="transactionManager"/>

4.註解掃描器

<!-- 註解掃描器 -->
 <context:component-scan base-package="com.gql.service"></context:component-scan>

Spring 註解事務實現機制

1.事務的實現機制

AOP動態代理進行方法攔截

在應用系統調用聲明@Transactional 的目標方法時，Spring Framework 默認使用 AOP 代理，在代碼運行時生成一個代理對象，根據@Transactional 的屬性配置信息，這個代理對象決定該聲明@Transactional 的目標方法是否由攔截器 TransactionInterceptor 來使用攔截。

在 TransactionInterceptor 攔截時，會在在目標方法開始執行之前創建並加入事務，並執行目標方法的邏輯, 最後根據執行情況是否出現異常，利用抽象事務管理器AbstractPlatformTransactionManager 操作數據源 DataSource 提交或回滾事務, 如下圖所示。

註：上面兩個xxxServiceImpl，表示的是同一個service的調用，前面用虛線，表示欲調用該service的方法，進入該service的方法前經歷瞭aop進行攔截，然後才真正進入該service方法（後面的實線表示的service）

Spring AOP 代理有 CglibAopProxy 和 JdkDynamicAopProxy 兩種，上圖是以 CglibAopProxy 為例

  • 對於 CglibAopProxy，需要調用其內部類的 DynamicAdvisedInterceptor 的 intercept 方法。
  • 對於 JdkDynamicAopProxy，需要調用其 invoke 方法。

事務管理器進行事務提交或回滾

事務管理的框架是由抽象事務管理器 AbstractPlatformTransactionManager 來提供的，而具體的底層事務處理實現，由 PlatformTransactionManager 的具體實現類來實現，如事務管理器 DataSourceTransactionManager。

不同的事務管理器管理不同的數據資源 DataSource，比如 DataSourceTransactionManager 管理 JDBC 的 Connection。

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

2.註解方式的事務使用註意事項

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

正確的設置 @Transactional 的 propagation 屬性（熟知事務的傳播特性）

需要註意下面三種 propagation 可以不啟動事務。本來期望目標方法進行事務管理，但若是錯誤的配置這三種 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)

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

清單 3. 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 在調用TransactionInterceptor 在目標方法執行前後進行攔截之前，DynamicAdvisedInterceptor（CglibAopProxy 的內部類）的intercept 方法或 JdkDynamicAopProxy 的 invoke 方法會間接調用 AbstractFallbackTransactionAttributeSource（Spring 通過這個類獲取@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;}

allowPublicMethodsOnly方法由子類AnnotationTransactionAttributeSource實現，該子類方法中默認是true，所以當你加瞭事務註解的方法不是public時，該方法直接返回null

不會獲取@Transactional 的屬性配置信息，最終會造成不會用 TransactionInterceptor 來攔截該目標方法進行事務管理。

避免 Spring 的 AOP 的自調用問題，必須要跨service調用

在 Spring 的 AOP 代理下，隻有目標方法由外部調用（也就是跨service調用），目標方法才由 Spring 生成的代理對象來管理，這會造成自調用問題。

若同一類中的其他沒有@Transactional 註解的方法內部調用有@Transactional 註解的方法，有@Transactional 註解的方法的事務被忽略，不會發生回滾。

示例：

-->
@Service
public class OrderService {
 
    private void insert() {
        insertOrder();
    }
    
    @Transactional
    public void insertOrder() {
        //insert log info
        //insertOrder
        //updateAccount
    }
}

insertOrder 盡管有@Transactional 註解，但它被內部方法 insert 調用，事務被忽略，出現異常事務不會發生回滾。

事務的傳播問題PROPAGATION_REQUIRES_NEW隻有在跨service時才會有效（也是上面自調用引起的） 

class ServiceA{
  @Transactional(rollbackFor = Exception.class)
  public methodA1(){
     ......
     //該方式，methodA2上的事務註解不起作用，不會開啟新的事務，methodA2與methodA1中的數據一起提交或回滾
     1.this.methodA2();
     //該方式，methodB1上的事務會啟作用
     2.ServiceB.methodB1()
     ......
  };
  @Transactional(propagation = Propagation.REQUIRES_NEW, rollbackFor = Exception.class)
  public methodA2(){
     ......
  };
}
 
class ServiceB{
  @Transactional(propagation = Propagation.REQUIRES_NEW, rollbackFor = Exception.class)
  public methodB1(){
     ......
  };  
}

原因在於，跨Service調用方法時，都會經過org.springframework.aop.framework.CglibAopProxy.DynamicAdvisedInterceptor.intercept()方法，隻有經過此處，才能對事務進行控制。

參考：https://developer.ibm.com/zh/articles/j-master-spring-transactional-use/

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：