如何实现Mybatis-plus的公共字段填充

什么是Mybatisplus的公共字段填充

Mybatisplus的公共字段填充是指，在进行数据库操作时，自动将公共字段（例如创建时间、修改时间、创建者、修改者等）的值填充到对应的实体对象中，从而避免手动填写这些字段带来的麻烦和错误。这个功能在实现上是通过在实体类中定义对应的公共字段，并在Mybatisplus的配置中设置相应的拦截器来实现的。公共字段填充可以大大简化代码编写，提高代码效率和准确性，特别是在大型系统中更为重要。

简单来说就是在新增或者修改的时候为指定字段添加指定值

MyBatisplus公共字段填充的好处

1. 提高了开发效率：公共字段填充可以自动填充一些通用字段值，不需要手动去设置，减少了代码的编写量和开发时间。

2. 保证了数据的一致性：公共字段填充能够统一设置一些数据，保证数据的一致性，防止误操作，提高了数据的安全性。

3. 方便维护：公共字段填充可以统一配置，集中在一个地方维护，方便后期维护。

4. 应场景广泛：公共字段填充对于许多业务场景都可以应用，如创建人、修改人、创建时间、修改时间等等，是一项非常实用的功能。

如何实现

1.在实体类上添加注解@TableField，指定自动填充的策略

2.创建一个类，实现MetaObjectHandler接口，并重写相应的方法

举例

以该数据表为例(员工表)，以红线标出的为公共字段

在创建员工的时候，需要[创建人，创建时间，修改人，修改实现]这四个字段

在修改员工信息时，则需要[修改人，修改时间]这两个字段

1.在实体类上添加注解@TableField，指定自动填充的策略

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

}

其中@TableField()中的fill属性指定当实体类新增或修改时，对应数据库表字段的策略；

主要有两种取值：FieldFill.DEFAULT表示不进行任何填充；

FieldFill.INSERT和FieldFill.UPDATE表示在新增或更新时进行填充;

FieldFill.INSERT_UPDATE表示新增和更新时进行填充

例，当fill=FieldFill.INSERT时，新增时会自动填充对应数据库表字段的值；但在修改时不会进行填充

2.创建一个类，实现MetaObjectHandler接口，并重写相应的方法

@Slf4j
@Configuration
public class MyMateObjectHandler implements MetaObjectHandler {


    /**
     * 添加时  自动填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("mybatisplus公共字段填充[insert]...");
        metaObject.setValue("createTime", LocalDateTime.now());//创建时间
        metaObject.setValue("updateTime", LocalDateTime.now());//修改时间
        metaObject.setValue("createUser",  1);//创建人ID
        metaObject.setValue("updateUser",  1);//修改人ID
    }

    /**
     * 更新时 自动填充
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("mybatisplus公共字段填充[update]...");
        metaObject.setValue("updateTime", LocalDateTime.now());//修改时间
        metaObject.setValue("updateUser",  1);//修改人ID
    }
}

3.修改前与修改后的比较

/**
  新增（未进行自动填充）
*/
   @PostMapping
    public R<String> getAdd(@RequestBody Employee employee,HttpServletRequest request){
        log.info("新增员工，员工信息：{}",employee);

        //1.设置初始密码(MD5加密)
        employee.setPassword(DigestUtils.md5DigestAsHex("123456".getBytes()));

        //2.设置创建时间和更新时间
        employee.setCreateTime(LocalDateTime.now());//创建时间
        employee.setUpdateTime(LocalDateTime.now());//更新时间
        //3.设置当前登录人Id
        Long empId = (Long) request.getSession().getAttribute("employee");
        employee.setCreateUser(empId);//创建人
        employee.setUpdateUser(empId);//更新人

        //4.新增
        employeeService.save(employee);
        return R.success("新增员工成功");
    }

/**
新增 使用了公共字段指定填充
*/
   @PostMapping
    public R<String> getAdd(@RequestBody Employee employee,HttpServletRequest request){
        log.info("新增员工，员工信息：{}",employee);

        //1.设置初始密码(MD5加密)
        employee.setPassword(DigestUtils.md5DigestAsHex("123456".getBytes()));
        
        //4.新增
        employeeService.save(employee);
        return R.success("新增员工成功");
    }

功能完善

我的用户ID是存储在session中的

在上述实现实现MetaObjectHandler接口的类中大家可以发现我们用户的ID是固定值，但实际运用肯定不是这样的，但在这个类中我们又不能使用session进行获取，哪该如何获取？

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

1.什么是ThreadLocal？

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

2.ThreadLocal常用的方法:
    public void set(T value);//存储当前线程局部变量的值
    public T get();//返回当前线程所对应的线程局部变量的值

3.如何获取用户Id
    可以通过在LoginFilter是doFilter方法中获得当前登录的用户Id,
    并调用局部变量的值(用户Id)，然后在MyMetObjectHandler的updateFill方法中调用
    ThreadLocal的get方法获得当前线程所对应的线程局部变量的值（用户Id） 
        
4.实现步骤
    1.编写BaseContext工具类，基于ThreadLocal封装工具类;
    2.在LoginFilter是doFilter方法中调用BeaseContext用来设置当前登录;
    3.在MyMateObjectHandler的方法中调用BaseContext获得登录用户id

具体实现

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

/**
 * 基于ThreadLocal封装工具类
 * 用于存储当前用户的Id
 */
public class BaseContext {
    private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();

