公共字段自动填充
- 概要
公共字段自动填充 需要实现MetaObjectHandler接口 实现后发现无法使用request.getSession.getAttribute获取当前用户id, 因为处于同一线程下,所以使用了LocalThread线程,创建工具类实现get,set方法之后,在controller层使用setCurrentId方法用来获取用户id,在BaseContext工具类(基于ThreadLocal封装的工具类)中使用getCurrentId用来获取用户ID。
前面我们已经完成了后台系统的员工管理功能的开发,在新增员工时需要设置创建时间、创建人、修改时间、修改人等字段,在编辑员工时需要设置修改时间、修改人等字段。这些字段属于公共字段,也就是在我们的系统中很多表中都会有这些字段,如下:
而针对于这些字段,我们的赋值方式为:
A. 在新增数据时, 将createTime、updateTime 设置为当前时间, createUser、updateUser
设置为当前登录用户ID。
B. 在更新数据时, 将updateTime 设置为当前时间, updateUser设置为当前登录用户ID。
目前,在我们的项目中处理这些字段都是在每一个业务方法中进行赋值操作,如下:
如果都按照上述的操作方式来处理这些公共字段, 需要在每一个业务方法中进行操作, 编码相对冗余、繁琐,那能不能对于这些公共字段在某个地方统一处理,来简化开发呢?
- 这里我们就要使用Mybatis Plus提供的公共字段自动填充功能
Mybatis Plus公共字段自动填充,也就是在插入或者更新的时候为指定字段赋予指定的值,使用它的好处就是可以统一对这些字段进行处理,避免了重复代码。
实现步骤:
1、在实体类的属性上加入@TableField注解,指定自动填充的策略
2、按照框架要求编写元数据对象处理器,在此类中统一为公共字段赋值,此类需要实现MetaObjectHandler接口
- 在实体类里添加@TableField注解,指定自动填充策略
@TableField(fill = FieldFill.INSERT) //插入时填充字段 创建时间字段 只有我们在新增一条数据的时候来维护这个字段的值 所以这里用INSERT
private LocalDateTime createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) //插入和更新时填充字段 更新时间 不管插入和更新我们都需要重新设置这个字段的值 所以用INSERT_UPDATE
private LocalDateTime updateTime;
@TableField(fill = FieldFill.INSERT)
private Long createUser;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Long updateUser;
- 实现MetaObjectHandler接口,在类中给公共字段赋值
/**
* 自定义元数据数据对象处理器
*/
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
/**
* 新增时自动填充
* @param metaObject
*/
@Override
public void insertFill(MetaObject metaObject) {
log.info("公共字段自动填充[insert]...");