MyBatisPlus实现自动填充字段的实践_Java

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;
    }
}