一、简介
- 在我们构造器中写save或者update方法的时候需要固定的将创建时间、更新时间、创建人、更新人等手动填充,如果每次插入或更新数据时都需要手动填充这些字段,不仅会增加开发者的工作量,而且很容易出现遗漏或填写错误的情况。这些问题都会给开发过程带来不必要的麻烦。
- Mybatis-Plus公共字段自动填充是一种自动化的数据填充方式,可以自动填充一些公共字段,例如创建时间、更新时间、创建人、更新人等。这样可以避免在每次插入或更新数据时手动填充这些字段,提高开发效率,减少出错的可能性。
IDE:idea、JDK:1.8
二、实现步骤
1.在实体类的属性上加入@TableField注解,指定自动填充的策略
@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接口
Mybatis-Plus提供了一个接口MetaObjectHandler,可以实现公共字段自动填充。在插入或更新数据时会自动调用该接口中的方法来填充公共字段。只需要实现这个接口,并在实现方法中填充相应的字段即可。该接口中定义了两个方法: insertFill(MetaObject metaObject):在插入数据时自动调用该方法,用于填充公共字段。 updateFill(MetaObject metaObject):在更新数据时自动调用该方法,用于填充公共字段。
2.1 填充createTime和updateTime字段:
创建一个新的类MyMetaObjectHandler.class实现MetaObjectHandler接口,重写两个方法,并且将创建日期和更新日期赋值
/**
* 自定义元数据对象处理器
*/
@Component
@Slf4j
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());
}
}
2.2 填充createUser和updateUser字段
在自动填充createUser和updateUser时该如何动态获取当前登录用户的id,我们可以使用ThreadLocal实现
2.2.1 ThreadLocal
1.什么是ThreadLocal?
- ThreadLocal并不是一个Thread,而是Thread的局部变量。当使用ThreadLocal维护变量时,ThreadLocal为每个使用该变量的线程提供独立的变量副本,所以每一个线程都可以独立地改变自己的副本,而不会影响其它线程所对应的副本。
- ThreadLocal为每个线程提供单独一份存储空间,具有线程隔离的效果,只有在线程内才能获取到对应的值,线程外则不能访问。
2.为什么可以使用ThreadLocal?
客户端发送的每次http请求,对应的在服务端都会分配一个新的线程来处理,在处理过程中涉及到下面类中的方法都属于相同的一个线程: 1、LoginCheckFilter的doFilter方法(过滤器) 2、EmployeeController的update方法(控制器) 3、MyMetaObjectHandler的updateFill方法(自定义元数据对象处理器) 可以在上面的三个方法中分别加入下面代码(获取当前线程id)
long id = Thread.currentThread().getId( ;
log.info("线程id:{}",id);
通过观察控制台输出可以发现,一次请求对应的线程id是相同的:
3.ThreadLocal常用方法:
public void set(T value)设置当前线程的线程局部变量的值 public T get()返回当前线程所对应的线程局部变量的值
2.2.2 ThreadLocal实现步骤
1、编写BaseContext工具类,基于ThreadLocal封装的工具类 2、在LoginCheckFilter的doFilter方法中调用BaseContext来设置当前登录用户的id 3、在MyMetaObjectHandler的方法中调用BaseContext获取登录用户的id
BaseContext.class工具类:
/**
* 基于ThreadLocal封装工具类,用于保存和获取当前登录用户的id
* ThreadLocal以线程为作用域,每个单独的线程都每个数据
*/
public class BaseContext {
// 泛型为用户id的类型
private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();
/**
* 设置值
*/
public static void setCurrentId(Long id) {
threadLocal.set(id);
}
/**
* 获取值
* @return
*/
public static Long getCurrentId() {
return threadLocal.get();
}
}
LoginCheckFilter.class的doFilter方法中: (我是在登录成功后再去传入id)
// 4、判断登录状态,如果已登录,则直接放行
// 获取Session,不为空就放行
if (request.getSession().getAttribute("employee") != null) {
log.info("用户已登录,用户id为:{}", request.getSession().getAttribute("employee"));
// 在这里使用ThreadLocal传入用户id
BaseContext.setCurrentId((Long) request.getSession().getAttribute("employee"));
filterChain.doFilter(request, response);
return;
}
MyMetaObjectHandler.class自定义元数据对象处理器类中:
/**
* 自定义元数据对象处理器
*/
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
/**
* 插入操作自动填充
* @param metaObject
*/
@Override
public void insertFill(MetaObject metaObject) {
metaObject.setValue("createTime", LocalDateTime.now());
metaObject.setValue("updateTime", LocalDateTime.now());
// 获取ThreadLocal保存的id
Long currentId = BaseContext.getCurrentId();
metaObject.setValue("createUser", currentId);
metaObject.setValue("updateUser", currentId);
}
/**
* 更新操作自动填充
* @param metaObject
*/
@Override
public void updateFill(MetaObject metaObject) {
Long currentId = BaseContext.getCurrentId();
metaObject.setValue("updateTime", LocalDateTime.now());
metaObject.setValue("updateUser", currentId);
}
}
三、总结
使用Mybatis-Plus中的公共字段自动填充功能可以简化开发,步骤如下:
1.在需要使用公共字段自动填充的实体类中添加注解@TableField(fill = FieldFill.INSERT)或者@TableField(fill = FieldFill.INSERT_UPDATE),表示在插入和更新数据时自动填充公共字段。
2.创建一个MyMetaObjectHandler类并实现MetaObjectHandler接口。
3.在该类中实现insertFill和updateFill方法,用于填充公共字段。
4.填充createUser和updateUser字段需要使用ThreadLocal,编写BaseContext工具类,基于ThreadLocal封装的工具类,
然后在LoginCheckFilter的doFilter方法中调用BaseContext来设置当前登录用户的id,最后在MyMetaObjectHandler的方法中调用BaseContext获取登录用户的id
注意:我们在MyMetaObjectHandler类中是不能获得HttpSession对象的,所以不能使用HttpSession解决。
PS
大家好,我是小健,Java开发工程师一枚,我会持续发一些技术推文,偶尔也会发些工作求职,互联网热点的事情,希望各位小伙伴多多支持,如果觉得本篇文章对您有所帮助,记得点赞关注收藏喔~