当前位置：首页 > article >正文

MyBatis-Plus自动填充字段

article 2024/9/29 17:04:11

MyBatis-Plus 提供了一个便捷的自动填充功能，用于在插入或更新数据时自动填充某些字段，如创建时间、更新时间等。以下是如何使用这一功能的详细说明。
自动填充功能通过实现 com.baomidou.mybatisplus.core.handlers.MetaObjectHandler 接口来实现。你需要创建一个类来实现这个接口，并在其中定义插入和更新时的填充逻辑。

官方文档：《MyBatis-Plus 自动填充字段》

【实例】使用 MyBatis-Plus 的自动填充字段功能，实现为数据表自动填充：create_time 和 update_time 字段。

1、创建数据表

在 MySQL 数据库中创建用户信息表（tb_user）。

-- 创建数据库
CREATE DATABASE IF NOT EXISTS db_admin;

-- 使用数据库
USE db_admin;

-- 判断数据表是否存在，存在则删除
DROP TABLE IF EXISTS tb_user;
 
-- 创建“用户信息”数据表
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 '创建时间',
	update_time TIMESTAMP DEFAULT NULL COMMENT '最后修改时间'
) COMMENT = '用户信息表';

2、定义实体类

在实体类中，必须使用 @TableField 注解来标记哪些字段需要自动填充，并指定填充的策略。

在 entity 包中，创建 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") //设置数据表名
public class UserInfo
{
    // 忽略其他字段...

    /**
     * 创建时间
     */
    @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、实现 MetaObjectHandler 接口

创建一个类来实现 MetaObjectHandler 接口，并重写 insertFill 和 updateFill 方法。

在 handler 包中，创建 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
{
    /**
     * 新增操作：执行自动填充
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }

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

    /**
     * 强制填充
     * 官方原文：MetaObjectHandler 提供的默认方法策略是：如果属性有值则不覆盖，如果填充值为 null 则不填充
     * 所以这里修改策略方法，去掉属性为 null 的判断，实现强制填充
     */
    @Override
    public MetaObjectHandler strictFillStrategy(MetaObject metaObject, String fieldName, Supplier<?> fieldVal) {
        Object obj = fieldVal.get();
        if (Objects.nonNull(obj)) {
            metaObject.setValue(fieldName, obj);
        }
        return this;
    }
}