Mybatis-Plus實現(xiàn)公共字段自動賦值的方法
1 mybatis-plus實現(xiàn)自動填充指定字段
首先了解MetaObjectHandler MetaObjectHandler接口是mybatisPlus為我們提供的的一個擴展接口,我們可以利用這個接口在我們插入或者更新數(shù)據(jù)的時候,為一些字段指定默認(rèn)值。Mybatis plus 為我們提供了一種一勞永逸的自動化賦值方式。
1.1 需要修改的字段在模型類上添加
@TableField(fill = FieldFill.xxx) 注解。
FieldFill的選項:

哪個字段在什么時候填充需要手動設(shè)置注解

1.2 新建一個MetaObjectHandler的實現(xiàn)類
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(字段名, 內(nèi)容, metaObject:用這個對象進(jìn)行填充用的,稱為元數(shù)據(jù)對象);
this.setFieldValByName("createBy", "admin", metaObject);
// ================setFieldValByName 方法內(nèi)的內(nèi)容,有興趣可以進(jìn)去看一看,中文注釋的==================================================
/// **
// * 通用填充
// *
// * @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);
}
}
完成之后就可以使用了
**注意:**當(dāng)你設(shè)置了邏輯刪除,在邏輯刪除的時候,是不會進(jìn)行修改填充的,這個需要注意一下。
2 通用字段自動填充的最佳實踐總結(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("oldlu"); //數(shù)據(jù)記錄更新操作人
xxxYyyZzz.setUpdateTime(new Date()); //數(shù)據(jù)記錄更新操作的時間2.1 調(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 '本條記錄的修改時間';
2.2 通用維護(hù)信息父類-自動賦值的字段
既然我們對某一張表的數(shù)據(jù)進(jìn)行新增創(chuàng)建、修改信息的維護(hù),我們的實體類也要做必要的調(diào)整。為了避免為每一個實體類都加上這四個成員變量,我們定義一個父類BaseColumns。
@Data
public 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ù)修改時間操作人通常對于運維更有意義,所以通常不需要展示在web頁面上,所以通常select查詢的時候不包含它。(這個內(nèi)容與我們本機的字段自動填充沒有太直接的聯(lián)系,但是在實際應(yīng)用中是有意義的)
2.3 實體類的實現(xiàn)
下文實體類XxxYyyZzz對應(yīng)數(shù)據(jù)庫中的xxx_yyy_zzz表,除了以上四個通用字段,xxx_yyy_zzz表還包含其他的業(yè)務(wù)字段。
@Data
@EqualsAndHashCode(callSuper = true)
public class XxxYyyZzz extends BaseColumns {
//其他的屬性字段
}2.4 自動賦值的規(guī)則
@Component
public 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、createBy、updateBy賦值,即數(shù)據(jù)初始化。
在數(shù)據(jù)修改的時候,自動為updateTime、updateBy賦值。
JwtTokenUtil是我寫的一個工具類,從當(dāng)前的登錄用戶JWT Token中獲取當(dāng)前登錄用戶的用戶名。(你的系統(tǒng)里面獲取當(dāng)前登錄用戶名方法和我的不一樣,但總之可以獲取到)
2.5 實現(xiàn)效果
比如在進(jìn)行數(shù)據(jù)更新的時候,下面的這兩行代碼就不需要寫了,由updateFill(MetaObject metaObject)自動完成
//xxxYyyZzz.setUpdateBy("zimug"); //數(shù)據(jù)記錄更新操作人
//xxxYyyZzz.setUpdateTime(new Date()); //數(shù)據(jù)記錄更新操作的時間
xxxYyyZzzMapper.updateById(xxxYyyZzz);
同理,在數(shù)據(jù)insert操作的時候,insertFill(MetaObject metaObject)將被自動執(zhí)行。
到此這篇關(guān)于Mybatis-Plus實現(xiàn)公共字段自動賦值的文章就介紹到這了,更多相關(guān)Mybatis-Plus公共字段自動賦值內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java?SE判斷兩個文件內(nèi)容是否相同的多種方法代碼
昨天因為要幫師兄的忙所以看了一下如何判斷兩個文件內(nèi)容是否相同,這里給大家總結(jié)下,這篇文章主要給大家介紹了關(guān)于Java?SE判斷兩個文件內(nèi)容是否相同的多種方法,需要的朋友可以參考下2023-11-11
Struts1簡介和入門_動力節(jié)點Java學(xué)院整理
這篇文章主要為大家詳細(xì)介紹了Struts1簡介和入門的相關(guān)資料,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-09-09
SpringBoot中DTO/VO/Entity相互轉(zhuǎn)換詳解
在我們平時開發(fā)中,dto、vo、entity之間的相互轉(zhuǎn)換是很頻繁的操作,這篇文章就簡單記錄一下在平時開發(fā)中SpringBoot的轉(zhuǎn)換方法,希望對大家有所幫助2025-01-01
SpringBoot+Druid開啟監(jiān)控頁面的實現(xiàn)示例
本文主要介紹了SpringBoot+Druid開啟監(jiān)控頁面的實現(xiàn)示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2024-06-06

