MybatisPlus中@TableLogic注解的使用实现

 更新时间:2025年10月23日 10:01:29   作者:小猿、  
@TableLogic注解是MyBatis-Plus框架中用于处理逻辑删除的注解,逻辑删除是一种常见的删除策略,其中并不真正删除数据记录,而是通过修改某个标记字段的值来表示记录已经被删除,方便以后恢复或者审计,感兴趣的可以了解一下

概述

@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 注解来标记逻辑删除字段。逻辑删除字段一般是一个标记字段,常见的类型是 IntegerBoolean,用于指示记录是否被删除。

示例代码
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 注解用于标记实体类中的逻辑删除字段。
  • 逻辑删除字段通常是 IntegerBoolean 类型。
  • MyBatis-Plus 自动处理逻辑删除的标记,不需要额外配置。
  • 在实际删除操作中,记录不会被真正删除,而是通过逻辑删除字段进行标记。

到此这篇关于MybatisPlus中@TableLogic注解的使用实现的文章就介绍到这了,更多相关MybatisPlus @TableLogic注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java 注解与反射实战之自定义注解从入门到精通

    Java 注解与反射实战之自定义注解从入门到精通

    本文给大家介绍Java 注解与反射实战之自定义注解从入门到精通,本文将从基础到实战,带你掌握自定义注解的定义、元注解的作用,以及如何通过反射让注解 "生效",感兴趣的朋友跟随小编一起看看吧
    2025-10-10
  • java枚举是如何保证线程安全的

    java枚举是如何保证线程安全的

    这篇文章主要介绍了java枚举是如何保证线程安全的。Java SE5提供了一种新的类型-Java的枚举类型,关键字enum可以将一组具名的值的有限集合创建为一种新的类型,而这些具名的值可以作为常规的程序组件使用,这是一种非常有用的功能。,需要的朋友可以参考下
    2019-06-06
  • Mybatis SqlSessionFactory与SqlSession详细讲解

    Mybatis SqlSessionFactory与SqlSession详细讲解

    SqlSessionFactory是MyBatis的核心类之一,其最重要的功能就是提供创建MyBatis的核心接口SqlSession,所以我们需要先创建SqlSessionFactory,为此我们需要提供配置文件和相关的参数
    2022-11-11
  • 图解Spring容器中实例化bean的四种方式

    图解Spring容器中实例化bean的四种方式

    这篇文章主要介绍了图解Spring容器中实例化bean的四种方式,传统应用程序可以通过new和反射方式进行实例化Bean,而Spring IOC容器则需要根据 Bean 定义里的配置元数据,使用反射机制来创建Bean,需要的朋友可以参考下
    2023-11-11
  • spring cloud服务连接超时问题及解决

    spring cloud服务连接超时问题及解决

    这篇文章主要介绍了spring cloud服务连接超时问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • 详解Spring Security中的HttpBasic登录验证模式

    详解Spring Security中的HttpBasic登录验证模式

    HttpBasic登录验证模式是Spring Security实现登录验证最简单的一种方式,也可以说是最简陋的一种方式,这篇文章主要介绍了Spring Security的HttpBasic登录验证模式,需要的朋友可以参考下
    2019-11-11
  • Springboot 整合 Java DL4J 打造文本摘要生成系统

    Springboot 整合 Java DL4J 打造文本摘要生成系统

    本文介绍了如何使用SpringBoot整合JavaDeeplearning4j构建文本摘要生成系统,该系统能够自动从长篇文本中提取关键信息,生成简洁的摘要,帮助用户快速了解文本的主要内容,技术实现包括使用LSTM神经网络进行模型构建和训练,并通过SpringBoot集成RESTfulAPI接口
    2024-11-11
  • 剖析Java中在Collection集合中使用contains和remove为什么要重写equals

    剖析Java中在Collection集合中使用contains和remove为什么要重写equals

    这篇文章主要介绍了Collection集合的contains和remove方法详解remove以及相关的经验技巧,通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-09-09
  • SpringBoot自动配置原理及案例源码解析

    SpringBoot自动配置原理及案例源码解析

    这篇文章主要为大家介绍了SpringBoot自动配置原理及自动配置案例源码解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • SpringBoot如何整合nacos详解

    SpringBoot如何整合nacos详解

    今天教各位小伙伴SpringBoot是如何整合nacos的,文中有非常详细的代码示例,对正在学习Java的小伙伴们有很好的帮助,需要的朋友可以参考下
    2021-06-06

最新评论