Mybatis plus通用字段自动填充的最佳实践总结
Mybatis plus通用字段自動填充的最佳實踐總結
在進行持久層數據維護(新增或修改)的時候,我們通常需要記錄一些非業(yè)務字段,比如 :create_time 、update_time 、update_by、create_by等用來維護數據記錄的創(chuàng)建時間 、修改時間、修改人、創(chuàng)建人等信息。通常情況下我們需要對這些字段進行手動賦值。賦值的過程也比較冗余,都是重復操作。
- 通常是為create_time賦值為系統(tǒng)的當前時間、update_time賦值為系統(tǒng)修改操作執(zhí)行時的當前時間 。
- create_by(創(chuàng)建人)、update_by(修改人)賦值為當前的登錄用戶的用戶名
xxxYyyZzz.setUpdateBy("zimug"); //數據記錄更新操作人xxxYyyZzz.setUpdateTime(new Date()); //數據記錄更新操作的時間Mybatis plus 為我們提供了一種一勞永逸的自動化賦值方式。
一、調整數據庫表結構
以mysql數據庫環(huán)境下的xxx_yyy_zzz表為例 ,在原有的表字段的基礎上,添加下面的四個通用數據維護字段。
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 '本條記錄的修改時間';二、通用維護信息父類-自動賦值的字段
既然我們對某一張表的數據進行新增創(chuàng)建、修改信息的維護 ,我們的實體類也要做必要的調整。為了避免為每一個實體類都加上這四個成員變量,我們定義一個父類BaseColumns。
@Datapublic 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條件構造器進行查詢的時候,不查詢這個屬性對應的數據庫字段