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公共字段自动填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 提升网络请求稳定性HttpClient的重试机制深入理解

    提升网络请求稳定性HttpClient的重试机制深入理解

    这篇文章主要为大家介绍了提升网络请求稳定性HttpClient的重试机制深入理解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-10-10
  • 8个Spring事务失效场景详解

    8个Spring事务失效场景详解

    相信大家对Spring种事务的使用并不陌生,但是你可能只是停留在基础的使用层面上。今天,我们就简单来说下Spring事务的原理,然后总结一下spring事务失败的场景,并提出对应的解决方案,需要的可以参考一下
    2022-12-12
  • Spring JPA配置文件Eclipse报错如何解决

    Spring JPA配置文件Eclipse报错如何解决

    这篇文章主要介绍了Spring JPA配置文件Eclipse报错如何解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10
  • Java interrupt()方法使用实例介绍

    Java interrupt()方法使用实例介绍

    一个线程在未正常结束之前, 被强制终止是很危险的事情. 因为它可能带来完全预料不到的严重后果比如会带着自己所持有的锁而永远的休眠,迟迟不归还锁等。 所以你看到Thread.suspend, Thread.stop等方法都被Deprecated了
    2023-02-02
  • Mybatis注解开发@Select执行参数和执行sql语句的方式(最新详解)

    Mybatis注解开发@Select执行参数和执行sql语句的方式(最新详解)

    @Select 是 Mybatis 框架中的一个注解,用于执行 SQL 查询语句,并把查询结果映射到指定的 Java 对象中,这篇文章主要介绍了Mybatis注解开发@Select执行参数和执行sql语句的方式,需要的朋友可以参考下
    2023-07-07
  • Spring Security+JWT如何实现前后端分离权限控制

    Spring Security+JWT如何实现前后端分离权限控制

    本篇将手把手教你用 Spring Security + JWT 搭建一套完整的登录认证与权限控制体系,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-04-04
  • Spring websocket并发发送消息异常的解决

    Spring websocket并发发送消息异常的解决

    本文主要介绍了 Spring websocket并发发送消息异常的解决,当多个线程同时尝试通过 WebSocket 会话发送消息时,会抛出异常,下面就来解决一下,感兴趣的可以了解一下
    2023-09-09
  • 自己动手写一个java版简单云相册

    自己动手写一个java版简单云相册

    这篇文章主要为大家分享了自己动手写的一个java版简单云相册,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-07-07
  • springboot整合jsp,实现公交车站路线图

    springboot整合jsp,实现公交车站路线图

    这篇文章主要介绍了springboot整合jsp,实现公交车站路线图的步骤,帮助大家更好的理解和使用springboot框架,感兴趣的朋友可以了解下
    2021-01-01
  • Java使用正则表达式判断字符串是否以字符开始

    Java使用正则表达式判断字符串是否以字符开始

    这篇文章主要介绍了Java使用正则表达式判断字符串是否以字符开始的相关资料,需要的朋友可以参考下
    2017-06-06

最新评论