MyBatis-Plus自动填充字段

前文概要：《MyBatis-Plus使用入门》

在实际开发场景中，我们会在业务表中加入审计字段，主要就是created_by、created_date、update_by、update_date，用来记录数据的创建和更新信息。一般有如下三种方式：

• 数据库DDL在设计表的时候，给这些审计字段加上默认值，指定当前时间函数CURRENT_TIMESTAMP（不推荐）；
• 在插入和更新数据的时候，参数中带上这些审计字段（较繁琐）；
• 使用MyBatis-Plus的自动填充字段功能。

这里主要讲解第三种方式，首先我们需要在实体类加上这些审计字段，和对应的自动填充注解标识。

// 审计字段
@TableField(fill = FieldFill.INSERT)
private String createBy;
@TableField(fill = FieldFill.INSERT)
private Date createDate;
@TableField(fill = FieldFill.INSERT_UPDATE)
private String updateBy;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateDate;

其中FieldFill的枚举值如下：

public enum FieldFill {
    /**
     * 默认不处理
     */
    DEFAULT,
    /**
     * 插入时填充字段
     */
    INSERT,
    /**
     * 更新时填充字段
     */
    UPDATE,
    /**
     * 插入和更新时填充字段
     */
    INSERT_UPDATE
}

然后，我们需要指定审计字段的填充规则：

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    private static final String DEFAULT_OPERATOR = "System";

    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createBy", DEFAULT_OPERATOR, metaObject);
        this.setFieldValByName("createDate", new Date(), metaObject);
        this.setFieldValByName("updateBy", DEFAULT_OPERATOR, metaObject);
        this.setFieldValByName("updateDate", new Date(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateBy", DEFAULT_OPERATOR, metaObject);
        this.setFieldValByName("updateDate", new Date(), metaObject);
    }
}

最后，我们需要为数据库表增加这些审计字段：

ALTER TABLE zhangxun.zx_user ADD create_by varchar(100) NULL;
ALTER TABLE zhangxun.zx_user ADD create_date DATETIME NULL;
ALTER TABLE zhangxun.zx_user ADD update_by varchar(100) NULL;
ALTER TABLE zhangxun.zx_user ADD update_date DATETIME NULL;

此时，我们使用前面的例子进行插入或者更新数据时，都可以自动更新审计字段了，非常方便。