SpringBoot公共字段自动填充

大家好，我是小羽，今天做项目的时候遇到一个问题，每次添加数据时都要设置创建时间，创建人，修改时间，修改人等字段，实在是太繁琐了。那我能不能让他们添加这些字段的信息呢？

问题分析

创建时间，创建人，修改时间，修改人等字段都属于公共字段，能否将这些公共字段在某个地方统一处理，来简化开发呢？

我们可以使用MybatisPlus提供的公共字段自动填充的功能。

代码实现

Mybatis Plus公共字段自动填充，也就是在插入或者更新的时候为其指定字段赋予指定的值，使用统一的模板来对字段进行处理，避免了重复代码。

1. 在实体类的属性上加入@TableField注解,指定自动填充的策略

public class Employee implements Serializable {

    private static final long serialVersionUID = 1L;

    private Long id;

    private String username;

    private String name;

    private String password;

    private String phone;

    private String sex;

    private String idNumber;

    private Integer status;

    @TableField(fill = FieldFill.INSERT)//自动填充策略，在添加数据的时候自动填充
    private LocalDateTime createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)//自动填充策略，在添加数据和修改数据的时候自动填充
    private LocalDateTime updateTime;

    @TableField(fill = FieldFill.INSERT)
    private Long createUser;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Long updateUser;

}

2. 按照框架要求编写元数据对象处理器，在此类中统一为公共字段赋值

package com.ljh.reggie.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 shenyi
 */
@Component
@Slf4j
public class MyMetaObjectHandle implements MetaObjectHandler {

    /**
     * 插入操作自动填充
     *
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("公共字段自动填充 [insert]...");
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("createUser", new Long(1));
        metaObject.setValue("updateUser", new Long(1));
    }

    /**
     * 更新操作自动填充
     *
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充 [update]...");
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", new Long(1));
    }
}

在此时大家可以注意到updateUser和createUser字段的值为固定值，接下来我们需要对代码进行改造，动态的获取当前登陆用户的id。

那我们如何获取用户id呢？

大家可能会想到，用户登陆成功 后会将用户id存入HttpSession中,那我从HttpSession中获取不就行了吗？

但是我们这里要注意的是MyMetaObjectHandle类中是不能获得HttpSession对象的，所以我们需要通过别的方式来获取。

可以使用ThreadLocal来解决此问题。

ThreadLocal

在学习ThreadLocal之前，我们需要先确认一个事情，就是客户端发送的每次http请求，对应的在服务端都会分配一个新的线程来处理。在处理过程中涉及到下面类中的方法都属于相同的一个线程：
1、LoginCheckFilter的doFilter方法
2、EmployeeController的update方法
3、MyMetaObjectHandler的updateFill方法
可以在上面的三个方中分别加入下面代码（获取当前线程d):

long id=Thread.currentThread().getId();
log.info("线程i8: {}",id);

最后可以得出，这三个方法都在同一个线程中执行的。

什么是ThreadLocal?

ThreadLocal并不是一个Thread,而是Thread的局部变量。当使用ThreadLocal维护变量时，ThreadLocal为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。
ThreadLocal为每个线程提供单独一份存储空间，具有线程隔离的效果，只有在线程内才能获取到对应的值，线程外则不能访问。

ThreadLocal常用方法

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

我们可以在LoginCheckFilter（这个类是登陆过滤器）的doFilter方法中获取当前登录用户id,并调用ThreadLocal的set方法来设置当前线程的线程局部变量的值（用户id),然后在yMetaObjectHandler的updateFill方法中调用ThreadLocall的get方法来获得当前线程所对应的线程局部变量的值（用户id)。

实现步骤

1、编写BaseContext工具类，基于ThreadLocal封装的工具类

package com.ljh.reggie.common;

/**
 * 基于ThreadLocal，用于保存和获取用户id的工具类
 * @author shenyi
 */
public class BaseContext {

    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的doFilter2方法中调用BaseContext:来设置当前登录用户的id

package com.ljh.reggie.Filter;


import com.alibaba.fastjson.JSON;
import com.ljh.reggie.common.BaseContext;
import com.ljh.reggie.common.R;
import lombok.extern.slf4j.Slf4j;
import lombok.val;
import org.springframework.util.AntPathMatcher;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.beans.beancontext.BeanContext;
import java.io.IOException;

/**
 * 检查用户是否已经完成登陆
 * @author shenyi
 */
@WebFilter(filterName = "LoginCheckFilter", urlPatterns = "/*")
@Slf4j
public class LoginCheckFilter implements Filter {
    //路径匹配器，支持通配符
    public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;

        //1.获取本次请求的URL
        String requestURI = request.getRequestURI();
        log.info("拦截到的路径 {}", requestURI);

        //设置不需要拦截的请求
        String[] urls = new String[]{
                "/employee/login",
                "/employee/logout",
                "/backend/**",
                "/front/**"
        };

        //2.判断是否需要拦截请求
        boolean check = check(urls, requestURI);

        //3.若不需要处理，则直接放行
        if (check) {
            log.info("本次请求 {} 不需要处理", requestURI);
            filterChain.doFilter(request, response);
            return;
        }

        //4.判断登陆状态，如果已登录，则直接放行
        if (request.getSession().getAttribute("employee") != null) {
            log.info("用户已经登陆，id为 {}",request.getSession().getAttribute("employee"));
            Long empId= (Long) request.getSession().getAttribute("employee");
            BaseContext.setCurrentId(empId);

            filterChain.doFilter(request, response);
            return;
        }

        log.info("用户未登录");
        //5.如果未登录则通过流的方式，向页面返回结果。
        response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));
        return;
    }

    /**
     * 路径匹配，查看当前路径是否要放行
     *
     * @param requestURI
     * @return
     */
    public boolean check(String[] urls, String requestURI) {
        for (String url : urls) {
            boolean match = PATH_MATCHER.match(url, requestURI);
            if (match) {
                return true;
            }
        }
        return false;
    }
}

3、在MyMetaObjectHandleri的方法中调用BaseContext获取登录用户的id

package com.ljh.reggie.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 shenyi
 */
@Component
@Slf4j
public class MyMetaObjectHandle implements MetaObjectHandler {

    /**
     * 插入操作自动填充
     *
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("公共字段自动填充 [insert]...");
        log.info("insertFill当前线程为："+metaObject.toString());
        System.out.println(Thread.currentThread().getName());
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("createUser", BaseContext.getCurrentId());
        metaObject.setValue("updateUser", BaseContext.getCurrentId());
    }

    /**
     * 更新操作自动填充
     *
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充 [update]...");
        log.info(metaObject.toString());
        System.out.println("updateFill当前线程为："+Thread.currentThread().getName());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", BaseContext.getCurrentId());
    }
}