MybatisPlus中@TableLogic注解介绍、示例代码

概述

@TableLogic 是 MyBatis-Plus 框架中用于处理逻辑删除的注解。逻辑删除是一种常见的删除策略，其中并不真正删除数据记录，而是通过修改某个标记字段的值来表示记录已经被删除。这种方式可以使数据在被标记为删除后依然存在于数据库中，方便以后恢复或者审计。

使用 @TableLogic 注解

1. 添加依赖

确保你的项目中已经添加了 MyBatis-Plus 的依赖。如果还没有，可以在 pom.xml 中添加：

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

2. 配置实体类

在你的实体类中，使用 @TableLogic 注解来标记逻辑删除字段。逻辑删除字段一般是一个标记字段，常见的类型是 Integer 或 Boolean，用于指示记录是否被删除。

示例代码

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableLogic;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;

@TableName("user")
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    private Long id;
    private String name;
    private Integer age;

    @TableLogic
    @TableField("is_deleted") // 数据库中的字段名
    private Integer deleted; // 标记字段，0表示未删除，1表示已删除

    // 省略 getters 和 setters

    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 Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Integer getDeleted() {
        return deleted;
    }

    public void setDeleted(Integer deleted) {
        this.deleted = deleted;
    }
}

在上面的代码中，@TableLogic 注解标记了 deleted 字段为逻辑删除标记字段。默认情况下，deleted 字段的值为 0 表示未删除，为 1 表示已删除。你可以根据实际情况修改这些值的含义。

3. 配置 MyBatis-Plus

你不需要对 @TableLogic 做额外配置，它会自动处理。在 MyBatis-Plus 中，逻辑删除的处理是自动进行的，只要你使用了 @TableLogic 注解，MyBatis-Plus 会在删除操作时自动将逻辑删除字段的值设置为指定的值（通常是1）。

4. 使用逻辑删除

当你执行删除操作时（例如 deleteById 方法），MyBatis-Plus 会自动将标记字段设置为已删除状态，而不是实际删除记录。例如：

@Autowired
private UserMapper userMapper;

public void deleteUser(Long id) {
    userMapper.deleteById(id); // 这会将 `deleted` 字段设置为 1
}

如果你需要恢复数据，你可以手动将逻辑删除字段恢复到未删除状态：

public void restoreUser(Long id) {
    User user = userMapper.selectById(id);
    if (user != null) {
        user.setDeleted(0); // 设置为0表示未删除
        userMapper.updateById(user);
    }
}

总结

• @TableLogic 注解用于标记实体类中的逻辑删除字段。
• 逻辑删除字段通常是 Integer 或 Boolean 类型。
• MyBatis-Plus 自动处理逻辑删除的标记，不需要额外配置。
• 在实际删除操作中，记录不会被真正删除，而是通过逻辑删除字段进行标记。