通過實際案例摸清楚Spring事務傳播的行為

@

目錄

• 事務傳播
• 案例準備
• 案例解析
  • 1、無事務
  • 2、 Propagation.REQUIRED
  • 3. Propagation.SUPPORTS
  • 4. Propagation.MANDATORY
  • 5. Propagation.REQUIRED_NEW
  • 6. Propagation.NOT_SUPPORTED
  • 7. Propagation.NEVER
  • 8. Propagation.NESTED
• 注意點

事務傳播

• 對於Spring事務傳播的七大行為，我們往往還停留在一些概念上，比如下面這張表：

定義	說明
PROPAGATION_REQUIRED	如果當前沒有事務，就新建一個事務，如果已經存在一個事務，則加入到這個事務中。這是最常見的選擇。
PROPAGATION_SUPPORTS	支援當前事務，如果當前沒有事務，就以非事務方式執行。
PROPAGATION_MANDATORY	表示該方法必須在事務中執行，如果當前事務不存在，則會丟擲一個異常。
PROPAGATION_REQUIRED_NEW	表示當前方法必須執行在它自己的事務中。一個新的事務將被啟動。如果存在當前事務，在該方法執行期間，當前事務會被掛起。
PROPAGATION_NOT_SUPPORTED	表示該方法不應該執行在事務中。如果當前存在事務，就把當前事務掛起。
PROPAGATION_NEVER	表示當前方法不應該執行在事務上下文中。如果當前正有一個事務在執行，則會丟擲異常。
PROPAGATION_NESTED	如果當前存在事務，則在巢狀事務內執行。如果當前沒有事務，則執行與PROPAGATION_REQUIRED類似的操作。

• 本文旨在通過實際案例程式碼進行分析Spring事務傳播行為的各種特性。

案例準備

• 構建一個SpringBoot專案，增加以下程式碼：

1. 實體類

/**
*  User.java ： 使用者類
*/
@Entity
public class User implements Serializable {
    // 使用者id
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    // 使用者名稱
    @NotBlank(message = "使用者名稱稱不能為空")
    @Column(name="name")
    private String name;
    // 郵箱
    @Column(name="email")
    @Pattern(message ="郵箱格式不符", regexp = "^[A-Za-z0-9\\u4e00-\\u9fa5]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$")
    private String email;
    
    public User(){}

    public User(Long id, String name, String email) {
        this.id = id;
        this.name = name;
        this.email = email;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", email='" + email + '\'' +
                ", createTime=" + createTime +
                ", updateTime=" + updateTime +
                '}';
    }
}

2. DAO介面與實現類

/**
 * 使用者資料訪問層(DAO)介面
 */
public interface UserDAO {
    // 查詢所有使用者
    List<User> findAll();

    // 根據id查詢使用者
    User findById(Long id) throws SQLException;

    // 新增使用者
    Long addUser(User user) throws SQLException;

    // 更新使用者
    void updateUser(User user);

    // 刪除使用者
    void deleteById(Long id);

    // 自定義新增通過使用者名稱稱查詢使用者資訊
    List<User> findByName(String name);
}

/**
 * 使用JdbcTemplate模板類實現使用者資料訪問層
 *
 */
@Repository
public class UserDAOImpl implements UserDAO {
    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Override
    public List<User> findAll() {
        return jdbcTemplate.query("select id,name,email from user;",
                new Object[]{}, new BeanPropertyRowMapper<>(User.class));
    }

    @Override
    public User findById(Long id) {
        return jdbcTemplate.queryForObject("select id,name,email from user where id=?;",
                new Object[]{id}, new BeanPropertyRowMapper<>(User.class));
    }

    @Override
    public Long addUser(User user) {
        return Integer.toUnsignedLong(
                jdbcTemplate.update("insert into  user(id,name,email) values(?,?,?);"
                        , user.getId(), user.getName(), user.getEmail()));
    }

    @Override
    public void updateUser(User user) {
        jdbcTemplate.update("update user set name=?,email=? where id =?;"
                , user.getName(), user.getEmail(), user.getId());
    }

    @Override
    public void deleteById(Long id) {
        jdbcTemplate.update("delete from user where id=?", new Object[]{id});
    }

    @Override
    public List<User> findByName(String name) {
        return jdbcTemplate.query("select id,name,email from user where name=?;",
                new Object[]{name}, new BeanPropertyRowMapper<>(User.class));
    }
}

3. 測試類

/**
 * 事務傳播測試案例
 */
public class TransactionalTest {

    @Autowired
    private UserDAO userDAO;

    // 無事務
    public void noneTransaction() throws SQLException {

        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 增加一個與user1主鍵相同的使用者
        User user2 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user2);
        
    }
	//....

}

案例解析

1、無事務

• 插入兩個id(主鍵)相同的使用者資料。

