mybatis-plus怎么配置邏輯刪除

MyBatis-Plus怎么配置邏輯刪除

在現代的軟件開發中，數據的安全性和完整性是非常重要的。邏輯刪除是一種常見的數據管理策略，它通過在數據庫中標記記錄為“已刪除”而不是真正地從數據庫中刪除記錄，來保留數據的歷史記錄和審計跟蹤。MyBatis-Plus 是一個強大的 MyBatis 增強工具，它提供了許多便捷的功能，包括邏輯刪除的支持。本文將詳細介紹如何在 MyBatis-Plus 中配置邏輯刪除。

1. 什么是邏輯刪除？

邏輯刪除（Logical Delete）是指在數據庫中不真正刪除記錄，而是通過更新某個字段的值來標記該記錄為“已刪除”。通常，這個字段是一個布爾類型的字段（如 is_deleted），或者是一個時間戳字段（如 delete_time）。邏輯刪除的好處是可以保留數據的歷史記錄，方便后續的審計和恢復操作。

2. MyBatis-Plus 中的邏輯刪除

MyBatis-Plus 提供了對邏輯刪除的內置支持，開發者可以通過簡單的配置來實現邏輯刪除功能。MyBatis-Plus 的邏輯刪除功能基于全局配置和注解兩種方式來實現。

2.1 全局配置

在 MyBatis-Plus 中，可以通過全局配置來啟用邏輯刪除功能。全局配置適用于整個項目中的所有實體類。

2.1.1 配置步驟

1. 添加依賴：首先，確保你的項目中已經引入了 MyBatis-Plus 的依賴。

   <dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-boot-starter</artifactId>
       <version>最新版本</version>
   </dependency>

1. 配置邏輯刪除字段：在 application.yml 或 application.properties 文件中配置邏輯刪除的字段名和刪除標記值。

   mybatis-plus:
     global-config:
       db-config:
         logic-delete-field: is_deleted  # 邏輯刪除字段名
         logic-delete-value: 1           # 邏輯刪除標記值（已刪除）
         logic-not-delete-value: 0       # 邏輯未刪除標記值（未刪除）

1. 實體類配置：在實體類中，確保邏輯刪除字段與配置的字段名一致。

   @Data
   public class User {
       private Long id;
       private String name;
       private Integer age;
       private Integer isDeleted;  // 邏輯刪除字段
   }

1. 測試邏輯刪除：在代碼中調用 MyBatis-Plus 的 deleteById 或 delete 方法時，MyBatis-Plus 會自動將 is_deleted 字段更新為 1，而不是真正刪除記錄。

   userMapper.deleteById(1L);  // 邏輯刪除，將 is_deleted 字段更新為 1

2.2 注解配置

除了全局配置外，MyBatis-Plus 還支持通過注解的方式為單個實體類配置邏輯刪除。

2.2.1 配置步驟

1. 實體類配置：在實體類中使用 @TableLogic 注解標記邏輯刪除字段。

   @Data
   public class User {
       private Long id;
       private String name;
       private Integer age;

       @TableLogic
       private Integer isDeleted;  // 邏輯刪除字段
   }

1. 測試邏輯刪除：與全局配置相同，調用 deleteById 或 delete 方法時，MyBatis-Plus 會自動更新 is_deleted 字段。

   userMapper.deleteById(1L);  // 邏輯刪除，將 is_deleted 字段更新為 1

2.3 自定義邏輯刪除 SQL

在某些情況下，開發者可能需要自定義邏輯刪除的 SQL 語句。MyBatis-Plus 提供了 @SqlParser 注解來實現自定義 SQL。

2.3.1 配置步驟

1. 自定義 SQL：在 Mapper 接口中定義自定義的邏輯刪除 SQL。

   @Mapper
   public interface UserMapper extends BaseMapper<User> {
       @Update("UPDATE user SET is_deleted = 1 WHERE id = #{id}")
       int logicDeleteById(@Param("id") Long id);
   }

1. 調用自定義 SQL：在代碼中調用自定義的邏輯刪除方法。

   userMapper.logicDeleteById(1L);  // 自定義邏輯刪除

3. 邏輯刪除的查詢

在啟用了邏輯刪除后，MyBatis-Plus 會自動在查詢語句中添加過濾條件，排除已被邏輯刪除的記錄。例如，執行 selectById 或 selectList 方法時，MyBatis-Plus 會自動添加 WHERE is_deleted = 0 條件。

3.1 查詢已被邏輯刪除的記錄

如果需要查詢已被邏輯刪除的記錄，可以通過自定義 SQL 或使用 @SqlParser 注解來實現。

@Select("SELECT * FROM user WHERE is_deleted = 1")
List<User> selectDeletedUsers();

4. 邏輯刪除的恢復

邏輯刪除的記錄可以通過更新操作來恢復。例如，將 is_deleted 字段更新為 0。

User user = new User();
user.setId(1L);
user.setIsDeleted(0);
userMapper.updateById(user);  // 恢復邏輯刪除的記錄

5. 總結

MyBatis-Plus 提供了簡單而強大的邏輯刪除功能，開發者可以通過全局配置或注解的方式輕松實現邏輯刪除。邏輯刪除不僅可以保留數據的歷史記錄，還能提高數據的安全性和可恢復性。通過本文的介紹，相信你已經掌握了如何在 MyBatis-Plus 中配置和使用邏輯刪除功能。在實際開發中，合理使用邏輯刪除可以大大提高數據管理的靈活性和安全性。