快捷導(dǎo)航

Mybatis plus通用字段自動(dòng)填充的示例

更新時(shí)間：2021年01月30日 11:38:27 作者：字母哥博客

這篇文章主要介紹了Mybatis plus通用字段自動(dòng)填充的示例，幫助大家更好的理解和使用Mybatis，感興趣的朋友可以了解下

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

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

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

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

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

以mysql數(shù)據(jù)庫環(huán)境下的xxx_yyy_zzz表為例，在原有的表字段的基礎(chǔ)上，添加下面的四個(gè)通用數(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)建時(shí)間';
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 '本條記錄的修改時(shí)間';

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

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

@Data
public class BaseColumns {

 /**
  * 本條記錄創(chuàng)建人，insert操作的時(shí)候自動(dòng)為該字段賦值
  */
 @TableField(fill = FieldFill.INSERT 
 private String createBy;

 /**
  * 本條記錄創(chuàng)建時(shí)間，insert操作的時(shí)候自動(dòng)為該字段賦值
  */
 @TableField(fill = FieldFill.INSERT)
 private LocalDateTime createTime;

 /**
  * 本條記錄更新人，insert或update操作的時(shí)候自動(dòng)為該字段賦值，select = false
  */
 @TableField(fill = FieldFill.INSERT_UPDATE,select = false) 
 private String updateBy;

 /**
  * 本條記錄更新時(shí)間，insert或update操作的時(shí)候自動(dòng)為該字段賦值，select = false
  */
 @TableField(fill = FieldFill.INSERT_UPDATE,select = false)
 private LocalDateTime updateTime;


}

fill = FieldFill.INSERT表示insert操作的時(shí)候自動(dòng)為該字段賦值
fill = FieldFill.INSERT_UPDATE表示nsert或update操作的時(shí)候自動(dòng)為該字段賦值
select = false表示在使用Mybatis Wrapper條件構(gòu)造器進(jìn)行查詢的時(shí)候，不查詢這個(gè)屬性對應(yīng)的數(shù)據(jù)庫字段。數(shù)據(jù)修改時(shí)間操作人通常對于運(yùn)維更有意義，所以通常不需要展示在web頁面上，所以通常select查詢的時(shí)候不包含它。（這個(gè)內(nèi)容與我們本機(jī)的字段自動(dòng)填充沒有太直接的聯(lián)系，但是在實(shí)際應(yīng)用中是有意義的）

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

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

@Data
@EqualsAndHashCode(callSuper = true)
public class XxxYyyZzz extends BaseColumns {

  //其他的屬性字段
}

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

@Component
public class MybastisColumnsHandler implements MetaObjectHandler {

  @Resource
  private JwtTokenUtil jwtTokenUtil; //我的工具類，用于從Token令牌中獲取登陸人信息

  //設(shè)置數(shù)據(jù)新增時(shí)候的，字段自動(dòng)賦值規(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時(shí)候的，字段自動(dòng)賦值規(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ù)新增的時(shí)候，自動(dòng)為createTime、updateTime、createBy、updateBy賦值，即數(shù)據(jù)初始化。
在數(shù)據(jù)修改的時(shí)候，自動(dòng)為updateTime、updateBy賦值。
JwtTokenUtil是我寫的一個(gè)工具類，從當(dāng)前的登錄用戶JWT Token中獲取當(dāng)前登錄用戶的用戶名。（你的系統(tǒng)里面獲取當(dāng)前登錄用戶名方法和我的不一樣，但總之可以獲取到）

五、實(shí)現(xiàn)效果

比如在進(jìn)行數(shù)據(jù)更新的時(shí)候，下面的這兩行代碼就不需要寫了，由updateFill(MetaObject metaObject)自動(dòng)完成

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

xxxYyyZzzMapper.updateById(xxxYyyZzz);

同理，在數(shù)據(jù)insert操作的時(shí)候，insertFill(MetaObject metaObject)將被自動(dòng)執(zhí)行。

原文鏈接：字母哥博客

以上就是Mybatis plus通用字段自動(dòng)填充的示例的詳細(xì)內(nèi)容，更多關(guān)于Mybatis plus通用字段自動(dòng)填充的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: