跳转到内容

逻辑删除支持

逻辑删除是一种优雅的数据管理策略,它通过在数据库中标记记录为“已删除”而非物理删除,来保留数据的历史痕迹,同时确保查询结果的整洁性。MyBatis-Plus 提供了便捷的逻辑删除支持,使得这一策略的实施变得简单高效。

逻辑删除的工作原理

MyBatis-Plus 的逻辑删除功能会在执行数据库操作时自动处理逻辑删除字段。以下是它的工作方式:

  • 插入:逻辑删除字段的值不受限制。
  • 查找:自动添加条件,过滤掉标记为已删除的记录。
  • 更新:防止更新已删除的记录。
  • 删除:将删除操作转换为更新操作,标记记录为已删除。

例如:

  • 删除:update user set deleted=1 where id = 1 and deleted=0
  • 查找:select id,name,deleted from user where deleted=0

支持的数据类型

逻辑删除字段支持所有数据类型,但推荐使用 Integer、Boolean 或 LocalDateTime。 如果使用 datetime 类型,可以配置逻辑未删除值为 null(长度为4的字符串,在yaml中需使用转义符(单引号)包裹),已删除值可以使用函数如 now() 来获取当前时间。 如果使用 bigint 类型,可以配置逻辑未删除值为 0,已删除值可以使用函数如 UNIX_TIMESTAMP() 来获取当前时间戳作为删除标识。适合用于将删除字段作为唯一索引组成列,可以多次逻辑删除.

使用方法

方法 1: 配置全局逻辑删除属性

在 application.yml 中配置 MyBatis-Plus 的全局逻辑删除属性:

mybatis-plus:
global-config:
db-config:
logic-delete-field: deleted # 全局逻辑删除字段名(deleted为实体类属性名称)
logic-delete-value: 1 # 逻辑已删除值。可选,默认值为 1
logic-not-delete-value: 0 # 逻辑未删除值。可选,默认值为 0

方法 2: 如不想使用全局配置,可以在实体类中使用 @TableLogic 注解,对类单独进行配置

在实体类中,对应数据库表的逻辑删除字段上添加 @TableLogic 注解:

import com.baomidou.mybatisplus.annotation.TableLogic;
public class User {
// 其他字段...
@TableLogic
private Integer deleted;
}

同样,逻辑未删除值默认为 0,逻辑已删除值默认为 1。这两个值可以通过设置 @TableLogic 注解的 value 属性和 delval 属性的值来进行修改。

常见问题解答

1. 如何处理插入操作?

  • 方法一:在数据库中为逻辑删除字段设置默认值。
  • 方法二:在插入数据前手动设置逻辑删除字段的值。
  • 方法三:使用 MyBatis-Plus 的自动填充功能。

2. 删除接口自动填充功能失效怎么办?

  • 方法一:使用 deleteById 方法。
  • 方法二:使用 update 方法,并使用 UpdateWrapper.set(column, value)。
  • 方法三:使用 update 方法,并使用 UpdateWrapper.setSql("column=value")。
  • 方法四:使用 Sql 注入器注入 com.baomidou.mybatisplus.extension.injector.methods.LogicDeleteByIdWithFill 并使用(3.5.0版本已废弃,推荐使用deleteById)。

3. 逻辑删除与唯一索引冲突怎么办?

表上有唯一索引(如用户名、手机号)时,记录被逻辑删除后仍然留在表中,再次插入相同的值会报唯一约束冲突。

直接把唯一索引改成 (username, deleted) 并不能解决问题:deleted 只有 0、1 两个值时,同一个用户名只能存在一条已删除记录,第二次删除同名记录时就会冲突。

推荐的做法是让已删除的值各不相同、未删除的值固定,并把逻辑删除字段加入唯一索引:

CREATE TABLE user
(
id BIGINT NOT NULL PRIMARY KEY,
username VARCHAR(64) NOT NULL,
deleted BIGINT NOT NULL DEFAULT 0 COMMENT '0 未删除,删除时写入主键值',
UNIQUE KEY uk_username_deleted (username, deleted)
);
public class User {
private Long id;
private String username;
@TableLogic(value = "0", delval = "id")
private Long deleted;
}

删除时生成的 SQL 如下,每条已删除记录的 deleted 都等于自己的主键,互不冲突;未删除记录的 deleted 都是 0,唯一约束照常生效:

UPDATE user SET deleted=id WHERE id=? AND deleted=0

如果希望同时记录删除时间,也可以把已删除值设为时间戳函数,例如 MySQL 的 @TableLogic(value = "0", delval = "UNIX_TIMESTAMP()")。但同一秒内删除两条相同用户名的记录时仍会冲突,对唯一性要求严格的场景推荐使用主键值。

通过以上步骤,你可以轻松地在 MyBatis-Plus 中实现逻辑删除功能,提高数据管理的灵活性和安全性。

Baomidou

© 2016-2026 Baomidou™. All Rights Reserved.

Power by Astro Starlight | Sponsored by JetBrains

渝ICP备2021000141号-1 | 渝公网安备50011302222097