MetaObjectHandler探秘：了解对象元数据处理的奥秘

前言

大家好，我是Front_Yue，本篇文章将介绍spring boot项目中操作数据时如何自动填充创建人，创建时间等公共字段。

在 MyBatis-Plus 中，MetaObjectHandler 是一个用于处理实体对象的元对象的接口。它允许我们在插入、更新、删除等操作之前或之后，对实体对象进行自定义处理。通过 MetaObjectHandler，我们可以实现如自动填充创建时间、更新时间、删除标记等功能。

本文将详细介绍 MetaObjectHandler 的原理以及使用方式。

正文内容

一、MetaObjectHandler 原理

MetaObjectHandler 的原理主要包括以下几个方面：

1. 注册 MetaObjectHandler

在 MyBatis-Plus 的全局配置中，我们可以注册一个或多个 MetaObjectHandler 实现类。这些实现类将会在执行 CRUD 操作时被调用。

2. 拦截 CRUD 操作

MetaObjectHandler 会在执行插入、更新、删除等 CRUD 操作之前或之后进行拦截。我们可以在这些方法中对实体对象进行自定义处理。

3. 自定义处理

在 MetaObjectHandler 的方法中，我们可以根据需要对实体对象的属性进行修改或赋值。例如，自动填充创建时间、更新时间、删除标记等。

二、MetaObjectHandler 使用方式

以下是使用 MetaObjectHandler 的具体步骤：

1. 创建 MetaObjectHandler 实现类

首先，我们需要创建一个实现 MetaObjectHandler 接口的类。在这个类中，我们可以根据需要重写其中的方法。

package com.frontyue.common.core.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.frontyue.common.core.domain.LoginUser;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

/**
 *  MyMetaObjectHandler 
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Autowired
    private LoginUser loginUser;

    @Override
    public void insertFill(MetaObject metaObject) {
        setFieldValByName("createTime", LocalDateTime.now(), metaObject);
        setFieldValByName("createBy", loginUser.getUsername(), metaObject);
    }
    @Override
    public void updateFill(MetaObject metaObject) {
        setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
        setFieldValByName("updateBy", loginUser.getUsername(), metaObject);
    }
}

在上面的示例中，我们使用了 @Component 注解,确保MyMetaObjectHandler类被 Spring 管理。我们创建了一个名为MyMetaObjectHandler 的类，并实现了 MetaObjectHandler 接口。在insertFill方法中，我们自动填充了创建人和创建时间。在 updateFill方法中，我们自动更新数据库表中更新时间与更新人。

2. 使用 MetaObjectHandler

在实体类中，添加创建人、创建时间、更新人、更新时间字段：

import java.time.LocalDateTime;

public class User {
    private static final long serialVersionUID = 1L;

    @Schema(description = "用户ID")
    @TableId(value = "user_id", type = IdType.AUTO)
    private Integer userId;

    @Schema(description = "用户名")
    @TableField("username")
    private String username;

    @Schema(description = "用户昵称")
    @TableField("nick_name")
    private String nickName;

    @Schema(description = "密码")
    @TableField("password")
    private String password;
    /**
     * 创建者
     */
    @Schema(description = "创建者")
    @TableField(value = "create_by" , fill = FieldFill.INSERT)
    private String createBy;

    /**
     * 创建时间
     */
    @Schema(description = "创建时间")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss" )
    @TableField(value = "create_time" , fill = FieldFill.INSERT)
    private LocalDateTime  createTime;

    /**
     * 更新者
     */
    @Schema(description = "更新者")
    @TableField(value = "update_by" , fill = FieldFill.INSERT_UPDATE)
    private String updateBy;

    /**
     * 更新时间
     */
    @Schema(description = "更新时间")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss" )
    @TableField(value = "update_time" , fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;

    /**
     * 备注
     */
    @Schema(description = "备注")
    @TableField("remark" )
    private String remark;
}

通过以上配置，我们在操作数据库时，就不用可以去处理这些字段。

三、自定义填充规则

在上面的示例中，我们使用了 MyBatis-Plus 提供的 strictInsertFill 和 strictUpdateFill 方法来自动填充创建时间和更新时间。实际上，我们还可以根据需要自定义填充规则。

例如，我们可以在 MyMetaObjectHandler 类中添加一个新的方法，用于自动填充删除标记：

@Override
public void deleteFill(MetaObject metaObject) {
    this.strictDeleteFill(metaObject, "deleteFlag", Integer.class, 1);
}

在上面的示例中，我们使用了 strictDeleteFill 方法来自动填充删除标记。当我们执行删除操作时，MyMetaObjectHandler 的 deleteFill 方法将会被自动调用，从而实现自动填充删除标记的功能。

总结

总之，MetaObjectHandler 是 MyBatis-Plus 中一个非常实用的功能，它可以帮助我们在执行 CRUD 操作时自动进行一些常见的操作，如自动填充创建时间、更新时间、删除标记等。通过简单的配置和编写自定义的 MetaObjectHandler 实现类，我们可以轻松地实现这些功能。

最后，感谢各位小伙伴的支持陪伴，如果你喜欢我的博客内容，认可我的观点和经验分享，请点赞、收藏和评论，这将是对我最大的鼓励和支持。同时，也欢迎大家提出宝贵的意见和建议，让我能够更好地改进和完善我的文章。谢谢！