Mybatis plus 3.x 公用字段 全局字段填充配置 Spring Boot

最新推荐文章于 2023-11-23 23:13:53 发布
最新推荐文章于 2023-11-23 23:13:53 发布
阅读量776 收藏 3
点赞数
分类专栏： mybatis plus springboot 文章标签： mysql spring spring boot 数据库 mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qianlingo/article/details/108082073
版权

文章用到的技术框架版本如下：

Mybatis Plus 3.3.2

Spring Boot 2.3.2.RELEASE

MySQL 8.0

设计背景

在设计表结构的时候，往往会有一些公用的字段，如创建人编号(create_user_id)，最后修改人编号(last_update_user_id)、创建时间(create_time)、最后修改时间（last_update_time）等。

表结构

create table sys_user
(
    user_id        varchar(36)   not null comment '用户编号',
    user_name      varchar(36)   not null comment '用户名称',
    password       varchar(30)   not null comment '密码(demo项目，明文录入)',
    status         int default 1 not null comment '状态(0:禁用,1:启用)',
    create_time    datetime      null comment '创建时间',
    update_time    datetime      null comment '修改时间',
    create_user_id varchar(36)   null comment '创建人编号',
    update_user_id varchar(36)   null comment '修改人编号',
    primary key(user_id)
) comment '用户数据表';

在以往的项目开发的过程中，对上述字段的录入方式差不多都是这样的set方法：

//录入创建时间
sysUser.setCreateTime(new Date());
//录入创建人
sysUser.setCreateUserId(ShiroUtils.getUserId());
//other code .....

开发进度逐渐推进后，某天查看数据时出现了下方的情况：

等等！！修改人和修改时间怎么没了？？？看看代码：

/*
前台数据: 
{
    userId:'a15b6c54-e137-11ea-97ee-0242ac110002',
    password:'xxx'
}
*/

/**
*    修改用户数据
*    @param sysUser 用户数据
*/
public void updateUserData(SysUser sysUser){

    this.baseMapper.updateById(sysUser);

}

直接入库了，没有对updateTime、updateUser字段做更新...

解决方案

方案描述

针对上述这样的情况，我们可以通过自定义Mybatis-plus提供的元对象字段填充控制器抽象类，实现公共字段自动写入。

废话不多说，直接上类：

元对象字段填充控制器抽象类

package com.qianlingo.mybatisplushandlerdemo.config;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.context.annotation.Configuration;

/**
 * MetaObjectHandler
 * <p>
 * 官方注释：
 * 元对象字段填充控制器抽象类，实现公共字段自动写入
 * 所有入参的 MetaObject 必定是 entity 或其子类的 MetaObject
 * </p>
 * @author qianlingo
 * @date 2020/8/18
 */
@Configuration
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * 插入元对象字段填充（用于插入时对公共字段的填充）
     * 需字段加入
     * 注解: TableField(fill = FieldFill.INSERT)
     * or
     * 注解: TableField(fill = FieldFill.INSERT_UPDATE)
     * @param metaObject 元对象
     */
    @Override
    public void insertFill(MetaObject metaObject) {

    }

    /**
     * 更新元对象字段填充（用于更新时对公共字段的填充）
     * 需字段加入
     * 注解: TableField(fill = FieldFill.UPDATE)
     * or
     * 注解: TableField(fill = FieldFill.INSERT_UPDATE)
     * @param metaObject 元对象
     */
    @Override
    public void updateFill(MetaObject metaObject) {

    }
}

我使用的是较新的3.3.2版本Mybatis-Plus，MetaObjectHandler类是通过实现进行自定义的，翻看了很多博文都是通过继承的，应该版本不同自定义的方式不同，大家可留意一下。

方法讲解

insertFill方法

在实体类字段顶上加入fii属性为INSERT或INSERT_UPDATE的@TableField注解后，进行数据库操作时会进入该方法。

    /**
     * 创建者
     */
    @ApiModelProperty(value = "创建者")
    @TableField(fill = FieldFill.INSERT)
    private String createUserId;

