SpringBoot Mybatis Plus公共字段自动填充功能
一.应用场景
平时在建对象表的时候都会有最后修改时间,最后修改人这两个字段,对于这些大部分表都有的字段,每次在新增和修改的时候都要考虑到这几个字段有没有传进去,很麻烦。mybatisPlus有一个很好的解决方案。也就是公共字段自动填充的功能。一般满足下面条件的字段就可以使用此功能:
这个字段是大部分表都会有的。
这个字段的值是固定的,或则字段值是可以在后台动态获取的。
常用的就是last_update_time,last_update_name这两个字段。
二.配置MybatisPlus
导包:只需要注意的一点就是,mybatisPlus是在2.0.6版本才支持的更新数据公共字段自动填充,之前都是只支持新增数据的时候可以使用。
如果是之前配置过MybatisPlus的同学只需要添加以下几个步骤:
继承IMetaObjectHandler抽象类,实现insertFill()新增数据时需要填充的字段设置和updateFill()更新数据的时候需要填充的字段设置这两个方法:
packageio.z77z.util; importjava.util.Date; importorg.apache.ibatis.reflection.MetaObject; importorg.apache.shiro.SecurityUtils; importorg.springframework.stereotype.Component; importcom.baomidou.mybatisplus.mapper.MetaObjectHandler; importio.z77z.entity.SysUser; /**mybatisplus自定义填充公共字段,即没有传的字段自动填充*/ @Component publicclassMyMetaObjectHandlerextendsMetaObjectHandler{ //新增填充 @Override publicvoidinsertFill(MetaObjectmetaObject){ ObjectlastUpdateNameId=metaObject.getValue("lastUpdateNameId"); ObjectlastUpdateTime=metaObject.getValue("lastUpdateTime"); //获取当前登录用户 SysUseruser=(SysUser)SecurityUtils.getSubject().getPrincipal(); if(null==lastUpdateNameId){ metaObject.setValue("lastUpdateNameId",user.getId()); } if(null==lastUpdateTime){ metaObject.setValue("lastUpdateTime",newDate()); } } //更新填充 @Override publicvoidupdateFill(MetaObjectmetaObject){ insertFill(metaObject); } }
注意:getValue()方法的参数是pojo类里面的变量(驼峰的命名方式)。
在mybatisplus的配置文件中公共字段生成类的bean:
//MP全局配置,更多内容进入类看注释 GlobalConfigurationglobalConfig=newGlobalConfiguration(); //配置公共字段自动填写 globalConfig.setMetaObjectHandler(newMyMetaObjectHandler());
也就是将刚刚写的公共字段填充的设置设置到MP全局配置的对象中。
填充的字段需要忽略验证,在表对象pojo类的对应属性上添加下面注解:
/** *最后修改人Id */ @TableField(value="last_update_id",validate=FieldStrategy.NOT_EMPTY) privateStringlastUpdateNameId; /** *最后修改时间 */ @TableField(value="last_update_time",validate=FieldStrategy.NOT_EMPTY) privateDatelastUpdateTime;
原因:因为调用更新和插入的方法时,会验证你所传的属性是否为空,来判断是否该更新和插入这个属性,这个就和公共字段自动填充相冲突了,所以需要这个注解来标识此属性不需要验证。不然在插入的时候就会填充失败。
三.编写测试类
//公共字段自动填充 //1.在mybatisplus的配置文件中公共字段生成类的bean //2.实现IMetaObjectHandler类 //3.忽略对应字段的为空检测,在pojo类的属性上添加@TableField(value="last_update_name_id",validate=FieldStrategy.IGNORED) @Test publicvoidpublicTest(){ SysUseruser=newSysUser(); user.setEmail("1093615728@qq.com"); user.setNickname("z77z"); user.setPswd("123123"); user.setStatus("1"); sysUserService.insert(user); sysUserService.selectById(user.getId()); SysUseruser1=newSysUser(); user1.setPswd("123"); user1.setId(user.getId()); sysUserService.updateById(user1); sysUserService.selectById(user.getId()); }
四.测试日志
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.insert-==> Preparing:INSERTINTOsys_user(id,nickname,email,pswd,`status`,last_update_name_id,last_update_time)VALUES(?,?,?,?,?,?,?)
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.insert-==>Parameters:6634923de4a14b6ca3bac5fdf31563a8(String),z77z(String),1093615728@qq.com(String),123123(String),1(String),123(String),2017-04-2319:35:26.58(Timestamp)
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.insert-<== Updates:1
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.selectById-==> Preparing:SELECTid,nickname,email,pswd,last_login_timeASlastLoginTime,`status`,last_update_name_idASlastUpdateNameId,create_name_idAScreateNameId,last_update_timeASlastUpdateTime,create_timeAScreateTimeFROMsys_userWHEREid=?
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.selectById-==>Parameters:6634923de4a14b6ca3bac5fdf31563a8(String)
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.selectById-<== Total:1
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.updateById-==> Preparing:UPDATEsys_userSETpswd=?,last_update_name_id=?,last_update_time=?WHEREid=?
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.updateById-==>Parameters:123(String),123(String),2017-04-2319:35:26.637(Timestamp),6634923de4a14b6ca3bac5fdf31563a8(String)
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.updateById-<== Updates:1
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.selectById-==> Preparing:SELECTid,nickname,email,pswd,last_login_timeASlastLoginTime,`status`,last_update_name_idASlastUpdateNameId,create_name_idAScreateNameId,last_update_timeASlastUpdateTime,create_timeAScreateTimeFROMsys_userWHEREid=?
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.selectById-==>Parameters:6634923de4a14b6ca3bac5fdf31563a8(String)
2017/04/23-19:35:26[main]DEBUGio.z77z.dao.SysUserMapper.selectById-<== Total:1
五.总结
本来是打算创建人和创建时间,也使用这种方法处理的,最后发现,如果将这两个字段也忽略为空的判断,也就是加上validate=FieldStrategy.NOT_EMPTY,在更新数据的时候会将创建人和创建时间一起更新了,不传的话就会更新为空。所以本人觉得这个mybatisPlus这个公共字段自动填充功能是不错,但是在正真用的上的需求上面使用的时候还不够完善。
以上所述是小编给大家介绍的SpringBootMybatisPlus公共字段自动填充功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持!