MybatisPlus中@TableLogic注解的使用實現(xiàn)

更新時間：2025年10月23日 10:01:29 作者：小猿、

@TableLogic注解是MyBatis-Plus框架中用于處理邏輯刪除的注解,邏輯刪除是一種常見的刪除策略,其中并不真正刪除數(shù)據(jù)記錄,而是通過修改某個標記字段的值來表示記錄已經(jīng)被刪除,方便以后恢復或者審計,感興趣的可以了解一下

概述

@TableLogic 是 MyBatis-Plus 框架中用于處理邏輯刪除的注解。邏輯刪除是一種常見的刪除策略，其中并不真正刪除數(shù)據(jù)記錄，而是通過修改某個標記字段的值來表示記錄已經(jīng)被刪除。這種方式可以使數(shù)據(jù)在被標記為刪除后依然存在于數(shù)據(jù)庫中，方便以后恢復或者審計。

使用@TableLogic注解

1. 添加依賴

確保你的項目中已經(jīng)添加了 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") // 數(shù)據(jù)庫中的字段名
    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 表示已刪除。你可以根據(jù)實際情況修改這些值的含義。

3. 配置 MyBatis-Plus

你不需要對 @TableLogic 做額外配置，它會自動處理。在 MyBatis-Plus 中，邏輯刪除的處理是自動進行的，只要你使用了 @TableLogic 注解，MyBatis-Plus 會在刪除操作時自動將邏輯刪除字段的值設置為指定的值（通常是1）。

4. 使用邏輯刪除

當你執(zhí)行刪除操作時（例如 deleteById 方法），MyBatis-Plus 會自動將標記字段設置為已刪除狀態(tài)，而不是實際刪除記錄。例如：

@Autowired
private UserMapper userMapper;

public void deleteUser(Long id) {
    userMapper.deleteById(id); // 這會將 `deleted` 字段設置為 1
}

如果你需要恢復數(shù)據(jù)，你可以手動將邏輯刪除字段恢復到未刪除狀態(tài)：

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