自动填充配置类
在一个实体类的字段上使用@TableField(fill = FieldFill.INSERT_UPDATE)注解时,MyBatis-Plus会在执行插入和更新操作时自动调用MetaObjectHandler接口的实现类中相应的insertFill和updateFill方法,以便对注解标记的字段进行自动填充。
实现MetaObjectHandler的示例,记得要加入到@Bean:
public class CreateAndUpdateMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
//根据属性名字设置要填充的值
if (metaObject.hasGetter("createTime")) {
if (metaObject.getValue("createTime") == null) {
this.setFieldValByName("createTime", new Date(), metaObject);
}
}
if (metaObject.hasGetter("createBy")) {
if (metaObject.getValue("createBy") == null) {
this.setFieldValByName("createBy", SecurityUtils.getUsername(), metaObject);
}
}
if (metaObject.hasGetter("updateBy")) {
if (metaObject.getValue("updateBy") == null) {
this.setFieldValByName("updateBy", SecurityUtils.getUsername(), metaObject);
}
}
if (metaObject.hasGetter("updateTime")) {
if (metaObject.getValue("updateTime") == null) {
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
}
@Override
public void updateFill(MetaObject metaObject) {
if (metaObject.hasGetter("updateBy")) {
if (metaObject.getValue("updateBy") == null) {
this.setFieldValByName("updateBy", SecurityUtils.getUsername(), metaObject);
}
}
if (metaObject.hasGetter("updateTime")) {
if (metaObject.getValue("updateTime") == null) {
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
}
}
@Bean
public MetaObjectHandler metaObjectHandler() {
return new CreateAndUpdateMetaObjectHandler();
}
@TableField
配置@TableField(fill = FieldFill.xxx)后,执行插入或者更新时自动执行。
public enum FieldFill {
DEFAULT, 默认
INSERT, 在插入操作时自动填充字段
UPDATE, 在更新操作时自动填充字段
INSERT_UPDATE; 在插入和更新操作时都自动填充字段,执行插入操作时通过insertFill方法填充该字段,以及在执行更新操作时通过updateFill方法填充该字段
private FieldFill() {
}
}
自动填充策略
如FieldFill.INSERT、FieldFill.UPDATE、FieldFill.INSERT_UPDATE确实主要针对更新(UPDATE)和插入(INSERT)SQL操作时有效。这是为了在执行这些操作时自动填充字段,如创建时间、更新时间、创建者和更新者等,减少重复代码并自动化常规任务。
@TableField(fill = FieldFill.UPDATE)与@TableField(exist = false)的区别
当使用@TableField(exist = false)时,这意味着这个字段在数据库表中不存在,因此MyBatis-Plus在生成CRUD SQL语句时会忽略这个字段。这样的字段通常用于业务逻辑需求,比如基于数据库查询结果但不直接存储在数据库中的计算属性。