MyBatisPlus实现自动填充字段的实践
作者：pan_junbiao
MyBatis-Plus自动填充功能可以在插入或更新数据时自动填充字段,如创建时间和更新时间,本文就来详细的介绍一下,具有一定的参考价值,感兴趣的可以了解一下
MyBatis-Plus 提供了一个便捷的自动填充功能，用于在插入或更新数据时自动填充某些字段，如创建时间、更新时间等。以下是如何使用这一功能的详细说明。
自动填充功能通过实现 com.baomidou.mybatisplus.core.handlers.MetaObjectHandler 接口来实现。你需要创建一个类来实现这个接口，并在其中定义插入和更新时的填充逻辑。
【实例】使用 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;
}
}注意：
确保 MyMetaObjectHandler 类被 Spring 管理，可以通过 @Component 或 @Bean 注解来实现。
4、注意事项
- 自动填充是直接给实体类的属性设置值。
- 如果属性没有值，入库时会是 null。
- MetaObjectHandler 提供的默认方法策略是：如果属性有值则不覆盖，如果填充值为 null 则不填充。
- 字段必须声明 @TableField 注解，并设置 fill 属性来选择填充策略。
- 填充处理器需要在 Spring Boot 中声明为 @Component 或 @Bean。
- 使用 strictInsertFill 或 strictUpdateFill 方法可以根据注解 FieldFill.xxx、字段名和字段类型来区分填充逻辑。
- 如果不需区分，可以使用 fillStrategy 方法。
- 在 update(T entity, Wrapper<T> updateWrapper) 时，entity 不能为空，否则自动填充失效。
- 在 update(Wrapper<T> updateWrapper) 时不会自动填充，需要手动赋值字段条件。
到此这篇关于MyBatisPlus实现自动填充字段的实践的文章就介绍到这了,更多相关MyBatisPlus 自动填充字段内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！