MybatisPlus进阶——逻辑删除、通用枚举等
最近没项目了，看了下mybatisplus官网，学到了很多，但是官网没有详细介绍，故此记录下来。
逻辑删除
逻辑删除是指，删除数据库记录的时候，不会真正删除掉记录，而是通过标识来标记记录是否删除。好处是避免误删操作。mybatis-plus也提供了这个功能。
在实体上添加@TableLogic。
@TableLogic
private Integer isDelete;
之后我们可以通过BaseMapper的继承类操作时，deleteById操作执行的sql就不会是delete语句，而是update语句。
在数据的唯一性校验的时候，可以设置isDelete和业务上唯一性字段来确保数据库的记录的唯一性。
同时配置文件还需要添加一下配置
mybatis-plus:
global-config:
db-config:
logic-delete-value: 'NULL' #删除对应的值
logic-not-delete-value: 1 #未删除对应的值
当我们通过delete*方法删除数据的时候，会将isDelete属性给为配置的两种值。
不仅如此到我们用BaseMapper的查询方法会自动添加isDelete属性。
通用枚举
之前学习过就不多说了，连接在此
字段类型处理器
当我们某个字段存的是一个对象的json字符串的时候可以使用，如下
@Column(type = MySqlTypeConstant.VARCHAR,length = 50)
private Son son;
// 表头上需添加
// @TableName(autoResultMap = true)否则反序列化的时候，字段会是空值
自动填充功能
当通过basemapper插入数据的时候，我们可以通过配置给实体属性起到一种设置预设值的效果。
// 实体添加注解
/**
fill属性值代表填充策略，是插入还是更新还是两者都有
insertStrategy代表的是填充策略，当实体的存在值得时候，覆不覆盖原有属性值
**/
@TableField(fill = FieldFill.INSERT,insertStrategy = FieldStrategy.IGNORED)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE,updateStrategy = FieldStrategy.IGNORED)
private Date updateTime;
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ....");
this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
// 或者
this.strictInsertFill(metaObject, "createTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
// 或者
this.fillStrategy(metaObject, "createTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug)
}
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill ....");
this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐)
// 或者
this.strictUpdateFill(metaObject, "updateTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
// 或者
this.fillStrategy(metaObject, "updateTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug)
}
}
注意事项：
- 填充原理是直接给
entity的属性设置值!!! - 注解则是指定该属性在对应情况下必有值,如果无值则入库会是
null MetaObjectHandler提供的默认方法的策略均为:如果属性有值则不覆盖,如果填充值为null则不填充- 字段必须声明
TableField注解,属性fill选择对应策略,该声明告知Mybatis-Plus需要预留注入SQL字段 - 填充处理器
MyMetaObjectHandler在 Spring Boot 中需要声明@Component或@Bean注入 - 要想根据注解
FieldFill.xxx和字段名以及字段类型来区分必须使用父类的strictInsertFill或者strictUpdateFill方法 - 不需要根据任何来区分可以使用父类的
fillStrategy方法 - update(T t,Wrapper updateWrapper)时t不能为空,否则自动填充失效
插件
mybatisplus常用插件的使用
@Configuration
@MapperScan("scan.your.mapper.package")
public class MybatisPlusConfig {
/**
* 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
/**
* 分页配置
*/
mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
/**
* 乐观锁配置， 与@Version注解联合使用
*/
mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return mybatisPlusInterceptor;
}
@Bean
public ConfigurationCustomizer configurationCustomizer() {
return configuration -> configuration.setUseDeprecatedExecutor(false);
}
}
分页插件
我们在日常编程中分页操作是不可或缺的，配置分页后可以通过baseMapper的分页方法可以直接获取分页对象，但是当我们经常是要自己写sql，而mp不能自动代理我们手写的sql分页。我们通过接口添加分页参数来达到所要的效果
List<UserVo> selectPageVo(IPage<UserVo> page, Integer state);
乐观锁插件
当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：
- 取出记录时，获取当前 version
- 更新时，带上这个 version
- 执行更新时， set version = newVersion where version = oldVersion
- 如果 version 不对，就更新失败
代码操作如下：
@Version
private Integer version;
只能通过实体update操作的时候，才可以完成乐观锁的效果，只穿query对象是无效的， 并且update(entity, wrapper) 方法下, wrapper 不能复用!!!
mp官网连接
