java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > Mybatis-Plus公共字段自动赋值

Mybatis-Plus实现公共字段自动赋值的方法

作者：赵广陆

这篇文章主要介绍了Mybatis-Plus实现公共字段自动赋值的方法，涉及到通用字段自动填充的最佳实践总结，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

1 mybatis-plus实现自动填充指定字段

首先了解MetaObjectHandler MetaObjectHandler接口是mybatisPlus为我们提供的的一个扩展接口，我们可以利用这个接口在我们插入或者更新数据的时候，为一些字段指定默认值。Mybatis plus 为我们提供了一种一劳永逸的自动化赋值方式。

1.1 需要修改的字段在模型类上添加

@TableField(fill = FieldFill.xxx) 注解。

FieldFill的选项：

在这里插入图片描述

哪个字段在什么时候填充需要手动设置注解

在这里插入图片描述

1.2 新建一个MetaObjectHandler的实现类

MyMetaObjectHandler

package com.oldlu;
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: oldlu
   * @date: 2022年7月3日
   */
  @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: oldlu
   */
  @Override
  public void updateFill(MetaObject metaObject) {
    this.setFieldValByName("updateBy", "admin", metaObject);
  }
}

完成之后就可以使用了

**注意：**当你设置了逻辑删除，在逻辑删除的时候，是不会进行修改填充的，这个需要注意一下。

2 通用字段自动填充的最佳实践总结

在进行持久层数据维护（新增或修改）的时候，我们通常需要记录一些非业务字段，比如：create_time、update_time、update_by、create_by等用来维护数据记录的创建时间、修改时间、修改人、创建人等信息。通常情况下我们需要对这些字段进行手动赋值。赋值的过程也比较冗余，都是重复操作。

xxxYyyZzz.setUpdateBy("oldlu");    //数据记录更新操作人
xxxYyyZzz.setUpdateTime(new Date());   //数据记录更新操作的时间

2.1 调整数据库表结构

以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 '本条记录的修改时间';

2.2 通用维护信息父类-自动赋值的字段

既然我们对某一张表的数据进行新增创建、修改信息的维护，我们的实体类也要做必要的调整。为了避免为每一个实体类都加上这四个成员变量，我们定义一个父类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;
}

2.3 实体类的实现

下文实体类XxxYyyZzz对应数据库中的xxx_yyy_zzz表，除了以上四个通用字段，xxx_yyy_zzz表还包含其他的业务字段。

@Data
@EqualsAndHashCode(callSuper = true)
public class XxxYyyZzz extends BaseColumns {
    //其他的属性字段
}

2.4 自动赋值的规则

@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中获取当前登录用户的用户名。（你的系统里面获取当前登录用户名方法和我的不一样，但总之可以获取到）

2.5 实现效果

比如在进行数据更新的时候，下面的这两行代码就不需要写了，由updateFill(MetaObject metaObject)自动完成

//xxxYyyZzz.setUpdateBy("zimug");    //数据记录更新操作人
//xxxYyyZzz.setUpdateTime(new Date());   //数据记录更新操作的时间
xxxYyyZzzMapper.updateById(xxxYyyZzz);

同理，在数据insert操作的时候，insertFill(MetaObject metaObject)将被自动执行。

到此这篇关于Mybatis-Plus实现公共字段自动赋值的文章就介绍到这了,更多相关Mybatis-Plus公共字段自动赋值内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文