MyBatis-Plus实现字段自动填充功能的示例
作者：郑清
本文主要介绍了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<User> {
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<T extends Model> 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 注入
/**
* <p> MyBatisPlus自定义字段自动填充处理类 - 实体类中使用 @TableField注解 </p>
*
* @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！
到此这篇关于MyBatis-Plus实现字段自动填充功能的示例的文章就介绍到这了,更多相关MyBatis-Plus 字段自动填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！