Mybatis-Plus 公共字段自动填充

一、问题分析

数据库表中有许多表有公共字段，当执行插入或者更新时都需要在代码中设置。

数据库表中的公共字段

java代码中给字段设置值

Mybatis Plus 提供了公共字段自动填充功能，可以对这些公共字段在某个地方(类)中统一处理，简化开发。

二、代码实现

解决问题
Mybatis Plus 公共字段自动填充，也就是插入或者更新的时候为指定字段赋予指定的值，使用它的好处就是统一对这些字段进行处理，避免了重复代码。

实现步骤
1、在实体类的属性上加入 @TableFiled 注解，指定自动填充的策略。

实体类字段并且指定自动填充的策略。

FieldFill 的枚举值。

2、按照框架(MybatisPlus)要求编写元数据对象处理器，在此类中统一为公共字段赋值，此类需要实现 MetaObjectHandler 接口

package com.jude.common;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

/**
 * @author 西瓜菌
 * @Classname MyMetaObjectHandler
 * @Description 自定义元数据对象处理器
 * @Date 2022/7/20 11:01
 */
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * 插入操作，自动填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("公共字段填充(insert)");
        // 创建时间
        metaObject.setValue("createTime", LocalDateTime.now());
        // 创建人
        metaObject.setValue("createUser",1L);
        // 更新时间
        metaObject.setValue("updateTime", LocalDateTime.now());
        // 更新人
        metaObject.setValue("updateUser",1L);
    }

    /**
     * 更新操作，自动填充
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段填充(insert)");
        // 更新时间
        metaObject.setValue("updateTime", LocalDateTime.now());
        // 更新人
        metaObject.setValue("updateUser",1L);
    }
}

注意：createUser 和 updateUser 为用户 id，后面我们需要使用 ThreadLocal 动态获取当前用户 id

三、ThreadLocal

ThreadLocal 是 JDK 中提供的一个类。
客户端发送的每次 http 请求，对应的在服务端都会分配一个新的线程来处理。
什么是 ThreadLocal
ThreadLocal 并不是一个 Thread, 而是 Thread 的局部变量。当使用 ThreadLocal 维护变量时，ThreadLocal 为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。ThreadLocal 为每个线程提供单独一份存储空间，具有线程隔离的效果，只有在线程内才能获取对应的值，线程外则不能访问。

ThreadLocal 常用方法：

• public void set (T value) 设置当前线程的线程局部变量的值
• public T get ( ) 返回当前线程所对应的线程局部变量的值

四、功能完善

实现步骤：
1、编写 BaseContextUtli 工具类，基于 ThreadLocal 封装的工具类

package com.jude.util;

/**
 * @author 西瓜菌
 * @Classname BaseContextUtil
 * @Description 基于 ThreadLocal 封装工具类，用户保存和获取当前登陆用户 id
 * @Date 2022/7/20 11:22
 */
public class BaseContextUtil {
    private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();

    public static void setCurrentId(Long id){
        threadLocal.set(id);
    }

    public static Long getCurrentId(){
        return threadLocal.get();
    }
}

2、在 LoginCheckFilter 中调用 BaseContextUtli 设置当前登陆用户的 id

BaseContextUtil.setCurrentId(principal.getId());

3、在 MyMetaObjectHandler 的方法中调用 BaseContextUtli 获取登录用户的id

metaObject.setValue("createUser", BaseContextUtil.getCurrentId());