Mybatis plus通用字段自動填充的最佳實踐總結(jié)

在進(jìn)行持久層數(shù)據(jù)維護(hù)（新增或修改）的時候，我們通常需要記錄一些非業(yè)務(wù)字段，比如
：create_time、update_time、update_by 
、create_by等用來維護(hù)數(shù)據(jù)記錄的創(chuàng)建時間
、修改時間、修改人 、創(chuàng)建人等信息。通常情況下我們需要對這些字段進(jìn)行手動賦值。賦值的過程也比較冗余
，都是重復(fù)操作。

• 通常是為create_time賦值為系統(tǒng)的當(dāng)前時間 、update_time賦值為系統(tǒng)修改操作執(zhí)行時的當(dāng)前時間。
• create_by(創(chuàng)建人)、update_by(修改人)賦值為當(dāng)前的登錄用戶的用戶名

xxxYyyZzz.setUpdateBy("zimug");    //數(shù)據(jù)記錄更新操作人xxxYyyZzz.setUpdateTime(new Date());   //數(shù)據(jù)記錄更新操作的時間

Mybatis plus 為我們提供了一種一勞永逸的自動化賦值方式
。

一 、調(diào)整數(shù)據(jù)庫表結(jié)構(gòu)

以mysql數(shù)據(jù)庫環(huán)境下的xxx_yyy_zzz表為例 ，在原有的表字段的基礎(chǔ)上，添加下面的四個通用數(shù)據(jù)維護(hù)字段 。

ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `create_by` VARCHAR(64) NOT NULL COMMENT '本條記錄創(chuàng)建人';ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `create_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '本條記錄創(chuàng)建時間';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 '本條記錄的修改時間';

二
、通用維護(hù)信息父類-自動賦值的字段

既然我們對某一張表的數(shù)據(jù)進(jìn)行新增創(chuàng)建、修改信息的維護(hù)，我們的實體類也要做必要的調(diào)整
。為了避免為每一個實體類都加上這四個成員變量，我們定義一個父類BaseColumns 。

@Datapublic class BaseColumns {   /**   * 本條記錄創(chuàng)建人，insert操作的時候自動為該字段賦值   */  @TableField(fill = FieldFill.INSERT   private String createBy;  /**   * 本條記錄創(chuàng)建時間，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條件構(gòu)造器進(jìn)行查詢的時候，不查詢這個屬性對應(yīng)的數(shù)據(jù)庫字段。數(shù)據(jù)修改時間操作人通常對于運(yùn)維更有意義，所以通常不需要展示在web頁面上 ，所以通常select查詢的時候不包含它 。（這個內(nèi)容與我們本機(jī)的字段自動填充沒有太直接的聯(lián)系 ，但是在實際應(yīng)用中是有意義的）

三、實體類的實現(xiàn)

下文實體類XxxYyyZzz對應(yīng)數(shù)據(jù)庫中的xxx_yyy_zzz表，除了以上四個通用字段 ，xxx_yyy_zzz表還包含其他的業(yè)務(wù)字段 。

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

四、自動賦值的規(guī)則

@Componentpublic class MybastisColumnsHandler implements MetaObjectHandler {     @Resource    private JwtTokenUtil jwtTokenUtil;  //我的工具類，用于從Token令牌中獲取登陸人信息    //設(shè)置數(shù)據(jù)新增時候的，字段自動賦值規(guī)則    @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());    }    //設(shè)置數(shù)據(jù)修改update時候的
，字段自動賦值規(guī)則    @Override    public void updateFill(MetaObject metaObject) {       this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());      this.strictUpdateFill(metaObject, "updateBy", String.class, jwtTokenUtil.getUsernameFromToken());    }}

• 在數(shù)據(jù)新增的時候，自動為createTime 、updateTime