updateFill方法

在实体类字段顶上加入fii属性为UPDATE或INSERT_UPDATE的@TableField注解后，进行数据库操作时会进入该方法。

对@TableField(fill=XXX)注解的全局配置，后面会花时间分Mybatis-plus不同版本进行讲解，本文不做过多展开。

    /**
     * 更新者
     */
    @ApiModelProperty(value = "更新者")
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private String updateUserId;

OK，接下来我们对两个方法具体的业务代码进行编写！

首先是insertFill方法：

/**
     * 插入元对象字段填充（用于插入时对公共字段的填充）
     * 需字段加入
     * 注解: TableField(fill = FieldFill.INSERT)
     * or
     * 注解: TableField(fill = FieldFill.INSERT_UPDATE)
     * @param metaObject 元对象
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        //填充create_time字段公用数据
        if (metaObject.hasGetter("createTime") && metaObject.hasGetter("createTime")) {
            setFieldValByName("createTime", new Date(), metaObject);
        }
        //填充 createUserId 字段公用数据
        if (metaObject.hasGetter("createUserId") && metaObject.hasGetter("createUserId")) {
            setFieldValByName("createUserId", ADMIN_USER_ID, metaObject);
        }
        //填充 updateTime 字段公用数据
        if (metaObject.hasGetter("updateTime") && metaObject.hasGetter("updateTime")) {
            setFieldValByName("updateTime", new Date(), metaObject);
        }
        //填充 updateUserId 字段公用数据
        if (metaObject.hasGetter("updateUserId") && metaObject.hasGetter("updateUserId")) {
            setFieldValByName("updateUserId", ADMIN_USER_ID, metaObject);
        }
    }

metaObject.hasGetter(String name) 方法:  返回boolean类型数据，判断传入的实体类是否有该属性（实体类中的属性名）的get方法。

setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject) 方法：对某个属性（实体类中的属性名）赋值。

核心方法就是上述两行啦，insertFill方法的作用，是在做新增操作时将新增、修改人和时间都做填充。

理解上述后，updateFill方法就显得很简单了，即只在做修改操作时将修改人和时间做填充即可。

 /**
     * 更新元对象字段填充（用于更新时对公共字段的填充）
     * 需字段加入
     * 注解: TableField(fill = FieldFill.UPDATE)
     * or
     * 注解: TableField(fill = FieldFill.INSERT_UPDATE)
     * @param metaObject 元对象
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        //填充 updateTime 字段公用数据
        if (metaObject.hasGetter("updateTime") && metaObject.hasGetter("updateTime")) {
            setFieldValByName("updateTime", new Date(), metaObject);
        }
        //填充 updateUserId 字段公用数据
        if (metaObject.hasGetter("updateUserId") && metaObject.hasGetter("updateUserId")) {
            setFieldValByName("updateUserId", ADMIN_USER_ID, metaObject);
        }
    }

编写测试类

package com.qianlingo.mybatisplushandlerdemo;
import java.util.UUID;

import com.qianlingo.mybatisplushandlerdemo.mybatis.domain.sys.SysUser;
import com.qianlingo.mybatisplushandlerdemo.service.sys.ISysUserService;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import javax.annotation.Resource;

/**
 * 用户测试类
 *
 * @author qianlingo
 * @date 2020/8/18
 */
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = MybatisPlusHandlerDemoApplication.class)
public class SysUserTest {

    @Resource
    private ISysUserService iSysUserService;

    @Test
    public void addTest(){
        //组装数据
        SysUser sysUser = new SysUser();
        String userId = UUID.randomUUID().toString();
        System.out.println("userId:"+userId);
        sysUser.setUserId(userId);
        sysUser.setUserName("user"+UUID.randomUUID().toString().substring(0,10));
        sysUser.setPassword("qianlingo");
        sysUser.setStatus(1);
        this.iSysUserService.save(sysUser);
        getUserData();
    }

