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

SpringBoot Mybatis Plus公共字段自动填充功能

程序员文章站 2024-02-26 16:32:34
一.应用场景 平时在建对象表的时候都会有最后修改时间,最后修改人这两个字段,对于这些大部分表都有的字段,每次在新增和修改的时候都要考虑到这几个字段有没有传进去,很麻烦。m...

一.应用场景

平时在建对象表的时候都会有最后修改时间,最后修改人这两个字段,对于这些大部分表都有的字段,每次在新增和修改的时候都要考虑到这几个字段有没有传进去,很麻烦。mybatisplus有一个很好的解决方案。也就是公共字段自动填充的功能。一般满足下面条件的字段就可以使用此功能:

这个字段是大部分表都会有的。

这个字段的值是固定的,或则字段值是可以在后台动态获取的。

常用的就是last_update_time,last_update_name这两个字段。

二.配置mybatisplus

导包:只需要注意的一点就是,mybatisplus是在2.0.6版本才支持的更新数据公共字段自动填充,之前都是只支持新增数据的时候可以使用。

如果是之前配置过mybatisplus的同学只需要添加以下几个步骤:

继承imetaobjecthandler抽象类,实现insertfill()新增数据时需要填充的字段设置和updatefill()更新数据的时候需要填充的字段设置这两个方法:

package io.z77z.util;
import java.util.date;
import org.apache.ibatis.reflection.metaobject;
import org.apache.shiro.securityutils;
import org.springframework.stereotype.component;
import com.baomidou.mybatisplus.mapper.metaobjecthandler;
import io.z77z.entity.sysuser;
/** mybatisplus自定义填充公共字段 ,即没有传的字段自动填充*/
@component
public class mymetaobjecthandler extends metaobjecthandler {
  //新增填充
  @override
  public void insertfill(metaobject metaobject) {
    object lastupdatenameid = metaobject.getvalue("lastupdatenameid");
    object lastupdatetime = metaobject.getvalue("lastupdatetime");
    //获取当前登录用户
    sysuser user = (sysuser)securityutils.getsubject().getprincipal();
    if (null == lastupdatenameid) {
      metaobject.setvalue("lastupdatenameid", user.getid());
    }
    if (null == lastupdatetime) {
      metaobject.setvalue("lastupdatetime", new date());
    }
  }
  //更新填充
  @override
  public void updatefill(metaobject metaobject) {
    insertfill(metaobject);
  }
}

注意:getvalue()方法的参数是pojo类里面的变量(驼峰的命名方式)。

在mybatisplus的配置文件中公共字段生成类的bean:

// mp 全局配置,更多内容进入类看注释
globalconfiguration globalconfig = new globalconfiguration();
//配置公共字段自动填写
globalconfig.setmetaobjecthandler(new mymetaobjecthandler());

也就是将刚刚写的公共字段填充的设置设置到mp全局配置的对象中。

填充的字段需要忽略验证,在表对象pojo类的对应属性上添加下面注解:

/**
 * 最后修改人id
 */
@tablefield(value="last_update_id",validate=fieldstrategy.not_empty)
private string lastupdatenameid;
/**
 * 最后修改时间
 */
@tablefield(value="last_update_time",validate=fieldstrategy.not_empty)
private date lastupdatetime;

原因:因为调用更新和插入的方法时,会验证你所传的属性是否为空,来判断是否该更新和插入这个属性,这个就和公共字段自动填充相冲突了,所以需要这个注解来标识此属性不需要验证。不然在插入的时候就会填充失败。

三.编写测试类

//公共字段自动填充
//1.在mybatisplus的配置文件中公共字段生成类的bean
//2.实现imetaobjecthandler类
//3.忽略对应字段的为空检测,在pojo类的属性上添加@tablefield(value="last_update_name_id",validate=fieldstrategy.ignored)
@test
public void publictest(){
  sysuser user = new sysuser();
  user.setemail("1093615728@qq.com");
  user.setnickname("z77z");
  user.setpswd("123123");
  user.setstatus("1");
  sysuserservice.insert(user);
  sysuserservice.selectbyid(user.getid());
  sysuser user1 = new sysuser();
  user1.setpswd("123");
  user1.setid(user.getid());
  sysuserservice.updatebyid(user1);
  sysuserservice.selectbyid(user.getid());
}

四.测试日志

2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.insert- ==>  preparing: insert into sys_user ( id, nickname, email, pswd, `status`,last_update_name_id, last_update_time ) values ( ?, ?, ?, ?, ?,?, ? )
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.insert- ==> parameters: 6634923de4a14b6ca3bac5fdf31563a8(string), z77z(string), 1093615728@qq.com(string), 123123(string), 1(string), 123(string), 2017-04-23 19:35:26.58(timestamp)
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.insert- <==    updates: 1
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.selectbyid- ==>  preparing: select id,nickname,email,pswd,last_login_time as lastlogintime,`status`,last_update_name_id as lastupdatenameid,create_name_id as createnameid,last_update_time as lastupdatetime,create_time as createtime from sys_user where id=?
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.selectbyid- ==> parameters: 6634923de4a14b6ca3bac5fdf31563a8(string)
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.selectbyid- <==      total: 1
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.updatebyid- ==>  preparing: update sys_user set pswd=?, last_update_name_id=?, last_update_time=? where id=?
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.updatebyid- ==> parameters: 123(string), 123(string), 2017-04-23 19:35:26.637(timestamp), 6634923de4a14b6ca3bac5fdf31563a8(string)
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.updatebyid- <==    updates: 1
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.selectbyid- ==>  preparing: select id,nickname,email,pswd,last_login_time as lastlogintime,`status`,last_update_name_id as lastupdatenameid,create_name_id as createnameid,last_update_time as lastupdatetime,create_time as createtime from sys_user where id=?
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.selectbyid- ==> parameters: 6634923de4a14b6ca3bac5fdf31563a8(string)
2017/04/23-19:35:26 [main] debug io.z77z.dao.sysusermapper.selectbyid- <==      total: 1

五.总结

本来是打算创建人和创建时间,也使用这种方法处理的,最后发现,如果将这两个字段也忽略为空的判断,也就是加上validate=fieldstrategy.not_empty,在更新数据的时候会将创建人和创建时间一起更新了,不传的话就会更新为空。所以本人觉得这个mybatisplus这个公共字段自动填充功能是不错,但是在正真用的上的需求上面使用的时候还不够完善。

以上所述是小编给大家介绍的springboot mybatis plus公共字段自动填充功能,希望对大家有所帮助