公共字段自动填充

一、问题分析

在完成后台系统的员工管理功能开发时，在新增员工时需要设置创建时间、创建人、修改时间、修改人等字段，在编辑员工时需要设置修改时间和修改人等字段。这些字段属于公共字段。

对这些公共字段进行统一处理，简化开发？

使用Mybatis Plus提供的公共字段填充功能。

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

实现步骤：

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

package com.itheima.entity;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import lombok.Data;

import java.io.File;
import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * 员工实体
 */
@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;

    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接口。删除Controller服务端自定义更新updateTime等字段代码

package com.itheima.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;

/**
 * 自定义元数据对象处理器
 */
@Component
@Slf4j
public class MyMetaObjecthandler implements MetaObjectHandler {
    /**
     * 插入操作自动填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
//        log.info("公共字段自动填充[insert]...：");
//        log.info(metaObject.toString());
        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]...：");
//        log.info(metaObject.toString());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", new Long(1));
    }
}

（3）createUserupdateUser为固定值，需改为动态获取当前登录用户的id。

由于MyMetaObjectHandler类中是不能获得HttpSession对象的，所以我们需要通过其它方式来获取登录用户id。

可以使用ThreadLocal来解决此问题，它是JDK中提供的一个类。

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

1、LoginCheckFilter的doFilter方法

2、EmployeeController中的update方法

3、MyMetaObjectHandler的updateFill方法

可以在上面三个方法中分别加入下列代码(获取当前线程id)

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

 

 

 

 

 

 

什么是ThreadLocal?

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

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

ThreadLocal常用方法：

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

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

我们可以在LoginCheckFilter的doFilter方法中过去当前登录用户的id，并调用ThreadLocal的set方法来设置当前线程的线程局部变量的值（用户id），然后在MyMetaObjectHandler的updateFill()方法中调用ThreadLocal的get方法来获得当前线程所对应的线程局部变量的值(用户id)。

 

实现步骤

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

package com.itheima.common;

/**
 * 基于ThreadLocal封装工具类，用户保存和获取当前登录用户的id
 */
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的doFilter方法中调用BaseContex来设置当前登录用户的id

//4、判断登录状态，如果已登录，则直接放行
        if(request.getSession().getAttribute("employee")!=null){
            long id = Thread.currentThread().getId();
            log.info("线程id:{}", id);
            
            long empId = (long)request.getSession().getAttribute("employee");
            BaseContext.setCurrentId(empId);
            filterChain.doFilter(request, response);
//            log.info("用户已登录,用户id为：{}", request.getSession().getAttribute("employee"));

            return;
        }

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

package com.itheima.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;

/**
 * 自定义元数据对象处理器
 */
@Component
@Slf4j
public class MyMetaObjecthandler implements MetaObjectHandler {
    /**
     * 插入操作自动填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("公共字段自动填充[insert]...：");
        log.info(metaObject.toString());
  
        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());
        long id = Thread.currentThread().getId();
        log.info("线程id:{}", id);
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", BaseContext.getCurrentId());
    }
}