Mybatis-Plus實現公共字段自動賦值的方法

Posted on by

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公共字段自動賦值內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：