欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2022-05-13 14:54:55
在进行持久层数据维护(新增或修改)的时候,我们通常需要记录一些非业务字段,比如:create_time、update_time、update_by、create_by等用来维护数据记录的创建时间、修改...

在进行持久层数据维护(新增或修改)的时候,我们通常需要记录一些非业务字段,比如: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通用字段自动填充的资料请关注其它相关文章!