// 無事務
    public void noneTransaction() throws SQLException {

        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 增加一個與user1主鍵相同的使用者
        User user2 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user2);
        
    }

• 插入第一條資料成功，第二條資料失敗
• 由於沒有事務控制，資料庫表中會存在一條資料：
  

2、 Propagation.REQUIRED

• 這個是預設的事務傳播行為：如果當前沒有事務，就新建一個事務，如果已經存在一個事務，則加入到這個事務中。
• 仍然插入兩個id(主鍵)相同的使用者資料。

    // 事務傳播為PROPAGATION_REQUIRED
    @Transactional(propagation = Propagation.REQUIRED)
    public void requiredTransaction() throws SQLException {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 增加一個與user1主鍵相同的使用者
        User user2 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user2);
    }

• 第二條資料插入時報重複主鍵錯誤
  
• 由於啟用了事務，提示事務回滾，表中沒有插入任何資料
  

3. Propagation.SUPPORTS

• 支援當前事務，如果當前沒有事務，就以非事務方式執行。這裡我們做兩個測試，首先以原來的程式碼，即呼叫外層沒有啟用事務來執行：

    // 事務傳播為PROPAGATION_SUPPORTS
    // 呼叫的外層沒有事務
    @Transactional(propagation = Propagation.SUPPORTS)
    public void supportsTransaction() throws SQLException {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 增加一個與user1主鍵相同的使用者
        User user2 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user2);
    }

• 第一條插入成功，插入第二條事務時報主鍵重複錯誤，由於呼叫方外層啟用事務，表中存留第一條資料。
  
  
• 接下來修改程式碼，用一個已啟事務的呼叫方來呼叫該測試過程：

    // 事務傳播為PROPAGATION_SUPPORTS
    // 呼叫方已啟用事務
    @Transactional
    public void callSupportsTransaction() throws SQLException {
        supportsTransaction();
    }
    
	@Transactional(propagation = Propagation.SUPPORTS)
    public void supportsTransaction() throws SQLException {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 增加一個與user1主鍵相同的使用者
        User user2 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user2);
    }

• 第一條插入成功，插入第二條事務時報主鍵重複錯誤，但由於這次呼叫方已啟用了事務，表中沒有插入任何資料。
  
  

4. Propagation.MANDATORY

• 表示該方法必須在事務中執行，如果當前事務不存在，則會丟擲一個異常。
• 我們首先直接執行以下程式碼

    // 事務傳播為PROPAGATION_MANDATORY
    @Transactional(propagation = Propagation.MANDATORY)
    public void mandatoryTransaction() throws SQLException {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
    }

• 由於呼叫外層沒有啟用事務，該段測試程式碼判斷當前事務不存在，則會丟擲不存在事務的錯誤
  
• 接下來使用呼叫方的外層啟用事務，再呼叫這段測試程式碼:

// 事務傳播為PROPAGATION_MANDATORY
    // 呼叫方啟用事務
    @Transactional
    public void callMandatoryTransaction() throws SQLException {
        User user = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user);
        mandatoryTransaction();
    }

	 @Transactional(propagation = Propagation.MANDATORY)
    public void mandatoryTransaction() throws SQLException {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
    }

• 測試程式在插入第二條資料時報主鍵錯誤
  
• 由於呼叫方啟用事務，事務回滾，沒有插入任何資料。
  

5. Propagation.REQUIRED_NEW

• 表示當前方法必須執行在它自己的事務中。一個新的事務將被啟動。如果存在當前事務，在該方法執行期間，當前事務會被掛起。

• 針對這種特性，我們做一個有趣的實驗：呼叫方啟用預設事務，並呼叫事務傳播為PROPAGATION_REQUIRES_NEW的程式，並故意造成事務回滾。

// 呼叫方啟用預設事務，並呼叫事務傳播為PROPAGATION_REQUIRES_NEW的程式，在外層故意造成事務回滾
    @Transactional
    public void callRequiresNewTransaction() throws SQLException {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        requiresNewTransaction();
        // 增加一個主鍵重複的使用者，故意造成事務回滾
        User user2 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user2);
    }

    // 事務傳播為PROPAGATION_REQUIRES_NEW
    @Transactional(propagation=Propagation.REQUIRES_NEW)
    public void requiresNewTransaction() throws SQLException {
        User user = new User(101L, "Jack", "Jack@163.com");
        userDAO.addUser(user);
    }

