@Transactional 實現原理

目錄

1、簡介

2、自定義註解

2.1 定義

2.2 測試

2.3 總結

3、手寫事務註解

3.1 maven依賴

3.2 配置spring.xml文件

3.3 自定義事務註解 (通過反射解析方法上的註解，如果有這個註解就執行事務邏輯)

3.4 封裝編程式事務

3.5 通過AOP封裝事務工具類, 基於環繞通知和異常通知來觸發事務

3.6 dao 層

3.7 service 層

3.8 測試

---

1、簡介

Transactional是spring中定義的事務註解，在方法或類上加該註解開啓事務。主要是通過反射獲取bean的註解信息，利用AOP對編程式事務進行封裝實現。(spring-5.1.8.RELEASE)

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Transactional {

    @AliasFor("transactionManager")
    String value() default "";

    @AliasFor("value")
    String transactionManager() default "";

    Propagation propagation() default Propagation.REQUIRED;

    Isolation isolation() default Isolation.DEFAULT;

    int timeout() default TransactionDefinition.TIMEOUT_DEFAULT;

    boolean readOnly() default false;

    Class<? extends Throwable>[] rollbackFor() default {};

    String[] rollbackForClassName() default {};

    Class<? extends Throwable>[] noRollbackFor() default {};

    String[] noRollbackForClassName() default {};
}

2、自定義註解

2.1 定義

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation {
    //自定義註解的屬性
    int id() default 0;
    String name() default "默認名稱";
    String[]arrays();
    String title() default "默認標題";
}

2.2 測試

public class App {

    @MyAnnotation(name = "Yongqian Wang", arrays = {"2", "3"})
    public void aMethod() {}

    public void bMethod() {}

    public static void main(String[] args) throws ClassNotFoundException {
        // 反射獲取到類的信息
        Class<?> clazz = Class.forName("com.wyq.App");

        // 獲取當前類（不包括繼承）所有方法
        Method[] methods = clazz.getDeclaredMethods();

        // 遍歷每個方法的信息
        for (Method method : methods) {
            System.out.println("方法名稱：" + method.getName());

            // 獲取方法上面的註解
            MyAnnotation annotation = method.getDeclaredAnnotation(MyAnnotation.class);

            if (annotation == null) {
                System.out.println("該方法上沒有加註解...");
            } else {
                System.out.println("Id : " + annotation.id());
                System.out.println("Name : " + annotation.name());
                System.out.println("Title : " + annotation.title());
                System.out.println("Arrays : " + annotation.arrays());
            }

            System.out.println("--------------------------");
        }

    }
}


控制檯信息：

方法名稱：main
該方法上沒有加註解...
--------------------------
方法名稱：aMethod
Id : 0
Name : Yongqian Wang
Title : 默認標題
Arrays : [Ljava.lang.String;@24d46ca6
--------------------------
方法名稱：bMethod
該方法上沒有加註解...
--------------------------

2.3 總結

通過上面這麼一個小demo我們就能發現，反射獲取到每一個方法的註解信息然後進行判斷，如果這是@Transactional註解，spring就會開啓事務。接下來我們可以按照這種思路自己實現一個事務註解。

3、手寫事務註解

3.1 maven依賴

    <dependencies>
        <!-- 引入Spring-AOP等相關Jar -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-orm</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>1.9.4</version>
        </dependency>
        <dependency>
            <groupId>aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.5.4</version>
        </dependency>
        <dependency>
            <groupId>cglib</groupId>
            <artifactId>cglib</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>com.mchange</groupId>
            <artifactId>c3p0</artifactId>
            <version>0.9.5.2</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.37</version>
        </dependency>
    </dependencies>

3.2 配置spring.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd">

    <!--掃描指定路徑-->
    <context:component-scan base-package="com.wyq" />
    <!--開啓切面代理-->
    <aop:aspectj-autoproxy />
    <!--數據源對象，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/test"/>
        <property name="user" value="root"/>
        <property name="password" value="123456"/>
    </bean>

    <!--JdbcTemplate 工具類實例-->
    <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
        <property name="dataSource" ref="dataSource"/>
    </bean>
    <!--配置事務-->
    <bean id="dataSoutceTransactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"></property>
    </bean>
</beans>

3.3 自定義事務註解 (通過反射解析方法上的註解，如果有這個註解就執行事務邏輯)

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation {
    //自定義註解的屬性
    int id() default 0;

    String name() default "默認名稱";

    String[] arrays() default {};

    String title() default "默認標題";
}

3.4 封裝編程式事務

@Component
@Scope("prototype")
public class TransactionUtil {
    // 全局接受事務狀態
    private TransactionStatus transactionStatus;

    // 獲取事務原
    @Autowired
    private DataSourceTransactionManager dataSourceTransactionManager;

    // 開啓事務
    public TransactionStatus begin() {
        System.out.println("開啓事務");
        transactionStatus = dataSourceTransactionManager.getTransaction(new DefaultTransactionAttribute());
        return transactionStatus;
    }

    // 提交事務
    public void commit(TransactionStatus transaction) {
        System.out.println("提交事務");
        if (dataSourceTransactionManager != null) {
            dataSourceTransactionManager.commit(transaction);
        }
    }

    public void rollback(TransactionStatus transaction) {
        System.out.println("回滾事務");
        if (dataSourceTransactionManager != null) {
            dataSourceTransactionManager.rollback(transaction);
        }
    }
}

3.5 通過AOP封裝事務工具類, 基於環繞通知和異常通知來觸發事務

@Component
@Aspect
public class AopTransaction {
    @Autowired
    private TransactionUtil transactionUtil;

    private TransactionStatus transactionStatus;

    /**
     * 環繞通知，在方法 前---後 處理事情
     *
     * @param pjp 切入點
     */
    @Around("execution(* com.wyq.service.*.*(..))")
    public void around(ProceedingJoinPoint pjp) throws Throwable {
        // 獲取方法的註解
        MyAnnotation annotation = this.getMethodMyAnnotation(pjp);
        // 判斷是否需要開啓事務
        transactionStatus = begin(annotation);
        // 調用目標代理對象方法
        pjp.proceed();
        // 判斷關閉事務
        commit(transactionStatus);
    }

    /**
     * 獲取代理方法上的事務註解
     *
     * @param pjp
     * @return
     * @throws Exception
     */
    private MyAnnotation getMethodMyAnnotation(ProceedingJoinPoint pjp) throws Exception {
        // 獲取代理對象的方法
        String methodName = pjp.getSignature().getName();
        // 獲取目標對象
        Class<?> classTarget = pjp.getTarget().getClass();
        // 獲取目標對象類型
        Class<?>[] par = ((MethodSignature) pjp.getSignature()).getParameterTypes();
        // 獲取目標對象方法
        Method objMethod = classTarget.getMethod(methodName, par);
        // 獲取該方法上的事務註解
        MyAnnotation annotation = objMethod.getDeclaredAnnotation(MyAnnotation.class);
        return annotation;
    }

    /**
     * 開啓事務
     *
     * @param annotation
     * @return
     */
    private TransactionStatus begin(MyAnnotation annotation) {
        if (annotation == null) {
            return null;
        }
        return transactionUtil.begin();
    }

    /**
     * 提交事務
     *
     * @param transactionStatus
     */
    private void commit(TransactionStatus transactionStatus) {
        if (transactionStatus != null) {
            transactionUtil.commit(transactionStatus);
        }
    }

    /**
     * 異常通知進行 回滾事務
     */
    @AfterThrowing("execution(* com.wyq.service.*.*(..))")
    public void afterThrowing() {
        // 獲取當前事務 直接回滾
        if (transactionStatus != null) {
            transactionUtil.rollback(transactionStatus);
        }
    }
}

3.6 dao 層

/*
CREATE TABLE `t_user0` (
  `name` varchar(20) NOT NULL,
  `age` int(5) DEFAULT NULL,
  PRIMARY KEY (`name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
*/
@Repository
public class UserDao {
    @Autowired
    private JdbcTemplate jdbcTemplate;

    public int add(String name, Integer age) {
        String sql = "INSERT INTO t_user0(NAME, age) VALUES(?,?);";
        int result = jdbcTemplate.update(sql, name, age);
        System.out.println("插入成功");
        return result;
    }
}

3.7 service 層

@Service
public class UserService {

    @Autowired
    private UserDao userDao;

    // 加上事務註解
    @MyAnnotation
    public void add() {
        userDao.add("test001", 20);
        int i = 1 / 0;  //設置異常，檢查事務的正確性
        userDao.add("test002", 21);
//        // 如果非要try,那麼出現異常不會被aop的異常通知監測到,必須手動在catch裏面回滾事務。
//        try {
//            userDao.add("test001", 20);
//            int i = 1 / 0;
//            userDao.add("test002", 21);
//        } catch (Exception e) {
//            // 回滾當前事務
//            System.out.println("回滾");
//            TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
//        }
    }

    public void del() {
        System.out.println("del...");
    }
}

3.8 測試

public class Test {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("spring.xml");
        UserService userService = (UserService) applicationContext.getBean("userService");
        // aop()對userService類進行了攔截,添加自定義事務註解的方法會觸發事務邏輯
        userService.add();
        // del()方法沒有加註解，則什麼也不會觸發。
        //userService.del();
    }
}

4、參考

https://www.cnblogs.com/wlwl/p/10092494.html

https://www.cnblogs.com/wlwl/p/10032206.html