Mybatis-Plus實(shí)現(xiàn)公共字段自動(dòng)賦值的方法
1 mybatis-plus實(shí)現(xiàn)自動(dòng)填充指定字段
首先了解MetaObjectHandler MetaObjectHandler接口是mybatisPlus為我們提供的的一個(gè)擴(kuò)展接口,我們可以利用這個(gè)接口在我們插入或者更新數(shù)據(jù)的時(shí)候,為一些字段指定默認(rèn)值。Mybatis plus 為我們提供了一種一勞永逸的自動(dòng)化賦值方式。
1.1 需要修改的字段在模型類上添加
@TableField(fill = FieldFill.xxx) 注解。
FieldFill的選項(xiàng):
哪個(gè)字段在什么時(shí)候填充需要手動(dòng)設(shè)置注解
1.2 新建一個(gè)MetaObjectHandler的實(shí)現(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: 新增時(shí)填充 * * @auther: oldlu * @date: 2022年7月3日 */ @Override public void insertFill(MetaObject metaObject) { // this.setFieldValByName(字段名, 內(nèi)容, metaObject:用這個(gè)對象進(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: 更新時(shí)填充 * * @auther: oldlu */ @Override public void updateFill(MetaObject metaObject) { this.setFieldValByName("updateBy", "admin", metaObject); } }
完成之后就可以使用了
**注意:**當(dāng)你設(shè)置了邏輯刪除,在邏輯刪除的時(shí)候,是不會(huì)進(jìn)行修改填充的,這個(gè)需要注意一下。
2 通用字段自動(dòng)填充的最佳實(shí)踐總結(jié)
在進(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("oldlu"); //數(shù)據(jù)記錄更新操作人 xxxYyyZzz.setUpdateTime(new Date()); //數(shù)據(jù)記錄更新操作的時(shí)間
2.1 調(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í)間';
2.2 通用維護(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)用中是有意義的)
2.3 實(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 { //其他的屬性字段 }
2.4 自動(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)前登錄用戶名方法和我的不一樣,但總之可以獲取到)
2.5 實(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í)行。
到此這篇關(guān)于Mybatis-Plus實(shí)現(xiàn)公共字段自動(dòng)賦值的文章就介紹到這了,更多相關(guān)Mybatis-Plus公共字段自動(dòng)賦值內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java Swing中的下拉式菜單(menu)、彈出式菜單(JPopupMenu)、選項(xiàng)卡窗體(JTabbedPane)
這篇文章主要介紹了Java Swing中的下拉式菜單(menu)、彈出式菜單(JPopupMenu)、選項(xiàng)卡窗體(JTabbedPane)組件使用案例,需要的朋友可以參考下2014-10-10java hibernate使用注解來定義聯(lián)合主鍵
這篇文章主要介紹了java hibernate使用注解來定義聯(lián)合主鍵的相關(guān)資料,需要的朋友可以參考下2017-01-01windows下java -jar 后臺(tái)運(yùn)行以及殺死后臺(tái)進(jìn)程的操作
這篇文章主要介紹了windows下java -jar 后臺(tái)運(yùn)行以及殺死后臺(tái)進(jìn)程的操作,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12淺談Java動(dòng)態(tài)代理的實(shí)現(xiàn)
最近,小組同事做代碼改造時(shí),使用到了動(dòng)態(tài)代理,自己閱讀時(shí),發(fā)現(xiàn)對代理這種設(shè)計(jì)模式都不怎么清楚,導(dǎo)致理解代碼也很困難 自己唯一能看懂的,大概就是handler中的invoke方法 ,文中作出了非常詳細(xì)的介紹,需要的朋友可以參考下2021-05-05SpringBoot+LayIM+t-io 實(shí)現(xiàn)好友申請通知流程
這篇文章主要介紹了 SpringBoot+LayIM+t-io 實(shí)現(xiàn)好友申請通知流程,本文圖文并茂給大家介紹的非常詳細(xì),需要的朋友可以參考下2017-12-12java Swing組件setBounds()簡單用法實(shí)例分析
這篇文章主要介紹了java Swing組件setBounds()簡單用法,結(jié)合實(shí)例形式分析了Swing組件setBounds()方法的功能與簡單使用方法,需要的朋友可以參考下2017-11-11