Mybatis-Plus中的MetaObjectHandler组件的使用_Java

简介

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);
        }
    }
}