MyBatis-Plus - 实现字段自动填充功能
一、前言
在项目中，我们有一些公共的字段需要做修改。如：
- gmt_create：创建时间
- creator_id：创建人
- gmt_modified：修改时间
- modifier_id：修改人
这时候我们可以采用 MyBatis-Plus 中的字段自动填充功能去实现
思路：抽取公用字段封装到BaseEntity类中，再将使用到此公共字段的类继承基类，最后由 MyBatis-Plus 帮我们实现自动填充，这样我们便可以在service服务类中减少一定代码重复量！
二、实现
1. 实体类
@Data
@TableName("t_user")
public class User extends BaseEntity {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.AUTO)
private Integer id;
@TableField("username")
private String username;
@Override
protected Serializable pkVal() {
return this.id;
}
} 2. 公用字段 - 使用注解填充字段，如：@TableField(fill = FieldFill.INSERT)
@Getter
@Setter
public abstract class BaseEntity extends Model {
/**
* 创建日期 - 现在时表示主动创建
*/
@TableField(value = "gmt_create", fill = FieldFill.INSERT)
private Date gmtCreate;
/**
* 修改时间 - 过去分词表示被动更新
*/
@TableField(value = "gmt_modified", fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;
} Ctrl 选中FieldFill进入源码可查看相应字段填充策略枚举类，如下：
public enum FieldFill {
DEFAULT(0, "默认不处理"),
INSERT(1, "插入填充字段"),
UPDATE(2, "更新填充字段"),
INSERT_UPDATE(3, "插入和更新填充字段");
/**
* 主键
*/
private final int key;
/**
* 描述
*/
private final String desc;
FieldFill(final int key, final String desc) {
this.key = key;
this.desc = desc;
}
public static FieldFill getIgnore(int key) {
FieldFill[] fis = FieldFill.values();
for (FieldFill fi : fis) {
if (fi.getKey() == key) {
return fi;
}
}
return FieldFill.DEFAULT;
}
public int getKey() {
return this.key;
}
public String getDesc() {
return this.desc;
}
}3. 自定义MyMetaObjectHandler字段自动填充处理类继承MetaObjectHandler
- 注：在 Spring Boot 中需要声明 @Component 注入
/**
* MyBatisPlus自定义字段自动填充处理类 - 实体类中使用 @TableField注解
*
* @description: 注意前端传值时要为null
* @author: zhengqing
* @date: 2019/8/18 0018 1:46
*/
@Component
public class MyMetaObjectHandler extends MetaObjectHandler {
private static final Logger LOG = LoggerFactory.getLogger(MyMetaObjectHandler.class);
/**
* 创建时间
*/
@Override
public void insertFill(MetaObject metaObject) {
LOG.info(" -------------------- start insert fill ... --------------------");
if (metaObject.hasGetter("gmtCreate") && metaObject.hasGetter("gmtModified")) {
setFieldValByName("gmtCreate", new Date(), metaObject);
setFieldValByName("gmtModified", new Date(), metaObject);
}
}
/**
* 最后一次更新时间
*/
@Override
public void updateFill(MetaObject metaObject) {
LOG.info(" -------------------- start update fill ... --------------------");
if (metaObject.hasGetter("et.gmtModified")) {
setFieldValByName("gmtModified", new Date(), metaObject);
}
}
}
温馨小提示
我们在更新字段的时候要使用 et.字段名 或者 param1.字段 才会生效！
原因：我们可以debug模式查看metaObject中的属性发现多了et
或者查看继承的BaseMapper类源码，我们也可以发现更新的方法中都有et
而插入的方法并没有et
另外一个注意点就是，自动填充是在执行完插入或更新方法之后，也就是说，MyBatis-Plus会在方法之后判断@TableField注解的字段有没有被手动更新，如果没有才会走自定义的实现类MyMetaObjectHandler！
补充（不同实体类“表名_createTime”）
自动判断解决方案
package com.chinadaas.platform.common.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.binding.MapperMethod;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.lang.reflect.Field;
import java.time.LocalDateTime;
import java.util.Objects;
/**
* @author Lux Sun
* @date 2020/6/16
*/
@Component
public class DspMetaObjectHandler implements MetaObjectHandler {
private String getClassLikeFieldName(MetaObject metaObject, String likeStr) {
Field[] fields;
if (metaObject.hasSetter("et") && metaObject.hasSetter("param1")) { // update case
fields = ((MapperMethod.ParamMap)metaObject.getOriginalObject()).get("et").getClass().getDeclaredFields();
}
else { // insert case
fields = metaObject.getOriginalObject().getClass().getDeclaredFields();
}
for (int i=0; i