mybatis-plus 新增/修改如何實現(xiàn)自動填充指定字段
mybatis-plus 新增/修改 自動填充指定字段
1.需要修改的字段在模型類上添加
@TableField(fill = FieldFill.xxx) 注解。
FieldFill的選項:
哪個字段在什么時候填充需要手動設置注解
2.新建一個MetaObjectHandler的實現(xiàn)類
MyMetaObjectHandler
package com.demo.mp.config; 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: zpq * @date: 2020/11/2 2:26 下午 */ @Override public void insertFill(MetaObject metaObject) { // this.setFieldValByName(字段名, 內容, metaObject:用這個對象進行填充用的,稱為元數(shù)據(jù)對象); 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: zpq * @date: 2020/11/2 11:37 上午 */ @Override public void updateFill(MetaObject metaObject) { this.setFieldValByName("updateBy", "admin", metaObject); } }
完成之后就可以使用了
注意:當你設置了邏輯刪除,在邏輯刪除的時候,是不會進行修改填充的,這個需要注意一下。
通用字段自動填充的最佳實踐總結
在進行持久層數(shù)據(jù)維護(新增或修改)的時候,我們通常需要記錄一些非業(yè)務字段,比如:create_time、update_time、update_by、create_by等用來維護數(shù)據(jù)記錄的創(chuàng)建時間、修改時間、修改人、創(chuàng)建人等信息。通常情況下我們需要對這些字段進行手動賦值。賦值的過程也比較冗余,都是重復操作。
- 通常是為create_time賦值為系統(tǒng)的當前時間、update_time賦值為系統(tǒng)修改操作執(zhí)行時的當前時間。
- create_by(創(chuàng)建人)、update_by(修改人)賦值為當前的登錄用戶的用戶名
xxxYyyZzz.setUpdateBy("zimug"); ? ?//數(shù)據(jù)記錄更新操作人 xxxYyyZzz.setUpdateTime(new Date()); ? //數(shù)據(jù)記錄更新操作的時間
Mybatis plus 為我們提供了一種一勞永逸的自動化賦值方式。
一、調整數(shù)據(jù)庫表結構
以mysql數(shù)據(jù)庫環(huán)境下的xxx_yyy_zzz表為例,在原有的表字段的基礎上,添加下面的四個通用數(shù)據(jù)維護字段。
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 '本條記錄的修改時間';
二、通用維護信息父類-自動賦值的字段
既然我們對某一張表的數(shù)據(jù)進行新增創(chuàng)建、修改信息的維護,我們的實體類也要做必要的調整。為了避免為每一個實體類都加上這四個成員變量,我們定義一個父類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條件構造器進行查詢的時候,不查詢這個屬性對應的數(shù)據(jù)庫字段。數(shù)據(jù)修改時間操作人通常對于運維更有意義,所以通常不需要展示在web頁面上,所以通常select查詢的時候不包含它。(這個內容與我們本機的字段自動填充沒有太直接的聯(lián)系,但是在實際應用中是有意義的)
三、實體類的實現(xiàn)
下文實體類XxxYyyZzz對應數(shù)據(jù)庫中的xxx_yyy_zzz表,除了以上四個通用字段,xxx_yyy_zzz表還包含其他的業(yè)務字段。
@Data @EqualsAndHashCode(callSuper = true) public class XxxYyyZzz extends BaseColumns { ? ? //其他的屬性字段 }
四、自動賦值的規(guī)則
@Component public class MybastisColumnsHandler implements MetaObjectHandler { ? ? @Resource ? ? private JwtTokenUtil jwtTokenUtil; ?//我的工具類,用于從Token令牌中獲取登陸人信息 ? ? //設置數(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ù)據(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是我寫的一個工具類,從當前的登錄用戶JWT Token中獲取當前登錄用戶的用戶名。(你的系統(tǒng)里面獲取當前登錄用戶名方法和我的不一樣,但總之可以獲取到)
五、實現(xià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í)行。
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
Elasticsearch 映射參數(shù)詳解 fields
這篇文章主要介紹了fields Elasticsearch 映射參數(shù)fields,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-07-07java 中遍歷取值異常(Hashtable Enumerator)解決辦法
這篇文章主要介紹了java 中遍歷取值異常(Hashtable Enumerator)解決辦法的相關資料,用迭代器取值時拋出的異常:java.util.NoSuchElementException: Hashtable Enumerator ,需要的朋友可以參考下2017-08-08Java web.xml之contextConfigLocation作用案例詳解
這篇文章主要介紹了Java web.xml之contextConfigLocation作用案例詳解,本篇文章通過簡要的案例,講解了該項技術的了解與使用,以下就是詳細內容,需要的朋友可以參考下2021-08-08