关于spring:Mybatis-plus通用字段自动填充的最佳实践总结

在进行长久层数据保护（新增或批改）的时候，咱们通常须要记录一些非业务字段，比方：create_time、update_time、update_by、create_by 等用来保护数据记录的创立工夫、批改工夫、批改人、创建人等信息。通常状况下咱们须要对这些字段进行手动赋值。赋值的过程也比拟冗余，都是反复操作。

• 通常是为 create_time 赋值为零碎的以后工夫、update_time 赋值为零碎批改操作执行时的以后工夫。
• create_by(创建人)、update_by(批改人)赋值为以后的登录用户的用户名

xxxYyyZzz.setUpdateBy("zimug");    // 数据记录更新操作人
xxxYyyZzz.setUpdateTime(new Date());   // 数据记录更新操作的工夫

Mybatis plus 为咱们提供了一种一劳永逸的自动化赋值形式。

一、调整数据库表构造

以 mysql 数据库环境下的 xxx_yyy_zzz 表为例，在原有的表字段的根底上，增加上面的四个通用数据保护字段。

ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `create_by` VARCHAR(64) NOT NULL COMMENT '本条记录创建人';
ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `create_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '本条记录创立工夫';
ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `update_by` VARCHAR(64) NOT NULL COMMENT '本条记录批改人';
ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `update_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '本条记录的批改工夫';

二、通用保护信息父类 - 主动赋值的字段

既然咱们对某一张表的数据进行新增创立、批改信息的保护，咱们的实体类也要做必要的调整。为了防止为每一个实体类都加上这四个成员变量，咱们定义一个父类 BaseColumns。

@Data
public class BaseColumns {

  /**
   * 本条记录创建人，insert 操作的时候主动为该字段赋值
   */
  @TableField(fill = FieldFill.INSERT 
  private String createBy;

  /**
   * 本条记录创立工夫，insert 操作的时候主动为该字段赋值
   */
  @TableField(fill = FieldFill.INSERT)
  private LocalDateTime  createTime;

  /**
   * 本条记录更新人，insert 或 update 操作的时候主动为该字段赋值，select = false
   */
  @TableField(fill = FieldFill.INSERT_UPDATE,select = false)  
  private String updateBy;

  /**
   * 本条记录更新工夫，insert 或 update 操作的时候主动为该字段赋值，select = false
   */
  @TableField(fill = FieldFill.INSERT_UPDATE,select = false)
  private LocalDateTime updateTime;


}

• fill = FieldFill.INSERT 示意 insert 操作的时候主动为该字段赋值
• fill = FieldFill.INSERT_UPDATE 示意 nsert 或 update 操作的时候主动为该字段赋值
• select = false 示意在应用 Mybatis Wrapper 条件结构器进行查问的时候，不查问这个属性对应的数据库字段。数据批改工夫操作人通常对于运维更有意义，所以通常不须要展现在 web 页面上，所以通常 select 查问的时候不蕴含它。（这个内容与咱们本机的字段主动填充没有太间接的分割，然而在理论利用中是有意义的）

三、实体类的实现

下文实体类 XxxYyyZzz 对应数据库中的 xxx_yyy_zzz 表，除了以上四个通用字段，xxx_yyy_zzz 表还蕴含其余的业务字段。

@Data
@EqualsAndHashCode(callSuper = true)
public class XxxYyyZzz extends BaseColumns {// 其余的属性字段}

四、主动赋值的规定

@Component
public class MybastisColumnsHandler implements MetaObjectHandler {

    @Resource
    private JwtTokenUtil jwtTokenUtil;  // 我的工具类，用于从 Token 令牌中获取登陆人信息

    // 设置数据新增时候的，字段主动赋值规定
    @Override
    public void insertFill(MetaObject metaObject) {this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
      this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());

      this.strictInsertFill(metaObject, "createBy", String.class, jwtTokenUtil.getUsernameFromToken());
      this.strictUpdateFill(metaObject, "updateBy", String.class, jwtTokenUtil.getUsernameFromToken());
    }

    // 设置数据批改 update 时候的，字段主动赋值规定
    @Override
    public void updateFill(MetaObject metaObject) {this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
      this.strictUpdateFill(metaObject, "updateBy", String.class, jwtTokenUtil.getUsernameFromToken());
    }
}

• 在数据新增的时候，主动为 createTime、updateTime、createBy、updateBy 赋值，即数据初始化。
• 在数据批改的时候，主动为 updateTime、updateBy 赋值。
• JwtTokenUtil 是我写的一个工具类，从以后的登录用户 JWT Token 中获取以后登录用户的用户名。（你的零碎外面获取以后登录用户名办法和我的不一样，但总之能够获取到）

五、实现成果

比方在进行数据更新的时候，上面的这两行代码就不须要写了，由 updateFill(MetaObject metaObject) 主动实现

//xxxYyyZzz.setUpdateBy("zimug");    // 数据记录更新操作人
//xxxYyyZzz.setUpdateTime(new Date());   // 数据记录更新操作的工夫

xxxYyyZzzMapper.updateById(xxxYyyZzz);

同理，在数据 insert 操作的时候，insertFill(MetaObject metaObject)将被主动执行。

欢送关注我的博客，外面有很多精品合集

本文转载注明出处（必须带连贯，不能只转文字）：字母哥博客 – zimug.com

感觉对您有帮忙的话，帮我点赞、分享！您的反对是我不竭的创作能源！。另外，笔者最近一段时间输入了如下的精品内容，期待您的关注。

• 《手摸手教你学 Spring Boot2.0》
• 《Spring Security-JWT-OAuth2 一本通》
• 《实战前后端拆散 RBAC 权限管理系统》
• 《实战 SpringCloud 微服务从青铜到王者》
• 《VUE 深入浅出系列》