Mybatis plus通用字段自动填充的示例

 更新时间:2021年01月30日 11:38:27   作者:字母哥博客  
这篇文章主要介绍了Mybatis plus通用字段自动填充的示例,帮助大家更好的理解和使用Mybatis,感兴趣的朋友可以了解下

在进行持久层数据维护(新增或修改)的时候,我们通常需要记录一些非业务字段,比如:create_time、update_time、update_by、create_by等用来维护数据记录的创建时间、修改时间、修改人、创建人等信息。通常情况下我们需要对这些字段进行手动赋值。赋值的过程也比较冗余,都是重复操作。

  • 通常是为create_time赋值为系统的当前时间、update_time赋值为系统修改操作执行时的当前时间。
  • create_by(创建人)、update_by(修改人)赋值为当前的登录用户的用户名
xxxYyyZzz.setUpdateBy("zimug");  //数据记录更新操作人
xxxYyyZzz.setUpdateTime(new Date());  //数据记录更新操作的时间

Mybatis plus 为我们提供了一种一劳永逸的自动化赋值方式。

一、调整数据库表结构

以mysql数据库环境下的xxx_yyy_zzz表为例,在原有的表字段的基础上,添加下面的四个通用数据维护字段。

ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `create_by` VARCHAR(64) NOT NULL COMMENT '本条记录创建人';
ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `create_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '本条记录创建时间';
ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `update_by` VARCHAR(64) NOT NULL COMMENT '本条记录修改人';
ALTER TABLE `xxx_yyy_zzz` ADD COLUMN `update_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '本条记录的修改时间';

二、通用维护信息父类-自动赋值的字段

既然我们对某一张表的数据进行新增创建、修改信息的维护,我们的实体类也要做必要的调整。为了避免为每一个实体类都加上这四个成员变量,我们定义一个父类BaseColumns。

@Data
public class BaseColumns {

 /**
  * 本条记录创建人,insert操作的时候自动为该字段赋值
  */
 @TableField(fill = FieldFill.INSERT 
 private String createBy;

 /**
  * 本条记录创建时间,insert操作的时候自动为该字段赋值
  */
 @TableField(fill = FieldFill.INSERT)
 private LocalDateTime createTime;

 /**
  * 本条记录更新人,insert或update操作的时候自动为该字段赋值,select = false
  */
 @TableField(fill = FieldFill.INSERT_UPDATE,select = false) 
 private String updateBy;

 /**
  * 本条记录更新时间,insert或update操作的时候自动为该字段赋值,select = false
  */
 @TableField(fill = FieldFill.INSERT_UPDATE,select = false)
 private LocalDateTime updateTime;


}
  • fill = FieldFill.INSERT表示insert操作的时候自动为该字段赋值
  • fill = FieldFill.INSERT_UPDATE表示nsert或update操作的时候自动为该字段赋值
  • select = false表示在使用Mybatis Wrapper条件构造器进行查询的时候,不查询这个属性对应的数据库字段。数据修改时间操作人通常对于运维更有意义,所以通常不需要展示在web页面上,所以通常select查询的时候不包含它。(这个内容与我们本机的字段自动填充没有太直接的联系,但是在实际应用中是有意义的)

三、实体类的实现

下文实体类XxxYyyZzz对应数据库中的xxx_yyy_zzz表,除了以上四个通用字段,xxx_yyy_zzz表还包含其他的业务字段。

@Data
@EqualsAndHashCode(callSuper = true)
public class XxxYyyZzz extends BaseColumns {

  //其他的属性字段
}

四、自动赋值的规则

@Component
public class MybastisColumnsHandler implements MetaObjectHandler {

  @Resource
  private JwtTokenUtil jwtTokenUtil; //我的工具类,用于从Token令牌中获取登陆人信息

  //设置数据新增时候的,字段自动赋值规则
  @Override
  public void insertFill(MetaObject metaObject) {
   this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
   this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());

   this.strictInsertFill(metaObject, "createBy", String.class, jwtTokenUtil.getUsernameFromToken());
   this.strictUpdateFill(metaObject, "updateBy", String.class, jwtTokenUtil.getUsernameFromToken());
  }

