排查使用MyBatis-Plus自动填充字段时，未标记@TableField(fill = FieldFill.INSERT)却被插入填充值问题

原创 已于 2025-03-30 22:18:44 修改 · 557 阅读 · 5 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#mybatis #架构 #开源软件

于 2025-03-29 14:47:38 首次发布

背景

问题起因是项目组一位伙伴，反映插入某张业务表时主键id不是雪花算法，而是看起来像是自增主键的值，且数据库已经产生了那种类似自增主键的值，导致插入数据时主键id冲突，程序异常无法插入数据。

排查过程

1、检查那张表的主键配置未发现问题，是采取的mp自动生成的雪花算法（隐藏项目业务相关信息）

@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("test")
@EqualsAndHashCode(callSuper = true)
public class TestEntity extends Model<TestEntity> {
    /**
     * 主键
     */
    @TableId(type = IdType.ASSIGN_ID)
    private Long deptId;

    /**
     * 创建人
     */
    @TableField(fill = FieldFill.INSERT)
    private String createBy;
        
    /**
     * 创建时间
     */
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;
}

后来突然联想到最近有其他人，添加了数据权限相关功能时，修改框架了mp的自动填充处理器，增加了默认填充字段deptId(当前登录人的部门编号)。


import cn.hutool.core.util.ObjUtil;
import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.pig4cloud.pig.common.core.constant.CommonConstants;
import com.pig4cloud.pig.common.security.util.SecurityUtils;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.security.authentication.AnonymousAuthenticationToken;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.util.ClassUtils;

import java.nio.charset.Charset;
import java.time.LocalDateTime;
import java.util.Optional;

/**
 * MybatisPlus 自动填充配置
 *
 * @author L.cm
 */
@Slf4j
public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        log.debug("mybatis plus start insert fill ....");
        LocalDateTime now = LocalDateTime.now();

        // 审计字段自动填充,覆盖用户输入
        fillValIfNullByName("createTime", now, metaObject, true);
        fillValIfNullByName("updateTime", now, metaObject, true);
        fillValIfNullByName("createBy", getUserName(), metaObject, true);
        fillValIfNullByName("updateBy", getUserName(), metaObject, true);

        // 删除标记自动填充
        fillValIfNullByName("delFlag", CommonConstants.STATUS_NORMAL, metaObject, true);

        // 当前登录人的部门编号
        if (ObjUtil.isNotNull(SecurityUtils.getUser())) {
            fillValIfNullByName("deptId", SecurityUtils.getUser().getDeptId(), metaObject, true);
        }
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.debug("mybatis plus start update fill ....");
        fillValIfNullByName("updateTime", LocalDateTime.now(), metaObject, true);
        fillValIfNullByName("updateBy", getUserName(), metaObject, true);
    }

    /**
     * 填充值，先判断是否有手动设置，优先手动设置的值，例如：job必须手动设置
     *
     * @param fieldName  属性名
     * @param fieldVal   属性值
     * @param metaObject MetaObject
     * @param isCover    是否覆盖原有值,避免更新操作手动入参
     */
    private static void fillValIfNullByName(String fieldName, Object fieldVal, MetaObject metaObject, boolean isCover) {
        // 0. 如果填充值为空
        if (fieldVal == null) {
            return;
        }
        // 1. 没有 get 方法
        if (!metaObject.hasSetter(fieldName)) {
            return;
        }
        // 2. 如果用户有手动设置的值
        Object userSetValue = metaObject.getValue(fieldName);
        String setValueStr = StrUtil.str(userSetValue, Charset.defaultCharset());
        if (StrUtil.isNotBlank(setValueStr) && !isCover) {
            return;
        }
        // 3. field 类型相同时设置
        Class<?> getterType = metaObject.getGetterType(fieldName);
        if (ClassUtils.isAssignableValue(getterType, fieldVal)) {
            metaObject.setValue(fieldName, fieldVal);
        }
    }

    /**
     * 获取 spring security 当前的用户名
     *
     * @return 当前用户名
     */
    private String getUserName() {
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        // 匿名接口直接返回
        if (authentication instanceof AnonymousAuthenticationToken) {
            return null;
        }

        if (Optional.ofNullable(authentication).isPresent()) {
            return authentication.getName();
        }

        return null;
    }

}

猜测是mp的自动填充给主键值覆盖了，但是问题点在于我们并没有给主键deptId字段加自动填充注解@TableField(fill = FieldFill.INSERT)，调试代码和查阅MyBatis-Plus官网，发现不是MyBatis-Plus的问题（官网中明确说明字段必须声明@TableField注解才会填充默认值）。而是开源框架中的自动填充器逻辑问题，仔细查看填充器的代码，发现不光是主键，其他有值的参数，即使未被标记注解，值也会被自动填充。
在这里插入图片描述

MyBatis-Plus填充逻辑的源码

    default MetaObjectHandler strictFill(boolean insertFill, TableInfo tableInfo, MetaObject metaObject, List<StrictFill<?, ?>> strictFills) {
        if (insertFill && tableInfo.isWithInsertFill() || !insertFill && tableInfo.isWithUpdateFill()) {
            strictFills.forEach((i) -> {
                String fieldName = i.getFieldName();
                Class<?> fieldType = i.getFieldType();
                tableInfo.getFieldList().stream().filter((j) -> {
                    return j.getProperty().equals(fieldName) && fieldType.equals(j.getPropertyType()) && (insertFill && j.isWithInsertFill() || !insertFill && j.isWithUpdateFill());
                }).findFirst().ifPresent((j) -> {
                    this.strictFillStrategy(metaObject, fieldName, i.getFieldVal());
                });
            });
        }

        return this;
    }

解决方案

至此发现问题，修改开源框架中的自动填充器的逻辑。并且优化了部分代码逻辑，同时修复了框架中的自动填充器的其他问题【1、优化：值覆盖与否，不再判断指定属性是否有值，因为该判断没有实际作用；2、fix：字段未设置@TableField(fill = FieldFill.INSERT)注解也会被填充默认值问题；3、fix:自动填充时未根据@TableField属性fill判断是新增时填充还是修改时填充问题】

package com.lxdz.kyj.common.data.mybatis;

import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import com.pig4cloud.pig.common.core.constant.CommonConstants;
import com.pig4cloud.pig.common.security.util.SecurityUtils;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.util.ClassUtils;

import java.nio.charset.Charset;
import java.time.LocalDateTime;
import java.util.Optional;

/**
 * MybatisPlus 自动填充配置
 *
 * @author L.cm
 */
@Slf4j
public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        log.debug("mybatis plus start insert fill ....");
        LocalDateTime now = LocalDateTime.now();

        // 审计字段自动填充
        fillValIfNullByName("createTime", now, metaObject, true, true);
        fillValIfNullByName("updateTime", now, metaObject, false, true);
        fillValIfNullByName("createBy", getUserName(), metaObject, false, true);
        fillValIfNullByName("updateBy", getUserName(), metaObject, true, true);
        // 删除标记自动填充
        fillValIfNullByName("delFlag", CommonConstants.STATUS_NORMAL, metaObject, false, true);
        // 当前登录人的部门编号
        if (ObjUtil.isNotNull(SecurityUtils.getUser())) {
            fillValIfNullByName("deptId", SecurityUtils.getUser().getDeptId(), metaObject, true);
        }
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.debug("mybatis plus start update fill ....");
        fillValIfNullByName("updateTime", LocalDateTime.now(), metaObject, true, false);
        fillValIfNullByName("updateBy", getUserName(), metaObject, true,false);
    }

    /**
     * 填充值，先判断是否有手动设置，优先手动设置的值，例如：job必须手动设置
     *
     * @param fieldName  属性名
     * @param fieldVal   属性值
     * @param metaObject MetaObject
     * @param isCover    是否覆盖原有值,避免更新操作手动入参
     */
    private void fillValIfNullByName(String fieldName, Object fieldVal, MetaObject metaObject, boolean isCover, boolean insertFill) {
        // 0. 如果填充值为空
        if (fieldVal == null) {
            return;
        }

        // 1. 没有 get 方法
        if (!metaObject.hasSetter(fieldName)) {
            return;
        }
        // 2. 如果用户有手动设置的值
        if (!isCover) {
            return;
        }
        // 3. field 类型相同时设置
        Class<?> getterType = metaObject.getGetterType(fieldName);
        if (ClassUtils.isAssignableValue(getterType, fieldVal)) {
            TableInfo tableInfo = findTableInfo(metaObject);
            if (tableInfo.getFieldList().stream().anyMatch((i) -> i.getProperty().equals(fieldName)
                    && getterType.equals(i.getPropertyType())
                    && (insertFill && i.isWithInsertFill() || !insertFill && i.isWithUpdateFill()))) {
                metaObject.setValue(fieldName, fieldVal);
            }
        }
    }

    /**
     * 获取 spring security 当前的用户名
     *
     * @return 当前用户名
     */
    private String getUserName() {
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        if (Optional.ofNullable(authentication).isPresent()) {
            return authentication.getName();
        }
        return null;
    }
}

验证

验证后已把修复的代码提交到开源框架，希望开源框架的大神们能给通过

@TableField(fill = FieldFill.INSERT)这个注解的作用
舒一笑的博客
10-28 2349
是 MyBatis-Plus提供的一个注解，用于标注实体类的属性与数据库表的字段之间的映射关系。当你在一个实体类的属性上使用。设置了值，它都会在插入数据库时被自动填充为当前时间。这样可以确保数据的一致性，并且简化了插入操作的代码。字段被标注为在插入操作时自动填充。为了实际实现这个自动填充，你需要定义一个实现了。注解时，你告诉 MyBatis-Plus 在插入记录时自动填充这个字段。是一个枚举值，表示只在插入操作时进行字段的自动填充。方法来指定当插入操作发生时，对象时，无论你是否为。
MyBatisPlus之@TableField字段填充详解
sunnyday0426的博客
05-11 4533
MyBatisPlus的@TableField注解用于指定实体类属性与数据库表字段的映射关系，同时支持自定义字段填充策略。
@TableField(fill = FieldFill.INSERT)
tellmewhoisi的博客
04-25 5219
TableField 注解表示该字段是数据库字段，支持的属性包括：value、exist、el、condition、update、insertStrategy、updateStrategy、whereStrategy、fill。@TableField(fill = FieldFill.INSERT) 是 MyBatis-Plus 中的注解，用于设置实体类中对应的字段在插入时需要自动填充。为了在插入数据时自动填充这个字段，你需要实现一个字段填充的拦截器MetaObjectHandler。
mybatisplus公共字段自动填充
pige666的博客
05-22 199
你比如说像插入时间、更新时间等这种类型的字段，你在插入、更新时候要额外写一个setValue，总写总写其实有点麻烦的，这里mybatisplus给我们提供了一个公共字段统一自动填充的方式。只需要在对应字段加上注释@TableField(fill = FieldFill.INSERT_UPDATE)，FieldFill.INSERT_UPDATE代表插入和更新时候都自动填充。然后再写一个自动填充逻辑，
Mybatis Plus 自动填充注解 @TableField（fill = FieldFill.INSERT_UPDATE）
2201_75600005的博客
07-03 669
第二步：要想实现自动填充还需要实现MetaObjectHandler接口，在这里实现自动填充的逻辑。为什么实现了自动填充，因为在MetaObjectHandler 配置了该字段。通过在创建时间和修改时间上添加 fill 填充字段 进行自动填充。第一步：在需要自动填充的位置加上注解。
MybatisPlus(fill = FieldFill.INSERT)自定义值传入
热门推荐
我是福强的博客
06-25 2万+
在实际开发中使用Mybatis Plus会遇到插入数据的时候，比如每条数据插入创建人ID时间等,使用Mybatis Plus的FieldFill就会很方便了。 1、创建 CustomMetaObjectHandler 实现 CustomMetaObjectHandler接口 public class CustomMetaObjectHandler implements MetaObjectHandler { public CustomMetaObjectHandler() { } .
@TableField(fill = FieldFill.INSERT)解释一下这个时间具体取的哪个时间
最新发布
06-20
根据引用内容，我们知道：-使用`@TableField(fill=...)`可以指定字段在什么操作时自动填充（如INSERT表示插入时填充，INSERT_UPDATE表示插入和更新时填充）。-但是，这些引用并没有直接说明时间字段的值是如何生成的...
SpringBoot快速集成Mybatis-plus常用功能
我爱学习 学习使我快乐
07-02 905
mybatis-plus基本使用；基于数据库表快速生成基础代码；分页查询、逻辑删除、多数据源配置等扩展功能的使用
mp中isdeleted字段加上@TableLogic 仍然不能自动填充为0，yml里也配置上了logic-delete-value
03-26
嗯，用户在使用MyBatis-Plus的@TableLogic注解时遇到了问题，isDeleted字段无法自动填充为0。首先，我需要回忆一下MyBatis-Plus的逻辑删除机制。根据引用[1]和[2]，逻辑删除是通过配置yml文件中的logic-delete-value...
mybatisplus自动填充无效
09-18
2. 字段未标记自动填充注解：需要在实体类的对应字段上标记相应的自动填充注解，例如`@TableField(fill = FieldFill.INSERT)`。 3. 数据库字段类型不匹配：自动填充功能依赖于数据库字段的类型，如果数据库字段类型...
【查询艺术】：SpringBoot结合mybatis-plus在复杂查询中的多数据源应用
本论文详细探讨了SpringBoot结合mybatis-plus在多数据源环境中的配置与管理，特别是在复杂查询场景中的实践应用。首先阐述了多数据源的基本概念、配置方法以及事务管理策略。随后，深入分析了mybatis-plus在多数据源...
记得写 @TableField(fill = FieldFill.INSERT)
zhixiang_ya的博客
12-20 2963
@TableField(fill = FieldFill.INSERT_UPDATE)介绍和使用
c103363的博客
03-13 1万+
@TableField(fill = FieldFill.INSERT)、@TableField(fill = FieldFill.INSERT_UPDATE)这两个注解经常在项目中使用到，他MyBatis-Plus 库中的注解，它用于指定字段在执行数据库表的插入和更新操作时的填充策略
使用mybatisplus中的@TableField(fill = FieldFill.INSERT)不起作用（不能自动填充数据）
weixin_42888110的博客
08-06 4501
这个原因是我们还需要实现一个 MetaObjectHandle接口，并重写其中的方法。
MybatisPlus自动填充字段@TableField(fill = FieldFill.INSERT)为null解决方法
m0_71168236的博客
07-09 2803
数据类型注解示例Collection@Param("collection") 或ListArray实体类//et标记的会填充,coll虽然是特殊的key值,但不属于实体,所以不会处理//方法虽然与上面方法一致,但key值不满足填充条件,需要将user换成et才能正确填充4MybatisPlusAutoConfiguration.sqlSessionFactory()内部MybatisSqlSessionFactoryBean绑定填充器失败。解决方案：/**
【MybatisPlus学习】自动填充字段@TableField(fill = FieldFill.INSERT)，失效解决方法
也不一样的博客
01-22 1610
自动填充字段@TableField(fill = FieldFill.INSERT)，失效解决方法
Mybatis_plus
m0_55083670的博客
10-30 977
mybatis_plus
mybatis plus fill = fieldfill.insert 没生效，createTime、updateTime插入和更新
yangguangdeqi的博客
08-15 1202
mybatis plus createTime、updateTime插入和更新，fill = fieldfill.insert 没生效，需要如下配置类。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值