    @Test
    public void updateTest(){
        //组装数据
        SysUser sysUser = this.iSysUserService.getById("");
        sysUser.setPassword("qianlingooo");
        this.iSysUserService.updateById(sysUser);
        getUserData();
    }

    private void getUserData(){
        SysUser sysUser = this.iSysUserService.getById("");
        System.out.println(sysUser);
    }
}

分别执行addTest、updateTest方法，可查看到数据变化：

2020-08-18 18:44:58.918  INFO 3819 --- [           main] c.q.mybatisplushandlerdemo.SysUserTest   :  开始执行 addTest 方法
userId:c32ad96f-ff9f-4642-968c-89ef0a6fa4e0
2020-08-18 18:44:58.994  INFO 3819 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
2020-08-18 18:44:59.280  INFO 3819 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
2020-08-18 18:44:59.291 DEBUG 3819 --- [           main] c.q.m.m.mapper.sys.SysUserMapper.insert  : ==>  Preparing: INSERT INTO sys_user ( user_id, user_name, password, status, create_time, update_time, create_user_id, update_user_id ) VALUES ( ?, ?, ?, ?, ?, ?, ?, ? ) 
2020-08-18 18:44:59.360 DEBUG 3819 --- [           main] c.q.m.m.mapper.sys.SysUserMapper.insert  : ==> Parameters: c32ad96f-ff9f-4642-968c-89ef0a6fa4e0(String), user4d0f44a5-8(String), qianlingo(String), 1(Integer), 2020-08-18 18:44:58.989(Timestamp), 2020-08-18 18:44:58.989(Timestamp), a15b6c54-e137-11ea-97ee-0242ac110002(String), a15b6c54-e137-11ea-97ee-0242ac110002(String)
2020-08-18 18:44:59.374 DEBUG 3819 --- [           main] c.q.m.m.mapper.sys.SysUserMapper.insert  : <==    Updates: 1
2020-08-18 18:44:59.429 DEBUG 3819 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : ==>  Preparing: SELECT user_id,user_name,password,status,create_time,update_time,create_user_id,update_user_id FROM sys_user WHERE user_id=? 
2020-08-18 18:44:59.448 DEBUG 3819 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : ==> Parameters: c32ad96f-ff9f-4642-968c-89ef0a6fa4e0(String)
2020-08-18 18:44:59.743 DEBUG 3819 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : <==      Total: 1
SysUser(userId=c32ad96f-ff9f-4642-968c-89ef0a6fa4e0, userName=user4d0f44a5-8, password=qianlingo, status=1, createTime=Tue Aug 18 18:44:59 CST 2020, updateTime=Tue Aug 18 18:44:59 CST 2020, createUserId=a15b6c54-e137-11ea-97ee-0242ac110002, updateUserId=a15b6c54-e137-11ea-97ee-0242ac110002)

