SpringBoot项目公共字段自动填充

在项目开发过程中，部分字段更新无需人工干预，但每次操作都需对其进行更新，常见的员工的新增修改时间、仓库物品库存的更新时间等，我们可在逻辑处理时，将时间字段设置成公共字段，Mybatis-Plus提供了这个功能，可提升开发效率。

1.引入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.1</version>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
</dependency>

引入mybatis-plus和lombok依赖，lombok依赖可以省去实体类中的setter和getter方法，让代码更加简洁。

2.在实体类中标明哪些字段是公共字段

我们以员工实体类为例

@Data
public class User implements Serializable{

    private long id;
    
    private String name;

    private int age;

    private String address;

    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;

    @TableField(fill = FieldFill.INSERT)
    private long createUserID;

    @TableField(fill = FieldFill.UPDATE)
    private long updateUserID;
}

TableField注解可以指定哪些字段作为公共字段进行自动填充，注解内参数采用枚举的方式，表明是在什么情况下作为公共字段，INSERT代表添加操作时自动填充，INSERT_UPDATE代表添加或更新操作时自动填充。

实现Serializable接口是为了支持User实体类的序列化和反序列化功能，可让实体对象转化为字节流的形式在网络进行传输。

3.创建自定义元数据对象处理器

@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler{

    @Override
    public void insertFill(MetaObject metaObject){
        log.info("添加操作时公共字段填充...");
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("更新操作时公共字段填充...");
        metaObject.setValue("updateTime",LocalDateTime.now());
    }

}

实现MetaObjectHandler接口后，重写insertFill和updateFill方法，方法见名知义，在添加和修改操作时进行字段填充，这里注意setValue方法中的key一定与实体类中字段保持一致。这样就可以删除业务代码中手动设置添加或更新时间的代码了。

4.补充

若仅仅是存储时间使用上述三步即可，有些特殊场景，需要知道操作人员信息，这时由于上述三步无法拿到用户相关信息也无法拿到请求参数、session等信息，这时该如何操作？我们知道传统的 Servlet 编程模型中是每个请求对应一个独立的线程，基于threadLocal封装成一个工具类，可以进行简单数据的存储调用。

public MyThreadLocal{
    
    private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();
    

    public static void setUserID(Long id){
        threadLocal.set(id);
    }

    public static Long getUserID(){
        return threadLocal.get();
    }
   
}

这里ThreadLocal中有个泛型，我选择Long,因为User类中ID字段类型是long类型，我们可以通过get、set方法进行数据存储和获取用户的ID信息。

在拦截器处将用户ID存储进ThreadLocal中短暂存储

if (request.getSession().getAttribute("user") != null) {
    Long userID = (Long) request.getSession().getAttribute("user");
    //将id存入ThreadLocal的共享域中
    MyThreadLocal.setUserID(userID );

    filterChain.doFilter(request,response);
    return;
}

在MyMetaObjectHandler类中调用处进行获取即可

@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler{

    @Override
    public void insertFill(MetaObject metaObject){
        log.info("添加操作时公共字段填充...");
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        Long userID = MyThreadLocal.getUserID();
        metaObject.setValue("createUserID", userID);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("更新操作时公共字段填充...");
        metaObject.setValue("updateTime",LocalDateTime.now());
        Long userID = MyThreadLocal.getUserID();
        metaObject.setValue("updateUserID", userID);
    }

}

当然上述过程中未作鲁棒性判断，可能会出现userID为空的情况，若数据库字段又设置了该字段不能为空，那么在入库操作时就会报错，读者应根据自己业务情况，适当增加鲁棒性，提升用户体验。