Mybatis plus通用欄位自動填充的最佳實踐總結

2021 年 1 月 27 日
筆記

在進行持久層數據維護（新增或修改）的時候，我們通常需要記錄一些非業務欄位，比如：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)將被自動執行。

歡迎關注我的部落格，裡面有很多精品合集

本文轉載註明出處（必須帶連接，不能只轉文字）：字母哥部落格。

覺得對您有幫助的話，幫我點贊、分享！您的支援是我不竭的創作動力！ 。另外，筆者最近一段時間輸出了如下的精品內容，期待您的關注。