Springboot公共字段填充及ThreadLocal模块改进方案

1. 公共字段自动填充

1.1 问题分析

在新增员工时需要设置创建时间、创建人、修改时间、修改人等字段，在编辑员工时需要设置修改时间、修改人等字段。这些字段属于公共字段，也就是也就是在系统中很多表中都会有这些字段，如下：

 而针对于这些字段的赋值方式为：

A. 在新增数据时, 将createTime、updateTime 设置为当前时间, createUser、updateUser设置为当前登录用户ID。

B. 在更新数据时, 将updateTime 设置为当前时间, updateUser设置为当前登录用户ID。

目前,在项目中处理这些字段都是在每一个业务方法中进行赋值操作,如下

如果都按照上述的操作方式来处理这些公共字段, 需要在每一个业务方法中进行操作, 编码相对冗余、繁琐。

改进：使用Mybatis Plus提供的公共字段自动填充功能来简化开发。

1.2 基本功能实现

1.2.1 思路分析

Mybatis Plus公共字段自动填充，即在插入或者更新的时候为指定字段赋予指定的值，好处统一对这些字段进行处理，避免了重复代码。在上述的问题分析中，有四个公共字段需要在新增/更新中进行赋值操作, 具体情况如下:

实现步骤：

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

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

1.3 代码实现

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

在员工Employee实体类的公共字段属性上, 加上注解, 指定填充策略。

package com.itheima.reggie.entity;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import lombok.Data;
import java.io.Serializable;
import java.time.LocalDateTime;
/**@Description: 员工实体类 该实体类主要用于和员工表 employee 进行映射。
* @version v1.0
* @author LiBiGo
* @date 2022/8/12 11:05
*/
// 在实体类上添加@Data注解，可以省去代码中大量的 get()、 set()、 toString() 等方法，提高代码的简洁：
@Data
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;
   // map-underscore-to-camel-case: true
   // 在映射实体或者属性时，将数据库中表名和字段名中的下划线去掉，按照驼峰命名法映射
   private String idNumber; //身份证 因为在配置文件中设置驼峰命名，所以与数据库中的不太一样，数据库中为id_number
   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). 按照框架要求编写元数据对象处理器，在此类中统一为公共字段赋值，此类需要实现MetaObjectHandler接口。

package com.itheima.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;
/**
* Description: 自定义元数据对象处理器|统一为公共字段赋值，此类需要实现MetaObjectHandler接口。
* @author w
* @version 1.0
* @date 2022/8/15 12:05
*/
@Component
@Slf4j
public class MyMetaObjecthandler implements MetaObjectHandler {
   @Override
   public void insertFill(MetaObject metaObject) {
       /**@Description: 插入操作自动填充
        * @version v1.0
        * @author LiBiGo
        * @date 2022/8/15 12:14
        */
       log.info("公共字段自动填充insert...");
       log.info(metaObject.toString());
       metaObject.setValue("createTime", LocalDateTime.now());
       metaObject.setValue("updateTime", LocalDateTime.now());
       metaObject.setValue("createUser", BaseContext.getCurrentId()); // 使用了Thread 看后续
       metaObject.setValue("updateUser", BaseContext.getCurrentId());
   }
   @Override
   public void updateFill(MetaObject metaObject) {
       /**@Description: 更新操作自动填充
        * @version v1.0
        * @author LiBiGo
        * @date 2022/8/15 12:14
        */
       log.info("公共字段自动填充update...");
       log.info(metaObject.toString());
       long id = Thread.currentThread().getId();
       log.info("线程ID：{}",id);
       metaObject.setValue("updateTime", LocalDateTime.now());
       metaObject.setValue("updateUser", BaseContext.getCurrentId());
   }
}

2 使用ThreadLocal对公共字段填充功能进行完善

2.1 思路分析

2.1.1 提出设想

前面已经完成公共字段自动填充功能的代码开发，但是还有一个问题没有解决，就是在自动填充createUser和updateUser时设置的用户id是固定值，现在需要改造成动态获取当前登录用户的id。

提出设想：用户登录成功后将用户id存入了HttpSession中，现在从HttpSession中获取不就行了？

存在问题：在MyMetaObjectHandler类中是不能直接获得HttpSession对象的，所以需要通过其他方式来获取登录用户id。

2.1.2 分析问题

在修改员工信息时, 业务的执行流程如下图:

客户端发送的每次http请求，对应的在服务端都会分配一个新的线程来处理，在处理过程中涉及到下面类中的方法都属于相同的一个线程：

1). LoginCheckFilter的doFilter方法

2). EmployeeController的update方法

3). MyMetaObjectHandler的updateFill方法

我们可以在上述类的方法中加入如下代码(获取当前线程ID,并输出):

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

执行编辑员工功能进行验证，通过观察控制台输出可以发现，一次请求对应的线程id是相同的：

经过上述的分析之后,发现可以使用JDK提供的一个ThreadLocal类来解决此问题。

2.2 ThreadLocal

2.2.1 ThreadLocal基本概述

ThreadLocal并不是一个Thread，而是Thread的局部变量。

