瑞吉外卖项目学习笔记：P8-分类管理功能-公共字段自动填充开发

最新推荐文章于 2023-10-22 20:50:40 发布

探索者7号

最新推荐文章于 2023-10-22 20:50:40 发布

阅读量413

点赞数 1

分类专栏： SpringBoot项目开发文章标签： spring spring boot mysql java html5

本文链接：https://blog.csdn.net/qq_45498432/article/details/124802906

版权

SpringBoot项目开发专栏收录该内容

27 篇文章 18 订阅

订阅专栏

P8-分类管理功能-公共字段自动填充开发

1.需求分析
2.代码开发

1.需求分析

前面我们已经完成了后台系统的员工管理功能开发,在新增员工时需要设置

创建时间
创建人
修改时间
修改人

等字段，在编辑员工时需要设置修改时间和修改人等字段。这些字段属于公共字段，也就是很多表中都有这些字段，如下:
在这里插入图片描述
能不能对于这些公共字段在某个地方统一处理, 来简化开发呢?
答案就是使用Mybatis Plus提供的公共字段自动填充功能。

2.代码开发

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

实现步骤:

在实体类的属性上加入@TableField注解,指定自动填充的策略
按照框架要求编写元数据对象处理器，在此类中统一为公共字段赋值,此类需要实现MetaObjectHandler接口

2.1后端代码

2.1.1 实体类的属性上加入@TableField注解

package com.jq.entity;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import lombok.Data;
import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * 创建数据库表对应的实体类，进行映射，以后续使用Mybatis Plus对数据库进行操作
 * 数据库表employee对应实体类Employee
 */
@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;//身份证号码，必须在application.yaml 设置好驼峰命名

    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.1.2创建实体类实现MetaObjectHandler接口

package com.jq.commom;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.java.Log;
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("公共字段自动填充[insertFill]...");
        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("公共字段自动填充[updateFill]...");
        log.info(metaObject.toString());

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

        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", new Long(1));
    }
}

2.2完善后端代码

对MyMetaObjectHandler 中id 进行动态获取实现，可以使用ThreadLocal解决

metaObject.setValue("createUser", new Long(1));
metaObject.setValue("updateUser", new Long(1));

2.2.1ThreadLocal的知识

在学习ThreadLocal之前，我们需要先确认-个事情,就是客户端发送的每次http请求,对应的在服务端都会分配一个新的线程来处理，在处理过程中涉及到下面类中的方法都属于相同的一一个线程:

LoginCheckFilter的doFilter方法
EmployeeController的update方法
MyMetaObjectHandler的updateFill方法

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

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

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

什么是ThreadLocal?
ThreadLocal并不是一个Thread,而是Thread的局部变量。

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

ThreadLocal常用方法:

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

我们可以

在LoginCheckFilter的doFilter方法中获取当前登录用户id,并调用ThreadLocal的set方法来设置当前线程的线程局部变量的值(用户id)
然后在MyMetaObjectHandler的updateFill方法中调用ThreadLocal的get方法来获得当前线程所对应的线程局部变量的值(用户id)。

2.2.2编写BaseContext工具类

基于ThreadLocal封装的工具类

package com.jq.commom;

/**
 * 基于ThreadLocal封装工具类，用于保存和获取当前用户的id
 */
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.2.3修改LoginCheckFilter的doFilter方法

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

package com.jq.filter;

import com.alibaba.fastjson.JSON;
import com.jq.commom.BaseContext;
import com.jq.commom.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.AntPathMatcher;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * 自定义过滤器
 * 检查用户是否已经完成登录
 */
@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、获取本次请求的URI
         * 2、判断本次请求是否需要处理
         * 3、如果不需要处理，则直接放行
         * 4、判断登录状态，如果已登录，则直接放行
         * 5、如果未登录则返回未登录结果
         */
        //1、获取本次请求的URI
        String requestURI =request.getRequestURI();// /backend/index.html
        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"));
            
            //获取用户id
            Long empId=(Long) request.getSession().getAttribute("employee");
            //调用BaseContext来设置当前用户登录的id
            BaseContext.setCurrentId(empId);



            filterChain.doFilter(request,response);
            return;
        }
        log.info("用户未登录");
        //5、如果未登录则返回未登录结果,通过输出流的方式向客户端页面响应数据
        response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));

        return;


    }

    /**
     * 路径匹配，检查本次请求是否需要放行
     * @param urls
     * @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;
    }
}

2.2.修改MyMetaObjectHandler方法

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

package com.jq.commom;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.java.Log;
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("公共字段自动填充[insertFill]...");
        log.info(metaObject.toString());
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("createUser", BaseContext.getCurrentId());//调用BaseContext获取登录用户的id
        metaObject.setValue("updateUser", BaseContext.getCurrentId());//调用BaseContext获取登录用户的id

    }

    /**
     * 更新操作自动填充
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充[updateFill]...");
        log.info(metaObject.toString());

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

        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", BaseContext.getCurrentId());//调用BaseContext获取登录用户的id
    }
}