  //设置数据修改update时候的,字段自动赋值规则
  @Override
  public void updateFill(MetaObject metaObject) {
   this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
   this.strictUpdateFill(metaObject, "updateBy", String.class, jwtTokenUtil.getUsernameFromToken());
  }
}
  • 在数据新增的时候,自动为createTime、updateTime、createBy、updateBy赋值,即数据初始化。
  • 在数据修改的时候,自动为updateTime、updateBy赋值。
  • JwtTokenUtil是我写的一个工具类,从当前的登录用户JWT Token中获取当前登录用户的用户名。(你的系统里面获取当前登录用户名方法和我的不一样,但总之可以获取到)

五、实现效果

比如在进行数据更新的时候,下面的这两行代码就不需要写了,由updateFill(MetaObject metaObject)自动完成

//xxxYyyZzz.setUpdateBy("zimug");  //数据记录更新操作人
//xxxYyyZzz.setUpdateTime(new Date());  //数据记录更新操作的时间

xxxYyyZzzMapper.updateById(xxxYyyZzz);

同理,在数据insert操作的时候,insertFill(MetaObject metaObject)将被自动执行。

原文链接:字母哥博客

以上就是Mybatis plus通用字段自动填充的示例的详细内容,更多关于Mybatis plus通用字段自动填充的资料请关注脚本之家其它相关文章!

相关文章

  • 使用Java方法配置Spring代码解析

    使用Java方法配置Spring代码解析

    这篇文章主要介绍了使用Java方法配置Spring代码解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • 以Java代码的方式总结几个典型的内存溢出案例

    以Java代码的方式总结几个典型的内存溢出案例

    作为程序员,多多少少都会遇到一些内存溢出的场景,如果你还没遇到,说明你工作的年限可能比较短,或者你根本就是个假程序员!哈哈,开个玩笑.今天分享给大家Java内存溢出的相关案例,希望大家在日常工作中,尽量避免写这些low水平的代码,需要的朋友可以参考下
    2021-06-06
  • SpringMVC实现数据绑定及表单标签

    SpringMVC实现数据绑定及表单标签

    这篇文章主要为大家详细介绍了SpringMVC实现数据绑定及表单标签的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-03-03
  • Java实现MD5消息摘要算法

    Java实现MD5消息摘要算法

    本篇文章主要介绍了Java实现MD5消息摘要算法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04
  • 如何在IDE部署springboot项目(有swagger和无swagger都是一样的)到服务器或者虚拟机上的docker

    如何在IDE部署springboot项目(有swagger和无swagger都是一样的)到服务器或者虚拟机上的docke

    这篇文章主要介绍了如何在IDE部署springboot项目(有swagger和无swagger都是一样的)到服务器或者虚拟机上的docker,本文给大家分享我的安装历程,需要的朋友可以参考下
    2023-01-01
  • SpringBoot+Security 发送短信验证码的实现

    SpringBoot+Security 发送短信验证码的实现

    这篇文章主要介绍了SpringBoot+Security 发送短信验证码的实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • 手写简版kedis分布式key及value服务的实现及配置

    手写简版kedis分布式key及value服务的实现及配置

    这篇文章主要为大家介绍了手写简版的kedis分布式key及value服务的实现示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-02-02
  • JMX监控的具体使用

    JMX监控的具体使用

    JMX最常见的场景是监控Java程序的基本信息和运行情况,本文主要介绍了JMX监控的具体使用,具有一定的参考价值,感兴趣的可以了解一下
    2024-02-02
  • java中long(Long)与int(Integer)之间的转换方式

    java中long(Long)与int(Integer)之间的转换方式

    这篇文章主要介绍了java中long(Long)与int(Integer)之间的转换方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • SpringBoot项目如何打包成war包

    SpringBoot项目如何打包成war包

    使用SpringBoot 开发项目,由于内置了Tomcat,所以项目可以直接启动,部署到服务器的时候,直接打成 jar 包,就可以运行了,这篇文章主要介绍了SpringBoot项目如何打包成war包,需要的朋友可以参考下
    2024-07-07

最新评论