MyBatis-Plus中的公共字段自动填充策略

在软件开发中，我们经常遇到一些公共字段，如创建时间、更新时间、创建者、更新者等，这些字段在数据插入或更新时都需要被赋予相应的值。手动为这些字段赋值不仅繁琐，而且容易出错。幸运的是，MyBatis-Plus为我们提供了自动填充这些公共字段的功能。

本文将通过一个实例，详细介绍如何在MyBatis-Plus中实现公共字段的自动填充。

一、背景介绍

MyBatis-Plus是一个强大的MyBatis扩展插件，它在MyBatis的基础上提供了许多实用的功能，如自动填充、乐观锁、逻辑删除等。其中，自动填充功能可以帮助我们自动为实体类中的公共字段赋值。

二、实现步骤

1. 创建实体类

首先，我们需要创建一个实体类，并在其中定义需要自动填充的公共字段。例如，我们可以创建一个名为User的实体类，其中包含createTime、updateTime、createUser和updateUser等字段。

public class User {
    private Long id;
    private String name;
    private LocalDateTime createTime;
    private LocalDateTime updateTime;
    private Long createUser;
    private Long updateUser;
    // getters and setters...
}

2. 创建MetaObjectHandler

接下来，我们需要创建一个实现了MetaObjectHandler接口的类，用于处理公共字段的自动填充逻辑。在这个类中，我们可以重写insertFill和updateFill方法，分别在插入和更新时为公共字段赋值。

以下是一个示例：

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("公共字段自动填充[insert]...");
        // 为createTime和updateTime字段设置当前时间
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        // 为createUser和updateUser字段设置当前用户ID（假设从BaseContext中获取）
        metaObject.setValue("createUser", BaseContext.getCurrentId());
        metaObject.setValue("updateUser", BaseContext.getCurrentId());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充[update]...");
        // 为updateTime字段设置当前时间
        metaObject.setValue("updateTime", LocalDateTime.now());
        // 为updateUser字段设置当前用户ID（假设从BaseContext中获取）
        metaObject.setValue("updateUser", BaseContext.getCurrentId());
    }
}

在上面的示例中，我们使用了LocalDateTime.now()方法获取当前时间，并使用了一个假设的BaseContext.getCurrentId()方法获取当前用户ID。在实际应用中，你需要根据具体的需求来实现这些方法。

注意事项：

1. 确保实体类字段与数据库表列名匹配，否则自动填充可能失败。
2. 注意MetaObjectHandler是全局处理器，若只想处理特定实体，需自定义结果映射。
3. 自动填充仅影响插入和更新操作。
4. 在多数据源或分片环境中，可能需为每个数据源/分片单独配置自动填充策略。
5. 自定义填充策略时，确保相关依赖和配置正确，且注意线程安全。
6. 确保在mapper接口或xml文件中有相应的插入和更新方法及其SQL语句，以触发自动填充。
7. 若使用MyBatis-Plus的CRUD接口，内置方法可能不会触发自动填充，建议自定义SQL。
8. 需对项目架构和数据流程有了解，以更好地实现自动填充策略并避免问题。