当使用ThreadLocal维护变量时，ThreadLocal为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。

ThreadLocal为每个线程提供单独一份存储空间，具有线程隔离的效果，只有在线程内才能获取到对应的值，线程外则不能访问当前线程对应的值。

2.2.2 ThreadLocal常用方法

A. public void set(T value) : 设置当前线程的线程局部变量的值

B. public T get() : 返回当前线程所对应的线程局部变量的值

C. public void remove() : 删除当前线程所对应的线程局部变量的值

我们可以在LoginCheckFilter的doFilter方法中获取当前登录用户id，并调用ThreadLocal的set方法来设置当前线程的线程局部变量的值（用户id），然后在MyMetaObjectHandler的updateFill方法中调用ThreadLocal的get方法来获得当前线程所对应的线程局部变量的值（用户id）。 如果在后续的操作中, 我们需要在Controller / Service中要使用当前登录用户的ID, 可以直接从ThreadLocal直接获取。

2.3 操作步骤

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

2). 在LoginCheckFilter的doFilter方法中调用BaseContext来设置当前登录用户的id

3). 在MyMetaObjectHandler的方法中调用BaseContext获取登录用户的id

2.4 代码实现

1). BaseContext工具类

package com.itheima.reggie.common;
/**
* Description: 基于ThreadLocal封装工具类，用户保存和获取当前登陆用户ID
* @date 2022/8/15 12:40
*/
public class BaseContext {
   private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();
   /**
    * 设置值
    * @param id
    */
   public static void setCurrentId(Long id){
       threadLocal.set(id);
   }
   /**
    * 获取值
    * @return
    */
   public static Long getCurrentId(){
       return threadLocal.get();
   }
}

2).LoginCheckFilter中存放当前登录用户到ThreadLocal

在doFilter方法中, 判定用户是否登录, 如果用户登录, 在放行之前, 获取HttpSession中的登录用户信息, 调用BaseContext的setCurrentId方法将当前登录用户ID存入ThreadLocal。

package com.itheima.reggie.filter;
import com.alibaba.fastjson.JSON;
import com.itheima.reggie.common.BaseContext;
import com.itheima.reggie.common.R;
import lombok.extern.slf4j.Slf4j;
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.io.IOException;
/**
* Description: 检查用户是否已经完成登陆
*/
@WebFilter(filterName = "LoginCheckFilter",urlPatterns = "/*")  //设置 * ，设置拦截的网页区域
@Slf4j
public class LoginCheckFilter implements Filter {
   // 路径匹配器，支持通配符，因为下面的序列使用了通配符
   // AntPathMatcher匹配规则  ? 匹配一个字符    * 匹配0个或多个字符   ** 匹配0个或多个目录/字符
   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;
       //  A. 获取本次请求的URI
       String requestURI = request.getRequestURI();
       log.info("拦截的请求：{}",requestURI);
       // 定义不拦截的序列，只拦截页面数据请求，不拦截页面格式
       String[] urls = new String[]{
               "/employee/login",
               "/employee/logout",
               "/backend/**",
               "/front/**"
       };
       //  B. 判断本次请求, 是否需要登录, 才可以访问
       boolean check = check(urls, requestURI);
       //  C. 如果不需要，则直接放行
       if(check){
           log.info("本次请求{}不需要处理",requestURI);
           filterChain.doFilter(request,response);
           return;
       }
       //  D. 判断登录状态，如果已登录，则直接放行
       if(request.getSession().getAttribute("employee")!=null){
           log.info("用户已登录，用户id为：{}",request.getSession().getAttribute("employee"));
           Long empId = (Long) request.getSession().getAttribute("employee"); // 获取当前用户登陆id
           BaseContext.setCurrentId(empId); //设置线程共享
           filterChain.doFilter(request,response); // 补课 不清楚？？？？？？？？？？？？
           long id = Thread.currentThread().getId();
           log.info("检测是否登陆线程ID：{}",id);
           return;
       }
       //  E. 如果未登录, 则返回未登录结果
       response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));
       return;
   }
   public boolean check(String[] urls,String requestURI){
       /**@Description: 路径匹配，检查本次请求是否需要放行
        * @author LiBiGo
        * @date 2022/8/12 16:50
        */
       for (String url : urls) {
           boolean match = PATH_MATCHER.match(url, requestURI); // 使用通配符对象，配对资源
           if(match){
               return true;
           }
       }
       return false;
   }
}

3). MyMetaObjectHandler中从ThreadLocal中获取

将之前在代码中添加动态调用BaseContext中的getCurrentId方法获取当前登录用户ID

3 功能测试

编写完了元数据对象处理器之后，我们就可以将之前在新增和修改方法中手动赋值的代码删除或注释掉。

完善了元数据对象处理器重新启动项目，完成登录操作后，在员工管理模块中，测试增加/更新员工信息功能，直接查询数据库数据变更，看看我们在新增/修改数据时，这些公共字段数据是否能够完成自动填充, 并且看看填充的create_user 及 update_user字段值是不是本地登录用户的ID。

来源：https://juejin.cn/post/7171272528126541861#heading-16