1 问题背景
在开发中,我们经常会有逻辑删除和唯一索引同时使用的情况。但当使用mybatis plus时,如果同时使用逻辑删除和唯一索引,会报数据重复Duplicate entry的问题。
举例来说,有表user,建立唯一索引(user_name,is_del)
CREATE TABLE `user` (
`id` bigint(11) unsigned NOT NULL AUTO_INCREMENT COMMENT 'Id',
`user_name` varchar(64) DEFAULT NULL COMMENT '用户名',
`is_del` bigint(13) DEFAULT '0' COMMENT '逻辑删除标识',
PRIMARY KEY (`id`),
UNIQUE KEY `unique_user_name` (`user_name`)
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8mb4;
如果我们插入一条数据user_name=‘zhangsan’的数据,然后再删除它,这时数据表中存在一条记录,如下图:
这时如果再插入一条’zhangsan’,虽然之前的一条记录已经被逻辑删除,但是唯一索引只建在了user_name上,所以这时会报数据重复的错误
2 第一次改进
我们把唯一索引的组合增加is_del字段
ALTER TABLE `user`
ADD UNIQUE KEY `unique_user_name_is_del` (`user_name`,`is_del`)
这下可以再次插入’zhangsan’这条数据,插入后如下图
但是如果第二次删除’zhangsan’,则还是会报错,因为已经有一条[‘zhangsan’,1]的数据,当程序想把另一条’zhangsan’的is_del字段值为1时,会因为数据重复失败!
3 第二次改进
此时应该如何改进呢,可以在user表中增加一个del_version字段,用来把已经删除的数据加上版本号,然后将这个字段也加入唯一索引中
CREATE TABLE `user` (
`id` bigint(11) unsigned NOT NULL AUTO_INCREMENT COMMENT 'Id',
`user_name` varchar(64) DEFAULT NULL COMMENT '用户名',
`del_version` bigint(11) DEFAULT '0' COMMENT '版本标识,用于逻辑删除',
`is_del` bigint(13) DEFAULT '0' COMMENT '逻辑删除标识',
PRIMARY KEY (`id`),
UNIQUE KEY `unique_user_name_is_del_del_version` (`user_name`,`is_del`,`del_version`)
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8mb4;
未删除的数据del_version=0,已删除的数据del_version修改成这条记录的id(自增id全局唯一),这样既可以保证无法多次插入同名的数据,又可以满足数据可以多次删除的情况
例如,我们两次删除同样数据后,再重新插入,这时数据表中的数据如下:
4 代码解决方案
我们使用mybatis plus提供的工具生成代码,这时所有的service层接口都会继承 IService 这个接口,这个接口有很多默认方法,实现了对数据库的操作。
我们的思路是,新建一个IBaseService接口,继承IService接口。在这个IBaseService接口中,重写所有和删除相关的方法,在其中设置【del_version】=【自增id】。而原来的所有service层接口,不再继承IService,而是继承我们新的IBaseService。
这样就解决了逻辑删除和唯一索引共用的问题,IBaseService具体代码如下:
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.extension.service.IService;
import com.baomidou.mybatisplus.extension.toolkit.SqlHelper;
import org.apache.commons.collections.CollectionUtils;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
* 逻辑删除前先更新版本号
* @author wuKeFan
* @date 2023-04-10 16:10:39
*/
public interface IBaseService<T extends BaseDO> extends IService<T> {
/**
* 根据 ID 删除
*
* @param id 主键ID
*/
@Override
default boolean removeById(Serializable id) {
T objDO = getBaseMapper().selectById(id);
return beforeDelete(objDO) && SqlHelper.retBool(getBaseMapper().deleteById(id));
}
/**
* 删除对象前,先修改其版本号
* @param objDO 基础类对象
* @return 返回是否成功
*/
default boolean beforeDelete(T objDO) {
if (Objects.isNull(objDO)) {
return false;
}
// 逻辑删除前先更新版本号
objDO.setDelVersion(objDO.getId());
return SqlHelper.retBool(getBaseMapper().updateById(objDO));
}
/**
* 根据 columnMap 条件,删除记录
*
* @param columnMap 表字段 map 对象
*/
@Override
default boolean removeByMap(Map<String, Object> columnMap) {
throw new RuntimeException("不支持的数据库删除操作");
}
/**
* 根据 entity 条件,删除记录
*
* @param queryWrapper 实体包装类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
@Override
default boolean remove(Wrapper<T> queryWrapper) {
List<T> objDOS = getBaseMapper().selectList(queryWrapper);
if (CollectionUtils.isNotEmpty(objDOS)) {
objDOS.forEach(this::beforeDelete);
}
return SqlHelper.retBool(getBaseMapper().delete(queryWrapper));
}
/**
* 删除(根据ID 批量删除)
*
* @param idList 主键ID列表
*/
@Override
default boolean removeByIds(Collection<? extends Serializable> idList) {
if (CollectionUtils.isEmpty(idList)) {
return false;
}
List<T> objDOS = getBaseMapper().selectBatchIds(idList);
if (CollectionUtils.isNotEmpty(objDOS)) {
objDOS.forEach(this::beforeDelete);
}
return SqlHelper.retBool(getBaseMapper().deleteBatchIds(idList));
}
}
基础类BaseDO具体代码如下:
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.Data;
import java.io.Serializable;
/**
* @author wuKeFan
* @date 2023-04-10 16:11:25
*/
@Data
public class BaseDO implements Serializable {
@TableId(type = IdType.AUTO)
private Integer id;
private Integer isDel;
private Integer delVersion;
}