SpringBoot项目中自定义元数据对象处理器公共字段的自动填充

1.配置自定义的元数据对象处理器

package com.example.common.conf.mybatis;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.example.common.utils.JwtTokenUtils;
import io.jsonwebtoken.Claims;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.Date;

/**
 * @ClassName: MyMetaObjectHandle
 * @Description:自定义元数据对象处理器
 * @Author: WangBin
 * @Date: 2023/5/20 0:33
 */
@Component
@Slf4j
public class MyMetaObjectHandle implements MetaObjectHandler {

    /**
     * 插入操作自动填充
     *
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("公共字段自动填充 [insert]...");

        // 获取token并解析userId
        String token = getRequestToken();
        Claims claims = JwtTokenUtils.analysisToken(token);
        String userId = claims.getId();

        // 填充数据
        metaObject.setValue("createTime", new Date());
        metaObject.setValue("updateTime", new Date());
        metaObject.setValue("createBy", Integer.parseInt(userId));
        metaObject.setValue("updateBy", Integer.parseInt(userId));
    }

    /**
     * 更新操作自动填充
     *
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充 [update]...");
        // 获取token并解析userId
        String token = getRequestToken();
        Claims claims = JwtTokenUtils.analysisToken(token);
        String userId = claims.getId();
        // 填充数据
        metaObject.setValue("updateTime", new Date());
        metaObject.setValue("updateBy", Integer.parseInt(userId));
    }

    /**
     * 在请求头中获取token
     * @return
     */
    private String getRequestToken() {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes != null) {
            HttpServletRequest request = attributes.getRequest();
            return request.getHeader("token"); // 假设Token存储在Authorization头中
        }
        return null;
    }
}

2.创建User对象来测试处理效果

（1）提取User对象中公共字段封装成BaseEntity，公共类BaseEntity的字段使用注解@TableField

@TableField(fill = FieldFill.INSERT)该注解会在添加数据时自动填充

@TableField(fill = FieldFill.INSERT_UPDATE)该注解会在添加数据或更新数据时自动填充

@TebleField(fill = FieldFill.UPDATE)该注解会在更新数据时自动填充

package com.example.springbootdemo.common.utils;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;
import java.util.Date;

/**
 * @ClassName: BaseEntity
 * @Description:
 * @Author: WangBin
 * @Date: 2023/5/18 22:43
 */
@Data
public class BaseEntity implements Serializable {

    private static final long serialVersionUID = 1L;

    /** 创建人 */
    @ApiModelProperty(value = "创建人")
    @TableField(fill = FieldFill.INSERT)//自动填充策略，在添加数据的时候自动填充
    private String createBy;

    /** 创建时间 */
    @ApiModelProperty(value = "创建时间")
    @TableField(fill = FieldFill.INSERT)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;

    /** 更新人 */
    @ApiModelProperty(value = "更新人")
    @TableField(fill = FieldFill.INSERT_UPDATE)//自动填充策略，在添加数据和修改数据的时候自动填充
    private String updateBy;

    /** 更新时间 */
    @ApiModelProperty(value = "更新时间")
    @TableField(fill = FieldFill.INSERT_UPDATE)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date updateTime;

    /** 备注 */
    @ApiModelProperty(value = "备注")
    private String remark;
}

（2）使User类继承BaseEntity类使用其自动填充功能

package com.example.springbootdemo.model;

import com.baomidou.mybatisplus.annotation.*;
import com.example.springbootdemo.common.utils.BaseEntity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * @ClassName: User
 * @Description:
 * @Author: WangBin
 * @Date: 2023/6/17 20:48
 */
@Data
@TableName("user")
@ApiModel(description = "用户类") // 该注解用来声明实体类
public class User extends BaseEntity {

    /** id */
    @TableId(value = "id", type = IdType.AUTO)
    @ApiModelProperty(value = "用户ID") // 该注解用来声明参数字段
    private Integer id;

    /** 名字 */
    @ApiModelProperty(value = "用户姓名")
    private String name;

    /** 账号 */
    @ApiModelProperty(value = "用户账号")
    private String account;

    /** 密码 */
    @ApiModelProperty(value = "用户密码")
    private String password;

}