2020-08-18 18:45:50.038  INFO 3824 --- [           main] c.q.mybatisplushandlerdemo.SysUserTest   :  开始执行 updateTest 方法
2020-08-18 18:45:50.090  INFO 3824 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
2020-08-18 18:45:50.383  INFO 3824 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
2020-08-18 18:45:50.402 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : ==>  Preparing: SELECT user_id,user_name,password,status,create_time,update_time,create_user_id,update_user_id FROM sys_user WHERE user_id=? 
2020-08-18 18:45:50.444 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : ==> Parameters: c32ad96f-ff9f-4642-968c-89ef0a6fa4e0(String)
2020-08-18 18:45:50.470 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : <==      Total: 1
2020-08-18 18:45:50.612 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.updateById   : ==>  Preparing: UPDATE sys_user SET user_name=?, password=?, status=?, create_time=?, update_time=?, create_user_id=?, update_user_id=? WHERE user_id=? 
2020-08-18 18:45:50.629 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.updateById   : ==> Parameters: user4d0f44a5-8(String), qianlingooo(String), 1(Integer), 2020-08-18 18:44:59.0(Timestamp), 2020-08-18 18:45:50.611(Timestamp), a15b6c54-e137-11ea-97ee-0242ac110002(String), a15b6c54-e137-11ea-97ee-0242ac110002(String), c32ad96f-ff9f-4642-968c-89ef0a6fa4e0(String)
2020-08-18 18:45:50.636 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.updateById   : <==    Updates: 1
2020-08-18 18:45:50.637 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : ==>  Preparing: SELECT user_id,user_name,password,status,create_time,update_time,create_user_id,update_user_id FROM sys_user WHERE user_id=? 
2020-08-18 18:45:50.637 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : ==> Parameters: c32ad96f-ff9f-4642-968c-89ef0a6fa4e0(String)
2020-08-18 18:45:50.640 DEBUG 3824 --- [           main] c.q.m.m.m.sys.SysUserMapper.selectById   : <==      Total: 1
SysUser(userId=c32ad96f-ff9f-4642-968c-89ef0a6fa4e0, userName=user4d0f44a5-8, password=qianlingooo, status=1, createTime=Tue Aug 18 18:44:59 CST 2020, updateTime=Tue Aug 18 18:45:51 CST 2020, createUserId=a15b6c54-e137-11ea-97ee-0242ac110002, updateUserId=a15b6c54-e137-11ea-97ee-0242ac110002)

create_time、update_time、create_user_id、update_user_id四个字段均按需求自动填充了！

结尾

文章的相关代码已同步上传至Github和Gitee了，如果对文章有不清楚的地方何不看看代码？:)

GitHub: https://github.com/qianlingo/mybatis-plus-handler-demo

Gitee: https://gitee.com/qianlingooo/mybatis-plus-handler-demo

