原文网址:Mybatis-Plus--逻辑删除的用法_IT利刃出鞘的博客-CSDN博客
说明
本文介绍Mybatis-Plus的逻辑删除的用法。
删除功能是项目中经常见到的需求。比如:需要删除一个订单,一般不会把实际数据删除,而是逻辑删除。一般表中有一个is_deleted字段标识该用户是否被删除,0 表示未删除 1 表示已删除。
官网
粉丝福利:有很多粉丝私信问我有没有Java的面试及PDF书籍等资料,我整理一下,包含:真实面试题汇总、简历模板、PDF书籍、PPT模板等。这些是我自己也在用的资料,面试题是面试官问到我的问题的整理,其他资料也是我自用的,真正实用、靠谱。资料可以从这里免费获取:资料地址
配置删除未删除的状态码
配置未删除、已删除分别标识的状态码是什么,这里采用的yml格式。
- mybatis-plus:
- global-config:
- db-config:
- # 1 代表已删除。默认是1。也可写为字段名,如:id,这样删除时会将id的值写到逻辑删除字段
- logic-delete-value: 1
- # 0 代表未删除。默认是0
- logic-not-delete-value: 0
全局配置字段名(可不配置)
若项目代码比较规范,所有表的逻辑删除字段使用相同的名称(比如:deleted_flag),我们可以在 application.properties 中添加如下统一的配置,这样对应的实体类字段上就不需要再添加 @TableLogic 注解了:
注意:如果设置了全局逻辑删除字段值,实体类上仍然有 @TableLogic 则以实体上的为准,忽略全局。
- mybatis-plus:
- global-config:
- db-config:
- logic-delete-field: deleted_flag
实体类对应的字段上加上注解@TableLogic
- @Data
- @TableName("t_user")
- public class User {
-
- @TableId(value = "id", type = IdType.AUTO)
- private Long id;
-
- @TableLogic
- private String deleted;
- }
数据库deleted列,设置为tinyint类型,长度为1
插入测试
插入时,sql语句不会涉及逻辑删除的字段。
查询、修改测试
使用MP逻辑删除的功能之后,执行查询、修改的方法,MP会为我们自动加上未删除的条件。自定义sql除外
- @Test
- public void select(){
- List
users = userMapper.selectList(Wrappers.lambdaQuery().eq(User::getAge, 18)); - users.forEach(System.out::println);
- }
-
- @Test
- public void update(){
- User user = new User();
- user.setEmail("Test@email.com");
-
- int update = userMapper.update(user, Wrappers.
lambdaQuery().eq(User::getAge, 18)); - System.out.println(update);
- }
- DEBUG==> Preparing: SELECT id,login_name,name,password,email,salt,sex,age,phone,user_type,status,organization_id,create_time,is_delete FROM sys_user WHERE deleted='0' AND age = ?
- DEBUG==> Parameters: 18(Integer)
- DEBUG<== Total: 0
-
-
- DEBUG==> Preparing: UPDATE sys_user SET email=? WHERE deleted='0' AND age = ?
- DEBUG==> Parameters: Test@email.com(String), 18(Integer)
- DEBUG<== Updates: 0
删除测试
(执行的SQL语句是UPDATE)
- @Test
- public void delete() {
- int i = userMapper.deleteById(1);
- System.out.println(i);
- }
- DEBUG==> Preparing: UPDATE sys_user SET is_delete='1' WHERE id=? AND deleted='0'
- DEBUG==> Parameters: 1(Integer)
- DEBUG<== Updates: 1
不查询is_deleted字段
@TableField(select = false)即可。还可使用Wrapper的select表达式来排除某些查询字段,只是通过注解的方式更方便。
- @TableLogic
- @TableField(select = false)
- private String deleted;