    /**
     * 设置值
     * @param id
     */
    public static void setUserId(Long id){
        threadLocal.set(id);
    }

    /**
     * 获取值
     * @return
     */
    public static Long getUserId(){
        return threadLocal.get();
    }
    
}

 2.在LoginFilter是doFilter方法中调用BeaseContext用来设置当前登录;

 //使用ThreadLocal存储用户id（公共字段填充）
            BaseContext.setUserId(employeeId);

 全部代码

@Slf4j
@WebFilter(filterName = "LoginFilter",urlPatterns = "/*")
public class LoginFilter 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.获取本次请求的URI
        String uri = request.getRequestURI();
        log.info("拦截到本次请求：{}",uri);
        //2.定义不需要处理的URI
        String[] urls = new String[]{"/employee/login","/employee/logout","/backend/**","/front/**"};
        //3.判断本次请求是否需要处理
        boolean check = check(uri, urls);
        //4.如果不需要处理则放行
        if (check) {
            log.info("本次{}请求不需要处理",uri);
            filterChain.doFilter(request,response);
            return;
        }

        //5.判断登录状态，如果已经登录则放行
        if (request.getSession().getAttribute("employee")!=null) {
            log.info("用户已登录，用户ID为{}",request.getSession().getAttribute("employee"));

            //获取用户Id
            Long employeeId =(Long) request.getSession().getAttribute("employee");

            //使用ThreadLocal存储用户id（公共字段填充）/
            BaseContext.setUserId(employeeId);

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

        log.info("用户未登录");
        //6.如果未登录则返回未登录结果，通过输出流向客户端相应数据
        response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));
        return;

    }

    /**
     * 检测本次请求是否需要放行
     * @param uri
     * @return
     */
    public boolean check(String uri,String[] uris){
        for (String s : uris) {
            boolean match = PATH_MATCHER.match(s, uri);
            if (match) {
                return true;
            }
        } return false;
    }
}

 3.在MyMateObjectHandler的方法中调用BaseContext获得登录用户id

BaseContext.getUserId()//通过它获取用户Id

@Slf4j
@Configuration
public class MyMateObjectHandler implements MetaObjectHandler {


    /**
     * 添加时  自动填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("mybatisplus公共字段填充[insert]...");
        metaObject.setValue("createTime", LocalDateTime.now());//创建时间
        metaObject.setValue("updateTime", LocalDateTime.now());//修改时间
        metaObject.setValue("createUser",  BaseContext.getUserId());//创建人ID|从ThreadLocal获得存储用户Id
        metaObject.setValue("updateUser",  BaseContext.getUserId());//修改人ID|从ThreadLocal获得存储用户Id
    }

    /**
     * 更新时 自动填充
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("mybatisplus公共字段填充[update]...");
        metaObject.setValue("updateTime", LocalDateTime.now());//修改时间
        metaObject.setValue("updateUser",  BaseContext.getUserId());//修改人ID|从ThreadLocal获得存储用户Id
    }
}