MyBatis-Plus自动化填充的踩坑分析记录

MyBatis-Plus自动化填充的踩坑分析记录

最近在做重构老项目时，觉得MyBatis-Plus的自动填充功能非常适合用来替代之前业务中手动维护创建时间，更新时间，创建用户，更新用户等字段。但在开发的过程中也遇到了一个小问题，与大家分享下这个容易踩坑的地方。

问题再现

在开发的过程中，使用了MyBatis-Plus开发插件，根据表信息自动生成了表的实体类，然后又根据MyBatis-Plus的官方文档，添加了注解及自定义实现类，然后发现运行起来时间数据没有插入。情况如下图所示：

问题分析与源码原理分析

分析打印的SQL日志，发现更新时已经添加update_time字段，故排除实体类的注解问题。转而分析MyMetaObjectHandler自定义实现类，经过对比发现，它其中使用的LocalDateTime类型，而使用插件生成则会把Mysql数据库里DateTime类型自动生成为Date类型。猜测问题就是时间类型不一样导致。然后打断点进入MyMetaObjectHandler方法，对MyBatis-Plus源码进行分析：

（1）实际填充方法如下

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

（2）定位匹配规则代码

   return j.getProperty().equals(fieldName) && fieldType.equals(j.getPropertyType()) && (insertFill && j.isWithInsertFill() || !insertFill && j.isWithUpdateFill());            

可以将其拆分成三部分，分别是

//判断MyMetaObjectHandler中名称是否和更新数据的名称相同
j.getProperty().equals(fieldName)
//判断自MyMetaObjectHandler中类型是否和更新数据的类型相同
fieldType.equals(j.getPropertyType())
//判断字段insert及update填充的符合情况
(insertFill && j.isWithInsertFill() || !insertFill && j.isWithUpdateFill())

（3）计算器参数对比

在此就能发现问题，propertyType中的值为class java.util.Date，而fieldType中的值为class java.time.LocalDateTime，类型不匹配导致填充失败。

问题解决方法

将自动生成实体类的时间类型改成了LocalDateTime，问题便得到了解决。

小结

开发中时常遇到这种小问题，特别是依赖插件生成的代码，因为不是自己编写的，一定要仔细检查核对。

LocalDateTime是Java 8引入的时间日期类，它是final修饰的不可变类型，不可修改，线程安全，而且提供了更加友好好用的日期操作，平时学习工作建议使用LocalDateTime。