快捷導航

MyBatisPlus實現(xiàn)自動填充字段的實踐

更新時間：2024年10月23日 10:52:35 作者：pan_junbiao

MyBatis-Plus自動填充功能可以在插入或更新數(shù)據(jù)時自動填充字段,如創(chuàng)建時間和更新時間,本文就來詳細的介紹一下,具有一定的參考價值,感興趣的可以了解一下

MyBatis-Plus 提供了一個便捷的自動填充功能，用于在插入或更新數(shù)據(jù)時自動填充某些字段，如創(chuàng)建時間、更新時間等。以下是如何使用這一功能的詳細說明。
自動填充功能通過實現(xiàn) com.baomidou.mybatisplus.core.handlers.MetaObjectHandler 接口來實現(xiàn)。你需要創(chuàng)建一個類來實現(xiàn)這個接口，并在其中定義插入和更新時的填充邏輯。

官方文檔：《MyBatis-Plus 自動填充字段》

【實例】使用 MyBatis-Plus 的自動填充字段功能，實現(xiàn)為數(shù)據(jù)表自動填充：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 '用戶編號',
	user_account VARCHAR(50) NOT NULL COMMENT '用戶賬號',
	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)建時間',
	update_time TIMESTAMP DEFAULT NULL COMMENT '最后修改時間'
) COMMENT = '用戶信息表';

2、定義實體類

在實體類中，必須使用 @TableField 注解來標記哪些字段需要自動填充，并指定填充的策略。

在 entity 包中，創(chuàng)建 UserInfo 類（用戶信息實體類）。

package com.pjb.pm.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;

import java.time.LocalDateTime;

/**
 * 用戶信息實體類
 * @author pan_junbiao
 **/
@Data
@TableName("tb_user") //設(shè)置數(shù)據(jù)表名
public class UserInfo
{
    // 忽略其他字段...

    /**
     * 創(chuàng)建時間
     */
    @TableField(fill = FieldFill.INSERT)  //填充策略：插入填充字段
    private LocalDateTime createTime;

    /**
     * 最后修改時間
     */
    @TableField(fill = FieldFill.INSERT_UPDATE) //填充策略：插入和更新填充字段
    private LocalDateTime updateTime;
}

FieldFill 枚舉：

public enum FieldFill {
    DEFAULT,       // 默認不處理
    INSERT,        // 插入填充字段
    UPDATE,        // 更新填充字段
    INSERT_UPDATE  // 插入和更新填充字段
}

3、實現(xiàn) MetaObjectHandler 接口

創(chuàng)建一個類來實現(xiàn) MetaObjectHandler 接口，并重寫 insertFill 和 updateFill 方法。

在 handler 包中，創(chuàng)建 MyMetaObjectHandler 類（MyBatis-plus自動填充字段處理類）。

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自動填充字段處理類
 * @author pan_junbiao
 **/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler
{
    /**
     * 新增操作：執(zhí)行自動填充
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }

    /**
     * 修改操作：執(zhí)行自動填充
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }

    /**
     * 強制填充
     * 官方原文：MetaObjectHandler 提供的默認方法策略是：如果屬性有值則不覆蓋，如果填充值為 null 則不填充
     * 所以這里修改策略方法，去掉屬性為 null 的判斷，實現(xiàn)強制填充
     */
    @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 注解來實現(xiàn)。

4、注意事項

自動填充是直接給實體類的屬性設(shè)置值。
如果屬性沒有值，入庫時會是 null。
MetaObjectHandler 提供的默認方法策略是：如果屬性有值則不覆蓋，如果填充值為 null 則不填充。
字段必須聲明 @TableField 注解，并設(shè)置 fill 屬性來選擇填充策略。
填充處理器需要在 Spring Boot 中聲明為 @Component 或 @Bean。
使用 strictInsertFill 或 strictUpdateFill 方法可以根據(jù)注解 FieldFill.xxx、字段名和字段類型來區(qū)分填充邏輯。
如果不需區(qū)分，可以使用 fillStrategy 方法。
在 update(T entity, Wrapper<T> updateWrapper) 時，entity 不能為空，否則自動填充失效。
在 update(Wrapper<T> updateWrapper) 時不會自動填充，需要手動賦值字段條件。

到此這篇關(guān)于MyBatisPlus實現(xiàn)自動填充字段的實踐的文章就介紹到這了,更多相關(guān)MyBatisPlus 自動填充字段內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: