Mybatis Plus公共字段自动填充

待我称王封你为后i 2022-11-21 04:27 228阅读 0赞

Mybatis Plus公共字段自动填充，也就是在插入或者更新的时候如果发现某些字段为空，则为其赋予指定的默认值。

# 【1】几个概念 #

## **① FieldFill枚举类** ##

public enum FieldFill {
        DEFAULT(0, "默认不处理"),
        INSERT(1, "插入填充字段"),
        UPDATE(2, "更新填充字段"),
        INSERT_UPDATE(3, "插入和更新填充字段");
    
        /**
         * 主键
         */
        private final int key;
    
        /**
         * 描述
         */
        private final String desc;
        //...
     }

## **② MetaObjectHandler元数据处理器接口** ##

MetaObjectHandler是一个抽象类，元对象字段填充控制器抽象类，实现公共字段自动写入。

其提供了两个抽象方法供开发者实现(插入元对象字段填充和更新元对象字段填充（用于更新时对公共字段的填充）)：

/**
         * <p>
         * 插入元对象字段填充
         * </p>
         *
         * @param metaObject 元对象
         */
        public abstract void insertFill(MetaObject metaObject);
    
        /**
         * 更新元对象字段填充（用于更新时对公共字段的填充）
         * Created with IntelliJ IDEA.
         * Author:  Wu Yujie
         * Email:  coffee377@dingtalk.com
         * Time:  2017/04/16 15:03
         *
         * @param metaObject 元对象
         */
        public abstract void updateFill(MetaObject metaObject);

--------------------

## **③ 什么是metaobject元对象？** ##

metaobject，元对象 ， 是 Mybatis提供的一个用于更加方便，更加优雅的访问对象的属性 ,给对象的属性 设置值 的一个对象。还会用于包装对象 . 支持对 Object 、 Map、Collection等对象进行包装。

本质上 metaObject获取对象的属性值或者是给对象的属性设置值，最终是要  
通过Reflector 获取到属性的对应方法的 Invoker, 最终 invoke实现。

# 【2】开发步骤 #

## ① 注解填充字段 ##

`@TableField(fill=FieldFill.INSERT_UPDATE)`注解标注在需要填充属性值的字段上，当然这里`fill=FieldFill.INSERT_UPDATE`(插入或更新)你可以选择其他。实例如下：

public class User extends Parent {
    	
    	private Integer id  ;
    	
    	@TableField(fill=FieldFill.INSERT_UPDATE)
    	private String name ;
    	//...
    }

## ② 自定义公共字段填充处理器 ##

实例如下：

/**
     * 自定义公共字段填充处理器
     */
    public class MyMetaObjectHandler extends MetaObjectHandler {
    	
    	/**
    	 * 插入操作 自动填充
    	 */
    	@Override
    	public void insertFill(MetaObject metaObject) {
    		//获取到需要被填充的字段的值
    		Object fieldValue = getFieldValByName("name", metaObject);
    		if(fieldValue == null) {
    			setFieldValByName("name", "jane", metaObject);
    		}
    		
    	}
    	/**
    	 * 修改操作 自动填充
    	 */
    	@Override
    	public void updateFill(MetaObject metaObject) {
    		Object fieldValue = getFieldValByName("name", metaObject);
    		if(fieldValue == null) {
    			setFieldValByName("name", "janus", metaObject);
    		}
    	}
    }

## ③ MP全局注入自定义公共字段填充处理器 ##

其实就是添加到Configuration中，实例如下：

<bean id ="globalConfiguration" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
    
    <property name="dbColumnUnderline" value="true"></property>
    
    
    
    
    
    <property name="idType" value="1"></property>
    
    
    <property name="tablePrefix" value="tbl_"></property>
    	
    
    <property name="metaObjectHandler" ref="myMetaObjectHandler"></property>
    
    </bean>
    
    
    <bean id="myMetaObjectHandler" class="com.jane.mp.metaObjectHandler.MyMetaObjectHandler"> </bean>

测试结果如下图(update时会默认为name赋值)：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0owODA2MjQ_size_16_color_FFFFFF_t_70_pic_center]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0owODA2MjQ_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/d3bed8fd73e74024975d84621e594b3e.png