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 字段自动填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java全面细致讲解Wrapper的使用

    Java全面细致讲解Wrapper的使用

    在封装中有一种特殊的类,能够把基本的数据类型进行转换来方便实际的使用。我们在之前提到的一些数据类型,最明显的特征是所有字母为小写状态,那么经过Wrapper的包装后,首字母就变成了大写。下面我们就这种特殊的封装类Wrapper的使用
    2022-05-05
  • Java集合之HashMap用法详解

    Java集合之HashMap用法详解

    这篇文章主要介绍了Java集合之HashMap用法,结合实例形式分析了java map集合中HashMap定义、遍历等相关操作技巧,需要的朋友可以参考下
    2017-05-05
  • java的线程池框架及线程池的原理

    java的线程池框架及线程池的原理

    这篇文章主要介绍了java的线程池框架及线程池的原理的相关资料,需要的朋友可以参考下
    2017-03-03
  • SpringBoot如何根据目录路径生成接口的url路径

    SpringBoot如何根据目录路径生成接口的url路径

    这篇文章主要介绍了SpringBoot如何根据目录路径生成接口的url路径,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • SpringMVC @RequestMapping注解属性详细介绍

    SpringMVC @RequestMapping注解属性详细介绍

    通过@RequestMapping注解可以定义不同的处理器映射规则,下面这篇文章主要给大家介绍了关于SpringMVC中@RequestMapping注解用法的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-02-02
  • 深入理解java中this关键字的使用

    深入理解java中this关键字的使用

    这篇文章主要介绍了this关键字的使用,通过调用构造方法,使用this关键字调用当前对象等详细介绍了this的特点和使用,需要的朋友可以参考下
    2017-08-08
  • springboot项目配置多数据库连接的示例详解

    springboot项目配置多数据库连接的示例详解

    这篇文章主要介绍了springboot项目配置多数据库连接的示例,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2023-12-12
  • IntelliJ IDEA cmd和idea Terminal查看java版本不一致的解决方案

    IntelliJ IDEA cmd和idea Terminal查看java版本不一致的解决

    原来win10电脑上安装的是jdk8的版本,因某些原因,现在想换成jdk7的版本,修改环境变量后,在cmd中执行 [java -version]命令,显示的是7的版本,遇到这样的问题如何解决呢?下面小编给大家分享IntelliJ IDEA cmd和idea Terminal查看java版本不一致的解决方案,一起看看吧
    2023-09-09
  • springdata jpa使用Example快速实现动态查询功能

    springdata jpa使用Example快速实现动态查询功能

    这篇文章主要介绍了springdata jpa使用Example快速实现动态查询功能,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • 关于Java的二叉树、红黑树、B+树详解

    关于Java的二叉树、红黑树、B+树详解

    这篇文章主要介绍了关于Java的二叉树、红黑树、B+树详解,能同时具备数组查找快的优点以及链表插入和删除快的优点的数据结构就是树,需要的朋友可以参考下
    2023-05-05

最新评论