mybatis-plus 新增/修改如何实现自动填充指定字段
作者:Try 发布时间:2023-11-28 22:20:53
mybatis-plus 新增/修改 自动填充指定字段
1.需要修改的字段在模型类上添加
@TableField(fill = FieldFill.xxx) 注解。
FieldFill的选项:
哪个字段在什么时候填充需要手动设置注解
2.新建一个MetaObjectHandler的实现类
MyMetaObjectHandler
package com.demo.mp.config;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Objects;
@Component // 注入bean
public class MyMetaObjectHandler implements MetaObjectHandler {
/**
* @Description: 新增时填充
*
* @auther: zpq
* @date: 2020/11/2 2:26 下午
*/
@Override
public void insertFill(MetaObject metaObject) {
// this.setFieldValByName(字段名, 内容, metaObject:用这个对象进行填充用的,称为元数据对象);
this.setFieldValByName("createBy", "admin", metaObject);
// ================setFieldValByName 方法内的内容,有兴趣可以进去看一看,中文注释的==================================================
/// **
// * 通用填充
// *
// * @param fieldName java bean property name
// * @param fieldVal java bean property value
// * @param metaObject meta object parameter
// */
// default MetaObjectHandler setFieldValByName(String fieldName, Object fieldVal, MetaObject
// metaObject) {
// if (Objects.nonNull(fieldVal) && metaObject.hasSetter(fieldName)) {
// metaObject.setValue(fieldName, fieldVal);
// }
// return this;
// }
}
/**
* * @Description: 更新时填充
*
* @auther: zpq
* @date: 2020/11/2 11:37 上午
*/
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateBy", "admin", metaObject);
}
}
完成之后就可以使用了
注意:当你设置了逻辑删除,在逻辑删除的时候,是不会进行修改填充的,这个需要注意一下。
通用字段自动填充的最佳实践总结
在进行持久层数据维护(新增或修改)的时候,我们通常需要记录一些非业务字段,比如: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)将被自动执行。
来源:https://blog.csdn.net/qq_42094345/article/details/109448880
猜你喜欢
- 一、闭包的定义。有很多不同的人都对闭包过进行了定义,这里收集了一些。# 是引用了自由变量的函数。这个函数通常被定义在另一个外部函数中,并且引
- 前言我们知道,IOC是Spring的核心。它来负责控制对象的生命周期和对象间的关系。举个例子,我们如何来找对象的呢?常见的情况是,在路上要到
- 一、前言环境:jdk 1.8,SpringCloud Greenwich.SR2。如题,springcloud config-client启
- 问题:在用Java程序进行读写含中文的txt文件时,经常会出现读出或写入的内容会出现乱码。原因其实很简单,就是系统的编码和程序的编码采用了不
- 1.概述数据库开发一直是JAVA开发的核心之一,作为现在JAVA EE的基石框架,Spring Boot自身携带了一个JDBCTemplat
- 本文实例为大家分享了android TextView跑马灯效果的具体代码,供大家参考,具体内容如下一、要点设置四个属性android:sin
- Java线程分为两类分别为daemon线程(守护线程)和User线程(用户线程),在JVM启动时候会调用main函数,main函数所在的线程
- 官网教程一、翻转(镜像)头文件 quick_opencv.h:声明类与公共函数#pragma once#include <opencv
- mybatis if test判断入参的值1.第一种判断方式<if test=' requisition != null an
- 我们在j2ee当中,连接数据库的时候经常会用到properties配置文件,我们原来在eclipse或者myeclipse当中会在src文件
- 相信大家肯定都在电商网站买过东西,当我们看中一件喜欢又想买的东西时,这时候你又不想这么快结账,这时候你就可以放入购物车;就像我们平时去超市买
- 前言坚持是一件比较难的事,坚持并不是自欺欺人的一种自我麻痹和安慰,也不是做给被人的,我觉得,坚持的本质并没有带着过多的功利主义,如果满是功利
- 最近要给一个 Winform 项目添加功能,需要一个能显示进度条的弹窗,还要求能够中止任务,所以就做了一个,在此做个记录总结。虽然用的是比较
- 本节我们来探讨如何使用Feign构造多参数的请求。笔者以GET以及POST方法的请求为例进行讲解,其他方法(例如DELETE、PUT等)的请
- 简介AccessibilityService的设计初衷是为了辅助有身体缺陷的群体使用Android应用,它的设计贯穿着Android的控件树
- 大顶堆每个结点的值都大于或等于其左右孩子结点的值小顶堆每个结点的值都小于或等于其左右孩子结点的值对比图实现代码public class He
- 作为开发人员,掌握开发环境下的调试技巧十分有必要。我们在编写java程序的过程中,经常会遇到各种莫名其妙的问题,为了检测程序是哪里出现问题,
- 开发环境使用jdk1.8.0_60,把springboot 项目打成war包后,部署到apache-tomcat-7.0.68时报错如下,换
- 本文实例为大家分享了PropertyDescriptor反射调用set和get方法,供大家参考,具体内容如下第一段:package com.
- 这篇文章主要介绍了JAVA实现账户取款和存款操作,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以