MyBatis-Plus实现逻辑删除的示例代码

2022-11-13 08:11:15 mybatis

一、引言

之前小编讲了MP从入门到核心功能的使用,接下来这几天小编会把MP在实际项目中,一些常用的高级功能给记录一下。

高级功能分为:逻辑删除、自动填充、乐观插件、性能分析插件、多租户SQL解析器、动态表名SQL解析器、SQL注入器

今天先来说说在MP中如何使用逻辑删除,逻辑删除小编就不过多介绍了,顾名思义就是通过逻辑判断的手段表示该条数据已删除。

二、具体实现

删除功能是项目中经常见到的需求,比如需要删除某一件商品,删除一个订单,但往往不会把实际数据删除,而是选择逻辑删除来实现。

小编拿用户举例子,用户表中有一个is_delete字段标识该用户是否被删除,0 表示未删除 1 表示已删除。

步骤一:首先我们需要配置未删除、已删除分别标识的状态码是什么,这里采用的yml格式。

mybatis-plus:
  global-config:
    db-config:
      # 1 代表已删除,不配置默认是1,也可修改配置
      logic-delete-value: 1
      # 0 代表未删除,不配置默认是0,也可修改配置
      logic-not-delete-value: 0

步骤二:在实体类对应的字段上加上注解@TableLogic即可。


@Data
@TableName("sys_user")
public class User extends Model<User> implements Serializable {
 
    private static final long serialVersionUID=1L;
 
    
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;
 
    // .... 其他字段省略
 
    
    @TableLogic
    private String isDelete;
 
}

步骤三:测试测试,现在我们测试通过ID来删除某一个用户的时,看看执行的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 is_delete='0' 
DEBUG==> Parameters: 1(Integer)
DEBUG<==    Updates: 1

三、使用注意细节

细节一:当我们使用MP逻辑删除的功能之后,比如执行查询、修改的方法,MP会为我们自动加上未删除的条件。自定义sql除外

    @Test
    public void select(){
        List<User> users = userMapper.selectList(Wrappers.<User>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.<User>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 is_delete='0' AND age = ? 
DEBUG==> Parameters: 18(Integer)
DEBUG<==      Total: 0

DEBUG==>  Preparing: UPDATE sys_user SET email=? WHERE is_delete='0' AND age = ? 
DEBUG==> Parameters: Test@email.com(String), 18(Integer)
DEBUG<==    Updates: 0

细节二:当我们查询数据时,不希望查询标识是否删除的字段,我们可以通过如下方式快速解决。当然还可以使用Wrapper中的select表达式来排除某些查询字段,只是通过注解的方式更加方便。

    
    @TableLogic
    @TableField(select = false)
    private String isDelete;

到此这篇关于MyBatis-Plus实现逻辑删除的示例代码的文章就介绍到这了,更多相关MyBatis-Plus 逻辑删除内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!

相关文章