Mybatis-Plus中的MetaObjectHandler组件的使用

简介

MetaObjectHandler 是一个非常有用的组件，用于处理实体对象中的字段填充逻辑，比如自动填充创建时间、更新时间、创建人、修改人等字段。

设计理念

在现代应用程序中，数据库记录的维护常常涉及到类似于“创建时间”、“更新时间”等公共字段。如果在每次插入或更新操作中都手动处理这些字段，不仅容易出错，还增加了代码的冗余。MetaObjectHandler 的设计初衷正是为了简化这一过程，使得这些公共字段的处理变得自动化和无感知。

自动填充的优势

自动填充不仅减少了代码的冗余，还提高了数据的一致性和完整性。通过自动填充，开发者可以确保每次数据库操作都遵循相同的规则，避免了人为错误。此外，自动填充还可以提高开发效率，使开发者能够专注于业务逻辑的实现。

组件介绍

MetaObjectHandler 接口允许在不修改业务代码的情况下，对实体类中的字段进行自动填充。这通常用于记录创建时间、更新时间、创建人、修改人等元数据信息。例如，在用户注册时自动设置创建时间，在更新用户信息时自动更新最后修改时间。

此处实现自动填充创建人、修改人
创建时间、修改时间等交给MySQL进行自动填充

MetaObjectHandler 提供了以下核心方法：

• void insertFill(MetaObject metaObject): 处理插入时的字段自动填充。
• void updateFill(MetaObject metaObject): 处理更新时的字段自动填充。
• MetaObjectHandler setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject): 用于设置指定字段的值。
• Object getFieldValByName(String fieldName, MetaObject metaObject): 获取指定字段的值。
• TableInfo findTableInfo(MetaObject metaObject): 根据 MetaObject 获取对应的表信息。

默认实现

MyBatis-Plus 提供了 MetaObjectHandler 的默认实现类。开发者可以通过继承该类，来定制插入和更新时的字段填充逻辑。

严格填充策略

默认情况下，MetaObjectHandler 遵循严格填充策略，这意味着在字段已有值的情况下不会覆盖该值，而是在字段为空时才进行填充。这种策略保证了数据的一致性，并防止不必要的覆盖。

使用

实现 MetaObjectHandler 接口：
首先需要创建一个类实现 MetaObjectHandler 接口，并重写其中的方法。

package com.zk.app.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.zk.app.utils.UserThreadLocalUtil;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

/**
 * @program: ZK
 * @description: 自定义mubatisplust填充
 * @author: zk
 * @create: 2024-07-17 11:30
 **/
@Component
public class ZKMetaObjectHandler implements MetaObjectHandler {
    /**
     * 创建人字段
     */
    private static final String CREATE_USER_ID = "createUserId";
    /**
     * 修改人字段
     */
    private static final String UPDATE_USER_ID = "updateUserId";

    @Override
    public void insertFill(MetaObject metaObject) {
        this.setUserId(metaObject, true);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setUserId(metaObject, false);
    }

    private void setUserId(MetaObject metaObject, boolean isInsert) {
        Long userId = UserThreadLocalUtil.getUserId();
        if (userId > 0) {
            if (isInsert) {
                this.setFieldValByName(CREATE_USER_ID, userId, metaObject);
            }
            this.setFieldValByName(UPDATE_USER_ID, userId, metaObject);
        }
    }
}

通过insertFill与updateFill在新增/更新时进行自动填充
UserThreadLocalUtil为ThreadLocal，主要为存储当前线程的用户信息

到此这篇关于Mybatis-Plus中的MetaObjectHandler组件的使用的文章就介绍到这了,更多相关Mybatis-Plus MetaObjectHandler 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！