优雅使用 MyBatis-Plus 的 @TableLogic 实现逻辑删除（附完整示例）

原创已于 2025-06-18 16:55:09 修改 · 545 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #数据库 #sql

于 2025-06-18 16:53:28 首次发布

逻辑删除概念

通过状态字段标记数据删除状态（如del_flag），保留数据记录而非物理删除。优势包括数据可恢复性、审计追踪能力以及业务连续性保障。

数据库准备

为需要逻辑删除的表添加状态字段：

ALTER TABLE user 
ADD del_flag INT DEFAULT 0 COMMENT '删除标识（0-正常 1-删除）';

实体类配置

使用@TableLogic注解标记逻辑删除字段：

@Data
@TableName("user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    
    @TableLogic(value = "0", delval = "1")
    private Integer delFlag;
}

全局配置

在application.yml中设置默认值（与注解冲突时以注解优先）：

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: delFlag
      logic-not-delete-value: 0
      logic-delete-value: 1

操作示例

执行删除操作自动转换为更新：

userMapper.deleteById(1L);  // 实际执行UPDATE user SET del_flag=1 WHERE id=1

查询自动过滤已删除数据：

List<User> list = userMapper.selectList(null); 
// 生成SQL包含WHERE del_flag=0

高级配置技巧

支持非数字类型状态值：

@TableLogic(value = "ACTIVE", delval = "DELETED")
private String recordStatus;

注意事项

自定义SQL处理
在XML映射文件中需手动添加条件：

<select id="selectAll" resultType="User">
    SELECT * FROM user WHERE del_flag = 0
</select>

唯一索引优化
避免逻辑删除导致唯一约束冲突：

ALTER TABLE user ADD UNIQUE idx_name_del (name, del_flag);

事务管理示例
混合逻辑删除与物理删除时：

@Transactional
public void deleteUserWithOrders(Long id) {
    userMapper.deleteById(id);
    orderMapper.deleteByUserId(id); 
}

扩展实践建议

审计追踪
添加delete_time和delete_by字段记录操作信息

特殊场景处理
使用@InterceptorIgnore临时关闭逻辑删除：

@InterceptorIgnore(tenantLine = "true", logicDelete = "true")
List<User> selectIncludingDeleted();

性能优化
建立定期归档机制转移已删除数据

恢复接口实现
提供数据恢复能力：

@Update("UPDATE user SET del_flag=0 WHERE id=#{id}")
int recoverById(@Param("id") Long id);

该方案通过声明式配置自动实现逻辑删除，兼顾数据安全性与开发效率。建议在复杂查询场景配合自定义SQL，并注意事务边界控制。