MyBatisPlus實(shí)現(xiàn)自動(dòng)填充字段的實(shí)踐
MyBatis-Plus 提供了一個(gè)便捷的自動(dòng)填充功能,用于在插入或更新數(shù)據(jù)時(shí)自動(dòng)填充某些字段,如創(chuàng)建時(shí)間、更新時(shí)間等。以下是如何使用這一功能的詳細(xì)說明。
自動(dòng)填充功能通過實(shí)現(xiàn) com.baomidou.mybatisplus.core.handlers.MetaObjectHandler 接口來實(shí)現(xiàn)。你需要?jiǎng)?chuàng)建一個(gè)類來實(shí)現(xiàn)這個(gè)接口,并在其中定義插入和更新時(shí)的填充邏輯。
【實(shí)例】使用 MyBatis-Plus 的自動(dòng)填充字段功能,實(shí)現(xiàn)為數(shù)據(jù)表自動(dòng)填充:create_time 和 update_time 字段。
1、創(chuàng)建數(shù)據(jù)表
在 MySQL 數(shù)據(jù)庫中創(chuàng)建用戶信息表(tb_user)。
-- 創(chuàng)建數(shù)據(jù)庫 CREATE DATABASE IF NOT EXISTS db_admin; -- 使用數(shù)據(jù)庫 USE db_admin; -- 判斷數(shù)據(jù)表是否存在,存在則刪除 DROP TABLE IF EXISTS tb_user; -- 創(chuàng)建“用戶信息”數(shù)據(jù)表 CREATE TABLE IF NOT EXISTS tb_user ( user_id BIGINT(20) AUTO_INCREMENT PRIMARY KEY COMMENT '用戶編號(hào)', user_account VARCHAR(50) NOT NULL COMMENT '用戶賬號(hào)', user_password VARCHAR(50) NOT NULL COMMENT '用戶密碼', blog_name VARCHAR(50) COMMENT '博客信息', blog_url VARCHAR(50) NOT NULL COMMENT '博客地址', create_time TIMESTAMP DEFAULT NULL COMMENT '創(chuàng)建時(shí)間', update_time TIMESTAMP DEFAULT NULL COMMENT '最后修改時(shí)間' ) COMMENT = '用戶信息表';
2、定義實(shí)體類
在實(shí)體類中,必須使用 @TableField 注解來標(biāo)記哪些字段需要自動(dòng)填充,并指定填充的策略。
在 entity 包中,創(chuàng)建 UserInfo 類(用戶信息實(shí)體類)。
package com.pjb.pm.entity;
import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import java.time.LocalDateTime;
/**
* 用戶信息實(shí)體類
* @author pan_junbiao
**/
@Data
@TableName("tb_user") //設(shè)置數(shù)據(jù)表名
public class UserInfo
{
// 忽略其他字段...
/**
* 創(chuàng)建時(shí)間
*/
@TableField(fill = FieldFill.INSERT) //填充策略:插入填充字段
private LocalDateTime createTime;
/**
* 最后修改時(shí)間
*/
@TableField(fill = FieldFill.INSERT_UPDATE) //填充策略:插入和更新填充字段
private LocalDateTime updateTime;
}FieldFill 枚舉:
public enum FieldFill {
DEFAULT, // 默認(rèn)不處理
INSERT, // 插入填充字段
UPDATE, // 更新填充字段
INSERT_UPDATE // 插入和更新填充字段
}3、實(shí)現(xiàn) MetaObjectHandler 接口
創(chuàng)建一個(gè)類來實(shí)現(xiàn) MetaObjectHandler 接口,并重寫 insertFill 和 updateFill 方法。
在 handler 包中,創(chuàng)建 MyMetaObjectHandler 類(MyBatis-plus自動(dòng)填充字段處理類)。
package com.pjb.pm.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.util.Objects;
import java.util.function.Supplier;
/**
* MyBatis-plus自動(dòng)填充字段處理類
* @author pan_junbiao
**/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler
{
/**
* 新增操作:執(zhí)行自動(dòng)填充
*/
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
}
/**
* 修改操作:執(zhí)行自動(dòng)填充
*/
@Override
public void updateFill(MetaObject metaObject) {
this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
}
/**
* 強(qiáng)制填充
* 官方原文:MetaObjectHandler 提供的默認(rèn)方法策略是:如果屬性有值則不覆蓋,如果填充值為 null 則不填充
* 所以這里修改策略方法,去掉屬性為 null 的判斷,實(shí)現(xiàn)強(qiáng)制填充
*/
@Override
public MetaObjectHandler strictFillStrategy(MetaObject metaObject, String fieldName, Supplier<?> fieldVal) {
Object obj = fieldVal.get();
if (Objects.nonNull(obj)) {
metaObject.setValue(fieldName, obj);
}
return this;
}
}注意:
確保 MyMetaObjectHandler 類被 Spring 管理,可以通過 @Component 或 @Bean 注解來實(shí)現(xiàn)。
4、注意事項(xiàng)
- 自動(dòng)填充是直接給實(shí)體類的屬性設(shè)置值。
- 如果屬性沒有值,入庫時(shí)會(huì)是 null。
- MetaObjectHandler 提供的默認(rèn)方法策略是:如果屬性有值則不覆蓋,如果填充值為 null 則不填充。
- 字段必須聲明 @TableField 注解,并設(shè)置 fill 屬性來選擇填充策略。
- 填充處理器需要在 Spring Boot 中聲明為 @Component 或 @Bean。
- 使用 strictInsertFill 或 strictUpdateFill 方法可以根據(jù)注解 FieldFill.xxx、字段名和字段類型來區(qū)分填充邏輯。
- 如果不需區(qū)分,可以使用 fillStrategy 方法。
- 在 update(T entity, Wrapper<T> updateWrapper) 時(shí),entity 不能為空,否則自動(dòng)填充失效。
- 在 update(Wrapper<T> updateWrapper) 時(shí)不會(huì)自動(dòng)填充,需要手動(dòng)賦值字段條件。
到此這篇關(guān)于MyBatisPlus實(shí)現(xiàn)自動(dòng)填充字段的實(shí)踐的文章就介紹到這了,更多相關(guān)MyBatisPlus 自動(dòng)填充字段內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- MybatisPlus自動(dòng)填充時(shí)間的配置類實(shí)現(xiàn)
- mybatisplus實(shí)現(xiàn)自動(dòng)填充時(shí)間的項(xiàng)目實(shí)踐
- MybatisPlus自動(dòng)填充創(chuàng)建(更新)時(shí)間問題
- mybatisplus自動(dòng)填充屬性值的實(shí)現(xiàn)步驟
- mybatisPlus自動(dòng)填充更新時(shí)間的示例代碼
- Mybatisplus自動(dòng)填充實(shí)現(xiàn)方式及代碼示例
- MybatisPlus 自動(dòng)填充的實(shí)現(xiàn)
- MybatisPlus字段自動(dòng)填充&樂觀鎖的方法實(shí)現(xiàn)
相關(guān)文章
關(guān)于@Query注解的用法(Spring Data JPA)
這篇文章主要介紹了關(guān)于@Query注解的用法(Spring Data JPA),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03
java使用監(jiān)聽器實(shí)現(xiàn)一個(gè)統(tǒng)計(jì)網(wǎng)站在線人數(shù)的示例
本文主要介紹了java使用監(jiān)聽器實(shí)現(xiàn)一個(gè)統(tǒng)計(jì)網(wǎng)站在線人數(shù)的示例,具有一定的參考價(jià)值,有需要的朋友可以了解一下。2016-10-10
java 輸入一個(gè)數(shù)字,反轉(zhuǎn)輸出這個(gè)數(shù)字的值(實(shí)現(xiàn)方法)
下面小編就為大家?guī)硪黄猨ava 輸入一個(gè)數(shù)字,反轉(zhuǎn)輸出這個(gè)數(shù)字的值(實(shí)現(xiàn)方法)。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2016-10-10
Nacos與SpringBoot實(shí)現(xiàn)配置管理的開發(fā)實(shí)踐
在微服務(wù)架構(gòu)中,配置管理是一個(gè)核心組件,而Nacos為此提供了一個(gè)強(qiáng)大的解決方案,本文主要介紹了Nacos與SpringBoot實(shí)現(xiàn)配置管理的開發(fā)實(shí)踐,具有一定的參考價(jià)值2023-08-08
Java面試Socket編程常用參數(shù)設(shè)置源碼問題分析
這篇文章主要為大家介紹了Java編程中關(guān)于Socket結(jié)構(gòu)分析,常用參數(shù)設(shè)置源碼示例以及面試中的問題分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助2022-03-03
Java解決xss轉(zhuǎn)義導(dǎo)致轉(zhuǎn)碼的問題
跨站腳本攻擊XSS是最普遍的Web應(yīng)用安全漏洞,本文主要介紹了Java解決xss轉(zhuǎn)義導(dǎo)致轉(zhuǎn)碼的問題,具有一定的參考價(jià)值,感興趣的可以了解一下2023-08-08