qianlingo
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
spring-boot-mybatis-plus.zip
09-04
适合spring-boot2.0整合mybatis-plus例子
SpringBoot Mybatis Plus公共字段自动填充功能
08-30
主要介绍了SpringBoot Mybatis Plus公共字段自动填充功能的相关资料,需要的朋友可以参考下
Spring Boot 3.1.0，mybatis-plus 3.5.3.1安装包
最新发布
04-08
Spring Boot 3.1.0，mybatis-plus 3.5.3.1安装包
springdatajpa与mybatis-plus.pptx
04-21
springdatajpa与mybatis-plus 学习
Mybatis-plus框架使用配置
m0_46300599的博客
11-23 3303
mybatis-plus框架使用配置
Mybatis中使用＜SQL＞＜/SQL＞公共引用
Syals的博客
07-06 3742
在mybatis中使用公共SQL引用，避免频繁使用相同的SQL语句
使用Mybatis时的通用配置
qq_25447799的博客
07-24 219
编写Mybatis的工具类–MybatisUtils 在使用mybatis进行编程时是可以只创建一次Mybatis的工具类，后续则只需复制到需要使用的项目目录下的utils文件夹中即可。 因为Mybatis里的操作是官方文档所给出的，是不会有太大变动的。 package com.zhu.utils; import org.apache.ibatis.io.Resources; import org.apache.ibatis.session.SqlSession; import org.apache.
Mybatis的mapper文件和全局配置文件详解
qq_41931364的博客
01-26 4810
Mybatis的Mapper文件和全局配置文件详解1、mapper文件2、mybatis配置文件3、测试类 1、mapper文件 <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <!-- mapp
MyBatis之全局配置文件（Configuration XML）之引入外部配置文件（properties）
xiuyang_song的博客
11-27 1479
MyBatis之全局配置文件之引入外部配置文件在官网文档中可以看到的比较仔细： properties标签的作用：引入外部properties配置文件的内容。properties标签的用法 测试
MyBatis-Plus配置全局属性，并在xml中引用
甘蓝的专栏
12-25 1730
MyBatis-Plus配置全局属性，并在xml中引用。源码解读属性被解析的过程。
Mybatis-Plus3.2.0 MetaObjectHandler 无法进行公共字段全局填充
08-25
主要介绍了Mybatis-Plus3.2.0 MetaObjectHandler 无法进行公共字段全局填充，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
详解Spring boot上配置与使用mybatis plus
08-30
<groupId>org.mybatis.spring.boot <artifactId>mybatis-spring-boot-starter <version>1.1.1 <groupId>com.baomidou</groupId> <artifactId>mybatis-plus <version>2.0-beta ``` 然后，创建一个配置类，...
【无标题】mybatis 配置公共信息
iazy_boy的博客
06-29 197
mybaits-config公共信息配置
Mybatis代码生成器Mybatis-Generator使用及配置详解
热门推荐
LM_Hh的博客
08-08 1万+
XML配置文件才是Mybatis-Generator的核心，它用于控制代码生成的所有行为。所有非标签独有的公共配置的Key可以在mybatis-generator-core的PropertyRegistry类中找到。点击 IDEA 右侧 Maven，在 Plugins 下的 mybatis-generator 下，双击 mybatis-generator:generate 运行。4.执行MyBatis-Generator。
一文讲明Mybatis 的使用 超详细 【爆肝两万字教程】
做笔记\记录遇到的程序bug
11-23 434
Mybatis 超详细教程 爆肝两万字
Mybatis中的引入数据库全局变量的三种方式
qq_37745636的博客
08-09 1519
平时我们在mybatis配置文件中引入数据库全局参数的方式，都是在mybatis中直接定义，即： <!-- 数据库环境 --> <environments default="development"> <environment id="development"> <transactionManager type="JDBC" /> ...
MyBatis通用Mapper
Glory丶笨小孩
04-13 896
1. 创建通用接口 在通用接口中使用@InsertProvider,@UpdateProvider,@DeleteProvider,@SelectProvider注解配置增删改查的类和方法，并添加通用方法 public interface BaseMapper<T, E> { @InsertProvider(type = BaseMapperProvider.class, m...
03.MyBatis学习-----全局配置文件_properties_引入外部配置文件
Adela0916的博客
12-26 406
在MyBatis全局配置文件中，可以通过properties来引入外部配置文件，这里以引入外部数据库配置文件为例。 1.创建dbconfig.properties配置文件，配置数据库的相关信息。 jdbc.driver = com.mysql.jdbc.Driver jdbc.url = jdbc:mysql://localhost:3306/mybatis jdbc.username = root jdbc.password = root 2.在MyBatis全局配置文件中使用properties引入外
Spring Boot + 百度 OCR 图片文字识别功能
亦如黎明中的花朵
08-10 2486
一、知识点简介 OCR（optical character recognition）文字识别是指电子设备（例如扫描仪或数码相机）检查纸上打印的字符，然后用字符识别方法将形状翻译成计算机文字的过程。 ——OCR文字识别 - 百度百科 本篇功能是基于百度智能云人工智能接口的文字识别实现，数据请求以Spring Boot为框架。 二、准备工作 首先我们进入百度智能云-管理中心（https://console.bce.baidu.com/）创建一个新应用。 创建新应用时，勾选文字识别下的“通用文字..
mybatis plus 2.X版本使用条件构造修改指定字段
06-13
在MyBatis Plus 2.X版本中，您可以使用LambdaUpdateChainWrapper来修改指定字段。以下是一个示例： ``` public void updateUser(User user) { LambdaUpdateChainWrapper<User> updateWrapper = new LambdaUpdateChainWrapper<>(userMapper); updateWrapper.eq(User::getId, user.getId()) .set(User::getName, user.getName()) .set(User::getAge, user.getAge()) .update(); } ``` 在上面的示例中，我们使用LambdaUpdateChainWrapper来设置要更新的字段，并使用eq方法设置要更新的记录条件。最后，我们调用update方法来执行更新操作。LambdaUpdateChainWrapper是MyBatis Plus 2.X版本新引入的功能，它提供了一种更直观的方法来设置更新字段，而不需要使用UpdateWrapper或LambdaUpdateWrapper。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值