Mybatis-Plus實現公共欄位自動賦值的方法

2022-07-04 22:00:50

1 mybatis-plus實現自動填充指定欄位

首先了解MetaObjectHandler MetaObjectHandler介面是mybatisPlus為我們提供的的一個擴充套件介面，我們可以利用這個介面在我們插入或者更新資料的時候，為一些欄位指定預設值。Mybatis plus 為我們提供了一種一勞永逸的自動化賦值方式。

1.1 需要修改的欄位在模型類上新增

@TableField(fill = FieldFill.xxx) 註解。

FieldFill的選項：

哪個欄位在什麼時候填充需要手動設定註解

1.2 新建一個MetaObjectHandler的實現類

MyMetaObjectHandler

package com.oldlu;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Objects;
@Component // 注入bean
public class MyMetaObjectHandler implements MetaObjectHandler {
  /**
   * @Description: 新增時填充
   *
   * @auther: oldlu
   * @date: 2022年7月3日
   */
  @Override
  public void insertFill(MetaObject metaObject) {
    // this.setFieldValByName(欄位名, 內容, metaObject：用這個物件進行填充用的，稱為後設資料物件);
    this.setFieldValByName("createBy", "admin", metaObject);
    // ================setFieldValByName 方法內的內容，有興趣可以進去看一看，中文註釋的==================================================
    /// **
    // * 通用填充
    // *
    // * @param fieldName  java bean property name
    // * @param fieldVal   java bean property value
    // * @param metaObject meta object parameter
    // */
    // default MetaObjectHandler setFieldValByName(String fieldName, Object fieldVal, MetaObject
    // metaObject) {
    //  if (Objects.nonNull(fieldVal) && metaObject.hasSetter(fieldName)) {
    //    metaObject.setValue(fieldName, fieldVal);
    //  }
    //  return this;
    // }
  }
  /**
   * * @Description: 更新時填充
   *
   * @auther: oldlu
   */
  @Override
  public void updateFill(MetaObject metaObject) {
    this.setFieldValByName("updateBy", "admin", metaObject);
  }
}

完成之後就可以使用了

**注意：**當你設定了邏輯刪除，在邏輯刪除的時候，是不會進行修改填充的，這個需要注意一下。

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

在進行持久層資料維護（新增或修改）的時候，我們通常需要記錄一些非業務欄位，比如：create_time、update_time、update_by、create_by等用來維護資料記錄的建立時間、修改時間、修改人、建立人等資訊。通常情況下我們需要對這些欄位進行手動賦值。賦值的過程也比較冗餘，都是重複操作。

通常是為create_time賦值為系統的當前時間、update_time賦值為系統修改操作執行時的當前時間。
create_by(建立人)、update_by(修改人)賦值為當前的登入使用者的使用者名稱

xxxYyyZzz.setUpdateBy("oldlu");    //資料記錄更新操作人
xxxYyyZzz.setUpdateTime(new Date());   //資料記錄更新操作的時間

2.1 調整資料庫表結構

以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 '本條記錄的修改時間';

2.2 通用維護資訊父類別-自動賦值的欄位

既然我們對某一張表的資料進行新增建立、修改資訊的維護，我們的實體類也要做必要的調整。為了避免為每一個實體類都加上這四個成員變數，我們定義一個父類別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查詢的時候不包含它。（這個內容與我們本機的欄位自動填充沒有太直接的聯絡，但是在實際應用中是有意義的）

2.3 實體類的實現

下文實體類XxxYyyZzz對應資料庫中的xxx_yyy_zzz表，除了以上四個通用欄位，xxx_yyy_zzz表還包含其他的業務欄位。

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

2.4 自動賦值的規則

@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中獲取當前登入使用者的使用者名稱。（你的系統裡面獲取當前登入使用者名稱方法和我的不一樣，但總之可以獲取到）

2.5 實現效果

比如在進行資料更新的時候，下面的這兩行程式碼就不需要寫了，由updateFill(MetaObject metaObject)自動完成

//xxxYyyZzz.setUpdateBy("zimug");    //資料記錄更新操作人
//xxxYyyZzz.setUpdateTime(new Date());   //資料記錄更新操作的時間
xxxYyyZzzMapper.updateById(xxxYyyZzz);

同理，在資料insert操作的時候，insertFill(MetaObject metaObject)將被自動執行。

到此這篇關於Mybatis-Plus實現公共欄位自動賦值的文章就介紹到這了,更多相關Mybatis-Plus公共欄位自動賦值內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！