一:问题引入
在进行项目开发对数据库中进行插入更新操作时候,会涉及到一些公共字段的创建,比如创建时间,更新时间,创建人,更新人等。这时候我们可以考虑使用MybatisPlus提供的公共字段自动填充,也就是在插入或者更新时候为指定字段赋予指定的值,可以避免重复代码。
二:实现步骤
1.在实体类的属性上加入@TableField注释,指定自动填充的策略
package com.my.pro1.pojo; import com.baomidou.mybatisplus.annotation.FieldFill; import com.baomidou.mybatisplus.annotation.TableField; import lombok.Data; import java.io.Serializable; import java.time.LocalDateTime; /** * 员工实体 */ @Data public class Employee implements Serializable { private static final long serialVersionUID = 1L; @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.my.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; /** * 自定义元数据对象处理器 */ @Slf4j @Component public class MyMetaObjectHandler implements MetaObjectHandler { /** * 插入时处理 * @param metaObject */ @Override public void insertFill(MetaObject metaObject) { metaObject.setValue("createTime", LocalDateTime.now()); metaObject.setValue("updateTime", LocalDateTime.now()); } /** * 更新时处理 * @param metaObject */ @Override public void updateFill(MetaObject metaObject) { metaObject.setValue("updateTime", LocalDateTime.now()); } }
这时候就能解决时间自动填充问题,但是这时候发现一个新的问题,我们怎么获取当前登录用户的id,即怎么设置当前执行创建或者修改操作的用户的id呢?因为前面我在controller类中设置当用户登录后将该用户的id保存在session中,这时候很自然就会想到我们可以通过HttpServletRequest来获取,但是这时候问题又来了,我们怎么获取HttpServletRequest呢?我们以前的做法是在响应controller类中加上HttpServletRequest参数,然后这时候就能通过request.getsession().getAttribute()来获取id。但是现在我们是实现MetaObjectHandler接口并对其方法进行了重写,显然我们不能通过参数获取HttpServletRequest,这时候可能还会想到,Spring不是可以实现自动装配吗?我们可以通过自动装配来取得HttpServletRequest,进而得到session对象,这个想法应该是想得通的,但是我没有进行实验,因为我要通过另外一种方法来实现,那就是JDK提供的一个类----ThreadLocal,顺便借此机会熟悉一下ThreadLocal。
三:原理
在学习ThreadLocal之前,我们需要先知道一个事情,就是客户端发送的每次http请求,对应在服务端都会分配一个新的线程来处理,在处理过程中涉及到下面类中的方法都是属于同一个线程:
1)LoginFilter中的doFilter方法(拦截器)
2)controller中的update中update方法
3)MyMetaObjectHandler中的updateFill、insertFill方法
此外,ThreadLocal并不是一个Thread,而是Thread的局部变量。当使用ThreadLocal维护变量时,ThreadLocal为每个使用该变量的线程提供独立的副本,所以每个线程都可以独立地改变自己的副本,而不会影响到其他线程对应的副本,也就是线程之间的数据不是共享的,只有在线程内才能获得对应的值,而在线程外是不能访问的。
我们前面所说的三个方法都属于同一个线程,那么我们就可以通过ThreadLocal维护同一个变量从而能够在MyMetaObjectHandler中获取当前登录用户id。ThreadLocal中有两个常用的方法:
public void set(T value) 设置当前线程局部变量的值
public T get() 返回当前线程所对应的线程局部变量的值
至此,我们要做的事就很明确了,在能获取到当前用户id的方法中通过set方法设置当前线程局部变量,在MyMetaObjectHandler中通过get方法获取当前线程局部变量id的值。上面提到的三个方法中前两个都是可以获取到当前用户id的,我们任选一个,我的程序是通过拦截器来实现登录拦截的,所以我在拦截器中设置id,假如你是通过SpringBoot的过滤器来实现登录拦截,你可以在controller中设置id。为了方便调用,提供一个BaseContext工具类,然后基于ThreadLocal进行封装。
package com.my.pro1.common; /** * 基于ThreadLocal封装工具类,用户保存和获取当前登录用户id */ public class BaseContext { private static final 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(); } }
设置好工具类之后,在filter中调用setCurrent方法
//4.判断是否已经登录 if(request.getSession().getAttribute("employee") != null){ // log.info("用户已登录"); //设置当前登录用户id Long emId = (Long) request.getSession().getAttribute("employee"); BaseContext.setCurrentId(emId); //放行 filterChain.doFilter(request,response); return; }
然后我们就可以在MyMetaObjectHandler中通过get方法获取id
package com.my.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; /** * 自定义元数据对象处理器 */ @Slf4j @Component public class MyMetaObjectHandler implements MetaObjectHandler { /** * 插入时处理 * @param metaObject */ @Override public void insertFill(MetaObject metaObject) { 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.setValue("updateTime", LocalDateTime.now()); metaObject.setValue("updateUser", BaseContext.getCurrentId()); } }
至此问题解决,当然这个方法不适用于分布式系统,针对分布式系统该怎么解决我也不是很清楚,有知道的大神还请指教一下,喜欢的话麻烦点个关注,蟹蟹!