公共字段自动填充工具
1、问题描述
在新增员工时需要设置创建时间、创建人、修改时间、修改人等字段,在编辑员工时需要设置修改时间和修改人等字段。这些字段属于公共字段,也就是很多表中都有这些字段,如下(示例):
字段 | 类型 |
---|---|
create_time | datetime |
update_time | datetime |
create_user | bigint |
update_user | bigint |
能不能对于这些公共字段在某个地方统一处理,来简化开发呢?
答案就是使用
Mybatis Plus
提供的公共字段自动填充功能。
2、实现思路
Mybatis Plus公共字段自动填充,也就是在插入或者更新的时候为指定字段赋予指定的值,使用它的好处就是可以统一对这些字段进行处理,避免了重复代码。
实现步骤:
1、在实体类的属性上加入@TableField
注解,指定自动填充的策略
package com.mannor.reggie_take_out.entity;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import lombok.Data;
import java.time.LocalDateTime;
@Data
public class Employee implements Serializable {
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、按照框架(MP)要求编写元数据对象处理器,在此类中统一为公共字段赋值,此类需要实现MetaObjectHandler
接口
我们在设置
createUser
,updateUser
的时候,在MyMetaObjectHandler
是无法根据HttpServletRequest
对象来设置,可以使用ThreadLocal
来解决此问题,它是JDK
中提供的一个类。
3、什么是ThreadLocal?
在学习ThreadLocal之前,我们需要先确认一个事情,就是客户端发送的每次http请求,对应的在服务端都会分配一个新的线程来处理,在处理过程中涉及到下面类中的方法都属于相同的一个线程:
- LoginCheckFilter的doFilter方法
- EmployeeController的update方法
- MyMetaObjectHandler的updateFill方法
可以在上面的三个方法中分别加入下面代码(获取当前线程id) :
long id = Thread.currentThread().getId() ;
log.info("线程id: {}",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)。
4、填充工具具体实现
1、编写BaseContext工具类,基于ThreadLocal封装的工具类
package com.mannor.reggie_take_out.common;
/**
* 基于ThreadLocal封装工具类,用户保存的获取当前登录的Id
* 只在当前的线程进行作用域,各个线程互不影响
*/
public class BaseContext {
private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();
/**
* 设置id
* @param id
*/
public static void setCurrentId(Long id) {
threadLocal.set(id);
}
/**
* 获取id
* @return
*/
public static Long getCurrentId() {
return threadLocal.get();
}
}
2、在LoginCheckFilter的doFilter方法中调用BaseContext来设置当前登录用户的id(在下列代码中的第四步)
package com.mannor.reggie_take_out.filter;
import com.alibaba.fastjson.JSON;
import com.mannor.reggie_take_out.common.BaseContext;
import com.mannor.reggie_take_out.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;
@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
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) {
filterChain.doFilter(request, response);
log.info("本次请求{}不需要处理", requestURI);
return;
}
// 4、判断登录状态,如果已登录,则直接放行
if (request.getSession().getAttribute("EmployeeId") != null) {
log.info("用户已经登录,用户id为:{}", request.getSession().getAttribute("EmployeeId"));
//将id存入线程变量a
Long employeeId = (Long) request.getSession().getAttribute("EmployeeId");
BaseContext.setCurrentId(employeeId);
filterChain.doFilter(request, response);
return;
}
// 5、如果未登录则返回未登录结果,通过输出流方式向客户端相应数据
log.info("用户未登录");
response.getWriter().write(JSON.toJSONString(R.error("ONTLOGIN")));
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;
}
}
在线程范围内获得id进行设置文章来源:https://www.toymoban.com/news/detail-588811.html
3、在MyMetaObjectHandler的方法中调用BaseContext获取登录用户的id文章来源地址https://www.toymoban.com/news/detail-588811.html
package com.mannor.reggie_take_out.common;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.mannor.reggie_take_out.entity.Employee;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
/**
* 自定义元数据处理器
*/
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
@Autowired
private Employee employee;
/**
* 插入操作,自动填充
*
* @param metaObject
*/
@Override
public void insertFill(MetaObject metaObject) {//metaObject里面包含insert提交的对象数据
log.info("插入操作公共填充······");
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) {//metaObject里面包含update提交的对象数据
log.info("更新操作公共填充······{}",employee);
metaObject.setValue("updateTime", LocalDateTime.now());
metaObject.setValue("updateUser", BaseContext.getCurrentId());
}
}
到了这里,关于公共字段自动填充工具的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!