SpringBoot基于MyBatisPlus实现公共字段自动填充

 更新时间:2025年08月21日 08:47:25   作者:future romance  
本文介绍了一种在MyBatisPlus中实现公共字段自动填充的方法,包括创建MetaObjectHandler实现类和在实体类中添加注解,具有一定的参考价值,感兴趣的可以了解一下

问题背景

在增加或修改记录时,常常需要对一些公共字段进行设置,如创建时间(createTime)、创建人(createUser)、修改时间(updateTime)、修改人(updateUser),这些信息一般不来自于网页请求。实际项目中可能有很多种Entity(实体类),对每一个Entity对应的业务代码中都要写这些针对公共字段的操作,造成了代码的大量重复。

因此,可以创建一个用于公共字段自动填充的类,使得公共字段实现自动填充。

实现方式

主要分为两大部分:

  • 1. MetaObjectHandler实现类创建
  • 2. 实体类中公共字段添加注解

1. MetaObjectHandler实现类创建

首先,建立一个MetaObjectHandler接口的实现类(MetaObjectHandler是MyBatisPlus提供的接口)

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

之后,重写相关方法 (insertFill(MetaObject metaObject) 和 updateFill(MetaObject metaObject) )

@Override
    public void insertFill(MetaObject metaObject) {
        log.info("公共字段自动填充[insert]...");
        log.info("线程id:{}", Thread.currentThread().getId());

        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("createUser", threadLocal.get());  // 动态填充 填充当前登录的用户的 ID
        metaObject.setValue("updateUser", threadLocal.get());  // 动态填充 填充当前登录的用户的 ID
    }


    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充[update]...");
        log.info("线程id:{}", Thread.currentThread().getId());

        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", threadLocal.get());
    }

注意:在对createUser和updateUser进行设置时(通常是设置id),无法拿到session,因此不能通过session的方式获取id。这里使用的是ThreadLocal

需要知道的是,页面向服务器发送的每一个请求,在服务器端都会有一个独立的线程根据该请求进行一系列操作。例如,页面发来一个修改用户的请求,到了服务器端,拦截器的preHandle方法、controller层的update方法,以及公共字段填充类的updateFill方法都是由同一个线程执行的

因此,可以在拦截器执行preHandle方法时,将session中的id数据保存到ThreadLocal对象中,在进行公共字段填充时,再将id从ThreadLocal对象中取出即可。

我将ThreadLocal配置成了一个Bean来管理(也可以用一个工具类来封装ThreadLocal,定义一个类变量)

ThreadLocal的Bean配置:

@Configuration
public class ThreadLocalConfig {
    @Bean
    public ThreadLocal<Long> threadLocal(){
        ThreadLocal<Long> threadLocal = new ThreadLocal<>();
        return threadLocal;
    }
}

拦截器注入ThreadLocal,并将id存入ThreadLocal:

public class MyInterceptor implements HandlerInterceptor {

    @Autowired
    ThreadLocal<Long> threadLocal;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        log.info("线程id:{}", Thread.currentThread().getId());
        threadLocal.set((Long) request.getSession().getAttribute("employeeId"));
        ...
        对session进行判断的代码
        ...
    }
}

之后,在MetaObjectHandler实现类中也对ThreadLocal的Bean进行注入

2. 实体类中公共字段添加注解

    @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;

如此,便实现了公共字段的自动填充

到此这篇关于SpringBoot基于MyBatisPlus实现公共字段自动填充的文章就介绍到这了,更多相关SpringBoot MyBatisPlus公共字段自动填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringMVC上传文件FileUpload使用方法详解

    SpringMVC上传文件FileUpload使用方法详解

    这篇文章主要为大家详细介绍了SpringMVC上传文件FileUpload的使用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • Java序列化与反序列化

    Java序列化与反序列化

    这篇文章主要介绍了Java的序列化与反序列化,序列化把一个对象Java Object变为一个二进制字节序列byte[];反序列化就是把一个二进制字节序列byte[]变为Java对象Java Object。感兴趣的小伙伴可以参考阅读
    2023-04-04
  • SpringBoot如何对LocalDateTime进行格式化并解析

    SpringBoot如何对LocalDateTime进行格式化并解析

    这篇文章主要介绍了SpringBoot如何对LocalDateTime进行格式化方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-07-07
  • java实现Linux(centos) 中docker容器下命令交互的代码(配置向导)

    java实现Linux(centos) 中docker容器下命令交互的代码(配置向导)

    小编在开发项目时遇到个需求,因为系统部署每次都要多台机器拆分部署,很麻烦,怎么配置比较方便呢,今天小编给大家介绍java实现Linux(centos) 中docker容器下命令交互的代码(配置向导),感兴趣的朋友一起看看吧
    2021-05-05
  • MyBatis insert标签及常用属性详解

    MyBatis insert标签及常用属性详解

    这篇文章主要介绍了MyBatis insert标签,insert 标签中没有 resultType 属性,只有查询操作才需要对返回结果类型进行相应的指定,需要的朋友可以参考下
    2023-10-10
  • SpringBoot中使用多线程的方法示例

    SpringBoot中使用多线程的方法示例

    这篇文章主要介绍了SpringBoot中使用多线程的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • Java稀疏数组详细图文教程

    Java稀疏数组详细图文教程

    当一个数组中的大部分元素为相同的值,可使用稀疏数组来保存该数组,可以将稀疏数组看做是普通数组的压缩,这篇文章主要给大家介绍了关于Java稀疏数组的相关资料,需要的朋友可以参考下
    2023-09-09
  • 解决IDEA报错Failed to start bean‘documentationPluginsBootstrapper‘问题

    解决IDEA报错Failed to start bean‘documentationPluginsBootstra

    这篇文章主要介绍了解决IDEA报错Failed to start bean‘documentationPluginsBootstrapper‘问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-07-07
  • java学习笔记之eclipse+tomcat 配置

    java学习笔记之eclipse+tomcat 配置

    俗话说:工欲善其事必先利其器,既然要学习java,首先把java的开发环境捣鼓一下吧,这里我们来谈谈eclipse+tomcat的配置方法。
    2014-11-11
  • springboot创建监听和处理事件的操作方法

    springboot创建监听和处理事件的操作方法

    这篇文章主要介绍了springboot创建监听和处理事件的操作方法,使用Spring Boot的事件机制来监听和处理事件有多种优势,本文给大家介绍的非常详细,需要的朋友参考下吧
    2024-07-07

最新评论