自动填充字段：MyBatis-Plus的高效开发实践

引言

在现代软件开发中，自动化是一个提高开发效率和减少重复劳动的关键因素。MyBatis-Plus，作为一个强大的MyBatis增强工具，在自动填充字段方面提供了非常便捷的功能。本文将详细介绍如何在MyBatis-Plus中实现自动填充字段，以及这一功能如何帮助我们提高开发效率。

自动填充原理

MyBatis-Plus的自动填充功能基于实现com.baomidou.mybatisplus.core.handlers.MetaObjectHandler接口。开发者需要创建一个类来实现此接口，并定义插入和更新操作时的字段填充逻辑。

使用步骤

1. 定义实体类

首先，在实体类中使用@TableField注解来标记需要自动填充的字段，并指定填充策略。

public class User {
    @TableField(fill = FieldFill.INSERT)
    private String createTime;
    @TableField(fill = FieldFill.UPDATE)
    private String updateTime;
    // 其他字段...
}

2. 实现MetaObjectHandler

创建一个类实现MetaObjectHandler接口，并重写insertFill和updateFill方法，定义具体的填充逻辑。

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("开始插入填充...");
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("开始更新填充...");
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }
}

3. 配置自动填充处理器

确保自动填充处理器类被Spring容器管理，可以通过@Component或@Bean注解实现。

注意事项

• 自动填充直接设置实体类属性值。
• 如果属性未赋值，数据库中将存入null。
• 默认策略：属性已有值则不覆盖，填充值为null则不填充。
• 必须在字段上声明@TableField注解，并设置填充策略。
• 处理器类需在Spring Boot中声明为@Component或@Bean。
• 使用strictInsertFill或strictUpdateFill方法区分填充逻辑。
• 在update方法中，entity不能为空，否则自动填充失效。
• update方法不自动填充，需要手动赋值。

参数填充示例

// 插入填充示例
insertFillByCustomMethod1(H2User h2User);
insertFillByCustomMethod8(H2User[] h2Users);
insertFillByCustomMethod4(Collection<H2User> h2Users);

// 更新填充示例
updateFillByCustomMethod2(@Param("coll") Collection<Long> ids, @Param("et") H2User h2User);
updateFillByCustomMethod4(@Param("colls") Collection<Long> ids, @Param("et") H2User h2User);

无法填充示例

// 方法参数名不满足填充条件，需要将 user 换成 et 才能正确填充
updateFillByCustomMethod3(@Param("coll") Collection<Long> ids, @Param("user") H2User h2User);

FieldFill 枚举

public enum FieldFill {
    DEFAULT,       // 默认不处理
    INSERT,        // 插入填充字段
    UPDATE,        // 更新填充字段
    INSERT_UPDATE  // 插入和更新填充字段
}

结语

通过以上步骤，我们可以看到MyBatis-Plus的自动填充功能是如何帮助我们简化数据库操作的。这不仅减少了代码量，还提高了数据一致性和开发效率。希望本文能够帮助开发者更好地利用MyBatis-Plus的强大功能。