• 測試情況如下：在外層事務造成回滾後，表中沒有插入任何資料。
  
  
• 接下來再改下程式，呼叫方啟用預設事務，並呼叫事務傳播為PROPAGATION_REQUIRES_NEW的程式，但在呼叫的程式內層故意造成事務回滾。

  // 呼叫方啟用預設事務，並呼叫事務傳播為PROPAGATION_REQUIRES_NEW的程式
    @Transactional
    public void callRequiresNewTransaction() throws SQLException {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 呼叫事務傳播為PROPAGATION_REQUIRES_NEW的過程
        requiresNewTransaction();
       
        User user2 = new User(101L, "Rose", "Rose@163.com");
        userDAO.addUser(user2);
    }

    // 事務傳播為PROPAGATION_REQUIRES_NEW
    // 內層錯誤造成事務回滾
    @Transactional(propagation = Propagation.REQUIRES_NEW)
    public void requiresNewTransaction(){
        // 增加一個主鍵重複的使用者，故意造成事務回滾
        User user2 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user2);
    }

• 同樣會造成事務回滾，表中無任何資料插入
  
  

6. Propagation.NOT_SUPPORTED

• 該方法不應該執行在事務中。如果當前存在事務，就把當前事務掛起。
• 為了測試該特性，我們首先定義另外一個測試服務類，該服務類中定義了事務傳播為Propagation.NOT_SUPPORTED的方法

/**
 * 測試 Propagation.NOT_SUPPORTED
 */
@Service
public class UserServiceTest {
    @Autowired
    private UserDAOImpl userDAO;
    // 事務傳播為Propagation.NOT_SUPPORTED
    @Transactional(propagation = Propagation.NOT_SUPPORTED)
    public void notSupportedTransaction(){
        User user2 = new User(101L, "Rose", "Rose@163.com");
        userDAO.addUser(user2);
    }

}

• 在主測試類啟用預設事務，並呼叫新增服務類中的事務傳播為Propagation.NOT_SUPPORTED的方法，並且故意增加重複使用者資料，造成主服務的事務回滾：

 // 主測試類啟用預設事務，並呼叫Propagation.NOT_SUPPORTED的方法
    @Transactional
    public void callNotSupportedTransaction() {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 呼叫事務傳播為Propagation.NOT_SUPPORTED的過程
        userServiceTest.notSupportedTransaction();
        // 增加重複使用者資料
        User user2 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user2);
    }

• 由於主服務類中啟用了事務，在插入第二條重複使用者資料時，會報主鍵衝突，造成事務回滾，兩條資料都沒有插入；但新增的服務類的方法沒有執行在事務中，新增的使用者資料會插入表中。
  
  

7. Propagation.NEVER

• 表示當前方法不應該執行在事務上下文中。如果當前正有一個事務在執行，則會丟擲異常。
• 按測試Propagation.NOT_SUPPORTED進行改造，主服務類啟用預設事務特性，並呼叫測試服務類Propagation.NEVER的過程

// 呼叫方啟用預設事務，並呼叫Propagation.NEVER的過程
    // 呼叫方啟用預設事務，並呼叫Propagation.NEVER的過程
    @Transactional
    public void callNeverTransaction  {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 呼叫事務傳播為Propagation.NEVER的過程
        userServiceTest.neverTransaction();
    }

// 事務傳播為Propagation.NEVER的過程
    @Transactional(propagation = Propagation.NEVER)
    public void neverTransaction() {
        User user2 = new User(101L, "Rose", "Rose@163.com");
        userDAO.addUser(user2);
    }

• 由於主服務類啟用了事務，而測試服務類的Propagation.NEVER不允許執行在事務中，會丟擲異常。
  

8. Propagation.NESTED

• 如果當前存在事務，則在巢狀事務內執行。如果當前沒有事務，則執行與PROPAGATION_REQUIRED類似的操作。
• 測試案例如下：主服務類不起任何事務，呼叫測試服務類Propagation.NESTED 的方法，且該方法中故意製造主鍵衝突的重複資料

// 呼叫方不起事務，並呼叫Propagation.NESTED的過程
    public void callNestedTransaction(User user)  {
        User user1 = new User(100L, "Jack", "Jack@163.com");
        userDAO.addUser(user1);
        // 呼叫事務傳播為Propagation.NEVER的過程
        userServiceTest.nestedTransaction();
    }

// 事務傳播為Propagation.NESTED
    @Transactional(propagation = Propagation.NESTED)
    public void nestedTransaction() {
        User user2 = new User(101L, "Rose", "Rose@163.com");
        userDAO.addUser(user2);
        // 插入重複資料，造成主鍵衝突
        User user3 = new User(101L, "Rose", "Rose@163.com");
        userDAO.addUser(user3);
    }

• 由於主服務類沒有啟用事務，則第一條資料會插入表中，但測試服務類啟用了Propagation.NESTED特性的事務，也即相當於預設事務行為，主鍵衝突丟擲異常後，造成事務回滾，後面增加的兩條資料都沒有插入表。
  
  

注意點

• 需要巢狀測試事務傳播特性時應建立兩個服務類，儘量不要在同一服務類中呼叫。