MyBatis-Plus中的逻辑删除功能及实例分析

 更新时间:2025年03月14日 11:38:30   作者:极客李华  
本文将详细讲解MyBatis-Plus中的逻辑删除特性,并结合实际案例进行演示和说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

MyBatis-Plus中的逻辑删除功能及实例

介绍:

  • 在实际开发中,数据的删除操作是一个常见需求。
  • MyBatis-Plus提供了方便且灵活的逻辑删除功能,可以简化开发人员在删除数据时的操作。

案例背景

假设我们有一个博客系统,包含Blog类作为博客实体。在这个系统中,我们希望能够对博客进行软删除操作,即将要删除的博客标记为已删除状态,而不是直接物理删除。

通过逻辑删除,我们可以保留删除记录,有助于追踪数据变更历史和实现审计需求。

使用逻辑删除功能

配置数据库和实体类

首先,在使用逻辑删除功能之前,我们需要进行相关的配置。

  1. 在数据库表中,我们需要添加一个用于表示逻辑删除状态的字段。例如,我们可以添加一个名为deletedtinyint类型字段,默认值为0。
  2. 在实体类(这里是Blog类)中,我们使用Lombok来减少getter和setter方法的编写工作。

以下是一个示例:

import com.baomidou.mybatisplus.annotation.TableLogic;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("blog")
public class Blog {
    private Long id;
    private String title;
    private String content;
    @TableLogic
    private Integer deleted;
}

在上述示例中,我们使用@Data注解简化了getter和setter方法的编写,并使用@TableName注解标记了实体类对应的数据库表名。同时,使用@TableLogic注解标记了deleted字段为逻辑删除字段。

执行逻辑删除操作

接下来,我们将演示如何在MyBatis-Plus中使用逻辑删除功能。

方式一:局部配置

局部配置适用于只需要在某个Mapper接口中应用逻辑删除功能的情况。

首先,在Mapper接口中添加@Repository注解并继承BaseMapper接口,例如:

import org.springframework.stereotype.Repository;

@Repository
public interface BlogMapper extends BaseMapper<Blog> {
}

然后,在Service层的实现类中进行逻辑删除的调用:

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

@Service
public class BlogServiceImpl extends ServiceImpl<BlogMapper, Blog> implements BlogService {

    @Override
    public boolean deleteBlogById(Long id) {
        return baseMapper.deleteById(id) > 0;
    }
}

在上述示例中,我们直接调用baseMapper的deleteById方法进行逻辑删除操作。MyBatis-Plus会自动将逻辑删除字段设置为1(表示已删除)。

方式二:全局配置

全局配置适用于对整个项目中的所有Mapper接口都应用逻辑删除功能的情况。

首先,在application.yml或application.properties文件中配置全局属性:

mybatis-plus:
  global-config:
    db-config:
      logic-delete-value: 1
      logic-not-delete-value: 0

然后,设置全局配置项并在Mapper接口中使用@TableLogic注解:

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 添加乐观锁插件
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

在上述示例中,我们创建了一个@Configuration类,并注册了Mybatis-Plus提供的分页插件(PaginationInterceptor)和乐观锁插件(OptimisticLockerInnerInterceptor)。这些插件可以根据具体需求进行配置。

测试

为了验证逻辑删除功能是否正常工作,我们可以编写单元测试。

以下是一个简单的测试实例:

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class BlogServiceTest {

    @Autowired
    private BlogService blogService;

    @Test
    public void testDeleteBlog() {
        Long blogId = 1L; // 假设要删除ID为1的博客
        boolean result = blogService.deleteBlogById(blogId);
        System.out.println("Delete successful: " + result);
    }
}

在上述测试中,我们注入了BlogService接口,并调用deleteBlogById方法来执行逻辑删除操作。

通过编写和运行这些测试用例,我们可以验证使用逻辑删除功能时的正常性。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • SpringCloud hystrix断路器与局部降级全面介绍

    SpringCloud hystrix断路器与局部降级全面介绍

    什么是服务降级?当服务器压力剧增的情况下,根据实际业务情况及流量,对一些服务和页面有策略的不处理或换种简单的方式处理,从而释放服务器资源以保证核心交易正常运作或高效运作
    2022-10-10
  • SpringMVC配置多个properties文件之通配符解析

    SpringMVC配置多个properties文件之通配符解析

    这篇文章主要介绍了SpringMVC配置多个properties文件之通配符解析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • java执行bat命令碰到的阻塞问题的解决方法

    java执行bat命令碰到的阻塞问题的解决方法

    这篇文章主要介绍了java执行bat命令碰到的阻塞问题的解决方法,有需要的朋友可以参考一下
    2014-01-01
  • SpringBoot拦截器的使用介绍

    SpringBoot拦截器的使用介绍

    大家好,本篇文章主要讲的是SpringBoot拦截器的使用介绍,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下
    2022-01-01
  • Java日常练习题,每天进步一点点(20)

    Java日常练习题,每天进步一点点(20)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-07-07
  • Java操作XML工具类XmlUtil详解

    Java操作XML工具类XmlUtil详解

    这篇文章主要为大家详细介绍了Java操作XML工具类XmlUtil的使用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-12-12
  • Java设计模式之桥梁(Bridge)模式

    Java设计模式之桥梁(Bridge)模式

    这篇文章主要介绍了Java设计模式之桥梁(Bridge)模式,文中有非常详细的代码示例,对正在学习Java设计模式的小伙伴们有很好的帮助,需要的朋友可以参考下
    2021-05-05
  • Java进阶学习:jar打包详解

    Java进阶学习:jar打包详解

    Java进阶学习:jar打包详解...
    2006-12-12
  • 从Springfox到SpringDoc OpenAPI的完整迁移指南

    从Springfox到SpringDoc OpenAPI的完整迁移指南

    在SpringBoot项目中,API文档是前后端协作的重要桥梁,长期以来,Springfox一直是Java生态中最流行的API文档工具之一,但随着SpringBoot版本的迭代,特别是2.6+版本后,Springfox的兼容性问题逐渐显现,所以本文介绍了从Springfox到SpringDoc OpenAPI的完整迁移指南
    2025-08-08
  • Spring MVC的优点与核心接口_动力节点Java学院整理

    Spring MVC的优点与核心接口_动力节点Java学院整理

    这篇文章主要介绍了Spring MVC的优点与核心接口,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08

最新评论