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方法来执行逻辑删除操作。
通过编写和运行这些测试用例,我们可以验证使用逻辑删除功能时的正常性。
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持代码网。
发表评论