当前位置: 代码网 > it编程>编程语言>Java > MyBatis Plus @TableLogic逻辑删除注解怎么用

MyBatis Plus @TableLogic逻辑删除注解怎么用

2026年09月08日 Java 我要评论
1. @tablelogic注解@tablelogic:表示逻辑删除注解效果:在字段上加上这个注解再执行basemapper的删除方法时,删除方法就会变成修改例:  实体类:      @table

1. @tablelogic注解

@tablelogic:表示逻辑删除注解

效果:在字段上加上这个注解再执行basemapper的删除方法时,删除方法就会变成修改

例:
  实体类:
       @tablelogic
      private integer del;

   service层:
      调用basemapper的deletebyid(id);

 执行是效果:

      加@tablelogic的情况下
      走 update 表名 set 加注解的列=值 where del=值
       不加@tablelogic的情况下
      走 delete from 表名 where del=值

 @tablelogic注解参数

    value = "" 默认的原值
    delval = "" 删除后的值
    @tablelogic(value="原值",delval="改值")

2. 注解说明

@tablelogic 用于实现数据库数据逻辑删除

注意,该注解只对自动注入的 sql 起效

3. @tablelogic 对于 ciud 的限制

3.1 插入(insert)

不作限制

3.2 查找(select)

@tablelogic 注解将会在 select 语句的 where 条件添加条件,过滤掉已删除数据

且使用 wrapper.entity 生成的 where 条件会忽略该字段

select` `user_id,``name``,sex,age,deleted ``from` `user` `where` `user_id=1 ``and` `deleted=``'0'

3.3 更新(update)

@tablelogic 注解将会在 update 语句的 where 条件后追加条件,防止更新到已删除数据

且使用 wrapper.entity 生成的 where条件会忽略该字段

update` `user` `set` `deleted=1 ``where` `id = 1 ``and` `deleted=0

3.4 删除(delete)

@tablelogic 注解会将 delete 语句转变为 update 语句

update` `user` `set` `deleted=1 ``where` `id = 1 ``and` `deleted=0

4. @tablelogic 字段类型支持说明:

支持所有数据类型(推荐使用 integer、boolean、localdatetime)

如果数据库字段使用 datetime,逻辑未删除值和已删除值支持配置为字符串 null,另一个值支持配置为函数来获取值如now()

附录:

(1)逻辑删除是为了方便数据恢复和保护数据本身价值等等的一种方案,但实际就是删除。

(2)如果你需要频繁查出来看就不应使用逻辑删除,而是以一个状态去表示。

5. 属性说明

5.1 value

用来指定逻辑未删除值,默认为空字符串

5.2 delval

用来指定逻辑删除值,默认为空字符串。

6. 在配置文件中实现

当然,你也可以不在 @tablelogic 注解中指定 value 和 delval 属性的值。

使用全局逻辑删除配置信息,配置如下:

# application.yml
mybatis-plus:
  global-config:
    db-config:
      # 全局逻辑删除的实体字段名 (since 3.3.0, 配置后可以忽略 @tablelogic 中的配置)
      logic-delete-field: flag
      # 逻辑已删除值(默认为 1)
      logic-delete-value: 1
      # 逻辑未删除值(默认为 0)
      logic-not-delete-value: 0

7. 代码实践

7.1 代码实践过程

我们在 user 数据表中添加一个 deleted 字段。

如果该字段值为1,表示记录被删除。如果该字段值为0,表示记录未被删除

1.向 user 数据表添加 deleted 字段,sql 如下:

-- 添加一个 deleted 字段,实现逻辑删除
alter table `user`
add column `deleted`  varchar(1) null default 0 comment '是否删除(1-删除;0-未删除)';

2.创建 user 表的实体类 annotationuser7bean

使用 @tablelogic 注解将 deleted 成员变量指定为逻辑删除字段

import com.baomidou.mybatisplus.annotation.*;
 
@tablename(value = "user")
public class annotationuser7bean {
   @tableid(value = "user_id", type = idtype.auto)
   private int userid;
    
   @tablefield("name")
   private string name;
    
   @tablefield("sex")
   private string sex;
    
   @tablefield("age")
   private integer age;
    
   @tablelogic(value = "0", delval = "1")
   private string deleted;
    
   // 忽略 getter 和 setter 方法
    
   @override
   public string tostring() {
      return "userbean{" +
            "userid=" + userid +
            ", name='" + name + '\'' +
            ", sex='" + sex + '\'' +
            ", age=" + age +
            ", deleted=" + deleted +
            '}';
   }
}

上面代码中,使用 @tablelogic 注解将 deleted 成员变量指定为逻辑删除字段

@tablelogic(value = "0", delval = "1")
private string deleted;

3.客户端代码,先查询用户id为1的用户是否存在

如果存在,则删除该用户信息

然后,查询用户id小于10的用户信息

package com.hxstrive.mybatis_plus.simple_mapper.annotation;
 
import com.baomidou.mybatisplus.core.conditions.query.querywrapper;
import com.hxstrive.mybatis_plus.mapper.annotationuser7mapper;
import com.hxstrive.mybatis_plus.model.annotationuser7bean;
import org.junit.jupiter.api.test;
import org.junit.runner.runwith;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.boot.test.context.springboottest;
import org.springframework.test.context.junit4.springrunner;
 
@runwith(springrunner.class)
@springboottest
class annotationdemo7 {
 
    @autowired
    private annotationuser7mapper usermapper;
 
    @test
    void contextloads() throws exception {
        // 删除用户id为1的用户信息
        annotationuser7bean olduserbean = usermapper.selectbyid(1);
        if(null != olduserbean) {
            usermapper.deletebyid(olduserbean.getuserid());
        }
 
        // 查询用户信息
        querywrapper<annotationuser7bean> wrapper = new querywrapper<>();
        wrapper.lt("user_id", 10);
        for(annotationuser7bean item : usermapper.selectlist(wrapper)) {
            system.out.println(item);
        }
    }
 
}

7.2 数据库代码执行说明

根据用户id查询用户信息

preparing: select user_id,name,sex,age,deleted from user where user_id=? and deleted='0'
parameters: 1(integer)

根据用户id删除用户信息

sql 是一个更新语句,这是因为我们使用了逻辑删除,而不是物理删除

preparing: update user set deleted='1' where user_id=? and deleted='0'
parameters: 1(integer)

查询用户id小于10的用户信息

preparing: select user_id,name,sex,age,deleted from user where deleted='0' and (user_id < ?)
parameters: 10(integer)

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持代码网。

(0)

相关文章:

版权声明:本文内容由互联网用户贡献,该文观点仅代表作者本人。本站仅提供信息存储服务,不拥有所有权,不承担相关法律责任。 如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 2386932994@qq.com 举报,一经查实将立刻删除。

发表评论

验证码:
Copyright © 2017-2026  代码网 保留所有权利. 粤ICP备2024248653号
站长QQ:2386932994 | 联系邮箱:2386932994@qq.com