MyBatis-Plus实现字段自动填充功能的示例

 更新时间:2021年11月09日 11:06:45   作者:郑清  
本文主要介绍了MyBatis-Plus实现字段自动填充功能的示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

一、前言

在项目中,我们有一些公共的字段需要做修改

如:

  • gmt_create:创建时间
  • creator_id:创建人
  • gmt_modified:修改时间
  • modifier_id:修改人

这时候我们可以采用 MyBatis-Plus 中的字段自动填充功能去实现

思路:抽取公用字段封装到BaseEntity类中,再将使用到此公共字段的类继承基类,最后由 MyBatis-Plus 帮我们实现自动填充,这样我们便可以在service服务类中减少一定代码重复量!

二、实现

1. 实体类

@Data
@TableName("t_user")
public class User extends BaseEntity<User> {

    private static final long serialVersionUID = 1L;

    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;
 
    @TableField("username")
    private String username;
    
    @Override
    protected Serializable pkVal() {
        return this.id;
    }
}

2. 公用字段 - 使用注解填充字段

如:@TableField(fill = FieldFill.INSERT)

@Getter
@Setter
public abstract class BaseEntity<T extends Model> extends Model {
    /**
     * 创建日期 - 现在时表示主动创建
     */
    @TableField(value = "gmt_create", fill = FieldFill.INSERT)
    private Date gmtCreate;
	/**
     * 修改时间 - 过去分词表示被动更新
     */
    @TableField(value = "gmt_modified", fill = FieldFill.INSERT_UPDATE)
    private Date gmtModified;
}

Ctrl 选中FieldFill进入源码可查看相应字段填充策略枚举类,如下:

public enum FieldFill {
    DEFAULT(0, "默认不处理"),
    INSERT(1, "插入填充字段"),
    UPDATE(2, "更新填充字段"),
    INSERT_UPDATE(3, "插入和更新填充字段");
    /**
     * 主键
     */
    private final int key;
    /**
     * 描述
     */
    private final String desc;
    FieldFill(final int key, final String desc) {
        this.key = key;
        this.desc = desc;
    }
    public static FieldFill getIgnore(int key) {
        FieldFill[] fis = FieldFill.values();
        for (FieldFill fi : fis) {
            if (fi.getKey() == key) {
                return fi;
            }
        }
        return FieldFill.DEFAULT;
    }
    public int getKey() {
        return this.key;
    }
    public String getDesc() {
        return this.desc;
    }
}

3. 自定义MyMetaObjectHandler字段自动填充处理类继承MetaObjectHandler

注:在 Spring Boot 中需要声明@Component 注入

/**
 *  <p> MyBatisPlus自定义字段自动填充处理类 - 实体类中使用 @TableField注解 </p>
 *
 * @description: 注意前端传值时要为null
 * @author: zhengqing
 * @date: 2019/8/18 0018 1:46
 */
@Component
public class MyMetaObjectHandler extends MetaObjectHandler {

    private static final Logger LOG = LoggerFactory.getLogger(MyMetaObjectHandler.class);

    /**
     * 创建时间
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        LOG.info(" -------------------- start insert fill ...  --------------------");
        if (metaObject.hasGetter("gmtCreate") && metaObject.hasGetter("gmtModified")) {
            setFieldValByName("gmtCreate", new Date(), metaObject);
            setFieldValByName("gmtModified", new Date(), metaObject);
        }
    }

    /**
     * 最后一次更新时间
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        LOG.info(" -------------------- start update fill ...  --------------------");
        if (metaObject.hasGetter("et.gmtModified")) {
            setFieldValByName("gmtModified", new Date(), metaObject);
        }
    }
    
}

温馨小提示:

我们在更新字段的时候要使用 et.字段名 或者 param1.字段 才会生效!

原因:我们可以debug模式查看metaObject中的属性发现多了et

在这里插入图片描述

或者 查看继承的BaseMapper类源码,我们也可以发现更新的方法中都有et

在这里插入图片描述

而插入的方法并没有et

在这里插入图片描述

另外一个注意点就是,自动填充是在执行完插入或更新方法之后,也就是说,MyBatis-Plus会在方法之后判断@TableField注解的字段有没有被手动更新,如果没有才会走自定义的实现类MyMetaObjectHandler

到此这篇关于MyBatis-Plus实现字段自动填充功能的示例的文章就介绍到这了,更多相关MyBatis-Plus 字段自动填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用IDEA向Gitee提交SpringBoot项目进行远程管理

    使用IDEA向Gitee提交SpringBoot项目进行远程管理

    本文主要介绍了使用IDEA向Gitee提交SpringBoot项目进行远程管理,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-01-01
  • java web验证码实现代码分享

    java web验证码实现代码分享

    这篇文章主要为大家分享了java web验证码的实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-06-06
  • Java超详细讲解排序二叉树

    Java超详细讲解排序二叉树

    排序二叉树的特点是一个父节点只能有左右两个子节点、左节点的值比父节点要小、右节点的值要比父节点要大,难度并不大,但是得花时间来理解
    2022-06-06
  • springboot 热启动的过程图解

    springboot 热启动的过程图解

    这篇文章主要介绍了springboot 热启动的过程图解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • 再也不用怕! 让你彻底搞明白Java内存分布

    再也不用怕! 让你彻底搞明白Java内存分布

    做Java的大都没有c++ 的那种分配内存的烦恼,因为Java 帮我们管理内存,但是这并不代表我们不需要了解Java的内存结构,因为线上经常出现内存的问题,今天聊一下内存的问题,需要的朋友可以参考下
    2021-06-06
  • 深入探究 spring-boot-starter-parent的作用

    深入探究 spring-boot-starter-parent的作用

    这篇文章主要介绍了spring-boot-starter-parent的作用详解,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,感兴趣的小伙伴可以跟着小编一起来学习一下
    2023-05-05
  • IntelliJ IDEA中新建Java class的解决方案

    IntelliJ IDEA中新建Java class的解决方案

    今天小编就为大家分享一篇关于IntelliJ IDEA中新建Java class的解决方案,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-10-10
  • java中关于转义字符的一个bug

    java中关于转义字符的一个bug

    本文主要介绍了java中关于转义字符的一个bug。具有很好的参考价值,下面跟着小编一起来看下吧
    2017-02-02
  • 详解Java中类的加载与其初始化

    详解Java中类的加载与其初始化

    这篇文章主要为大家详细介绍了Java中类的加载与其初始化的相关资料,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以了解一下
    2022-12-12
  • 将java普通项目打包成exe可执行文件的步骤记录

    将java普通项目打包成exe可执行文件的步骤记录

    将JAVA代码打包为exe文件,会让程序运行更加方便,这篇文章主要给大家介绍了关于将java普通项目打包成exe可执行文件的相关资料,需要的朋友可以参考下
    2021-07-07

最新评论