MyBatis-Plus實現(xiàn)邏輯刪除功能解析

更新時間：2023年11月20日 08:59:37 作者：西瓜游俠

這篇文章主要介紹了MyBatis-Plus實現(xiàn)邏輯刪除功能解析,有時候并不需要真正的刪除數(shù)據(jù),而是想邏輯刪除,方便數(shù)據(jù)恢復,MyBatis-Plus可以很方便的實現(xiàn)邏輯刪除的功能,需要的朋友可以參考下

前言

有時候并不需要真正的刪除數(shù)據(jù)，而是想邏輯刪除，方便數(shù)據(jù)恢復。

MyBatis-Plus可以很方便的實現(xiàn)邏輯刪除的功能。

Entity類

首先，數(shù)據(jù)庫表添加一個表示邏輯刪除的字段delete_flag：

CREATE TABLE `tb_user` (
  `id` bigint NOT NULL COMMENT '主鍵ID',
  `name` varchar(30) COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '姓名',
  `age` int DEFAULT NULL COMMENT '年齡',
  `email` varchar(50) COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '郵箱',
  `create_time` timestamp NOT NULL COMMENT '創(chuàng)建時間',
  `update_time` timestamp NOT NULL COMMENT '更新時間',
  `delete_flag` tinyint(1) NOT NULL COMMENT '邏輯刪除，0 - 未刪除；-1 - 已刪除',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci

對應的UserEntity實體類：

@Data
@TableName("tb_user")
public class UserEntity {
    private Long id;
    private String name;
    private Integer age;
    private String email;

    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    private Integer deleteFlag;
}

配置

首先，需要在UserEntity實體類中的deleteFlag字段上進行注解配置：

@TableLogic(value = "0", delval = "-1")配置邏輯刪除字段的值，value的值表示未刪除的時候的值，delval的值表示已刪除時候的值；

@TableField(value = "delete_flag", fill = FieldFill.INSERT)配置deleteFlag字段的自動填充規(guī)則。

@Data
@TableName("tb_user")
public class UserEntity {
    private Long id;
    private String name;
    private Integer age;
    private String email;

    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @TableLogic(value = "0", delval = "-1")
    @TableField(value = "delete_flag", fill = FieldFill.INSERT)
    private Integer deleteFlag;
}

可以配置deleteFlag在insert數(shù)據(jù)的時候，默認填充0：

/**
 * 自動填充字段值得配置
 */
@Component
public class AutoFillFieldValueConfig implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
        this.strictInsertFill(metaObject, "updateTime", Date.class, new Date());
        this.strictInsertFill(metaObject, "deleteFlag", Integer.class, 0);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
    }
}

測試一下

下面來測試一下。

首先，添加一個新的用戶：

    @Test
    public void testLogicDelete() {
        // 插入一個新的用戶
        UserEntity newUser = new UserEntity();
        newUser.setId(11L);
        newUser.setName("Kevin");
        newUser.setAge(25);
        newUser.setEmail("kevin@163.com");
        userMapper.insert(newUser);
    }

控制臺日志：

==> Preparing: INSERT INTO tb_user ( id, name, age, email, create_time, update_time, delete_flag ) VALUES ( ?, ?, ?, ?, ?, ?, ? )
==> Parameters: 11(Long), Kevin(String), 25(Integer), kevin@163.com(String), 2021-09-20 21:29:37.232(Timestamp), 2021-09-20 21:29:37.234(Timestamp), 0(Integer)
<== Updates: 1

數(shù)據(jù)庫數(shù)據(jù)：

在這里插入圖片描述

可以看到，delete_flag默認填充了0。

下面，來測試一下邏輯刪除（現(xiàn)在調(diào)用所有的刪除方法，都是邏輯刪除）：

    @Test
    public void testLogicDelete() {
        // 插入一個新的用戶
//        UserEntity newUser = new UserEntity();
//        newUser.setId(11L);
//        newUser.setName("Kevin");
//        newUser.setAge(25);
//        newUser.setEmail("kevin@163.com");
//        userMapper.insert(newUser);

        // 邏輯刪除
        userMapper.deleteById(11L);
    }

控制臺日志：