深入解析MyBatis-Plus中的逻辑删除功能及实例
介绍:
在实际开发中,数据的删除操作是一个常见需求。MyBatis-Plus提供了方便且灵活的逻辑删除功能,可以简化开发人员在删除数据时的操作。本文将详细讲解MyBatis-Plus中的逻辑删除特性,并结合实际案例进行演示和说明。
案例背景
假设我们有一个博客系统,包含Blog类作为博客实体。在这个系统中,我们希望能够对博客进行软删除操作,即将要删除的博客标记为已删除状态,而不是直接物理删除。通过逻辑删除,我们可以保留删除记录,有助于追踪数据变更历史和实现审计需求。
使用逻辑删除功能
配置数据库和实体类
首先,在使用逻辑删除功能之前,我们需要进行相关的配置。
- 在数据库表中,我们需要添加一个用于表示逻辑删除状态的字段。例如,我们可以添加一个名为deleted的tinyint类型字段,默认值为0。
- 在实体类(这里是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方法来执行逻辑删除操作。
通过编写和运行这些测试用例,我们可以验证使用逻辑删除功能时的正常性。
如果大家觉得有用的话,可以关注我下面的微信公众号,极客李华,我会在里面更新更多行业资讯,企业面试内容,编程资源,如何写出可以让大厂面试官眼前一亮的简历等内容,让大家更好学习编程,我的抖音,B站也叫极客李华。大家喜欢也可以关注一下