Mybatis-Plus实现公共字段自动赋值的方法

下面是关于"Mybatis-Plus实现公共字段自动赋值的方法"的详细讲解：

什么是公共字段自动赋值

在许多实际的应用场景中，我们需要在插入或者更新数据时自动赋值某些公共字段，比如创建时间、更新时间、创建人、更新人等信息。这些公共字段信息通常是由系统自动维护，并且在插入或更新时需要自动赋值，而不是由用户手动设置。Mybatis-Plus提供了一个非常方便的方法来实现这种自动赋值，如果我们能够恰当地使用它，可以大大提高代码重用性和开发效率。

Mybatis-Plus实现公共字段自动赋值的方法

Mybatis-Plus提供了一个全局配置类GlobalConfig，通过该类可以配置插入和更新时自动填充公共字段值的处理器，然后在实体类上通过注解标记需要自动填充的公共字段，Mybatis-Plus就可以自动将这些字段值自动填充到SQL语句中。

配置自动填充处理器

自动填充处理器是一个接口，该接口有两个方法需要实现：一个用于在插入时填充字段值，一个用于在更新时填充字段值。我们需要实现这两个方法，并将实现该接口的处理器注册到Mybatis-Plus的全局配置中。

下面是一个示例：

public class MyMetaHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setInsertFieldValByName("createTime", LocalDateTime.now(), metaObject);
        this.setInsertFieldValByName("createUser", getCurrentUserId(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setUpdateFieldValByName("updateTime", LocalDateTime.now(), metaObject);
        this.setUpdateFieldValByName("updateUser", getCurrentUserId(), metaObject);
    }

    private Long getCurrentUserId() {
        // 获取当前登录用户Id的方法
        return 1L;
    }
}

在这个示例中，我们创建了一个自动填充处理器类MyMetaHandler，实现了MetaObjectHandler接口，并实现它的insertFill和updateFill方法。在插入时，我们获取当前时间和当前用户Id，将它们赋值给实体类的createTime和createUser字段，而在更新时，我们同样获取当前时间和当前用户Id，然后分别将它们赋值给实体类的updateTime和updateUser字段。

接下来，在全局配置类GlobalConfig中注册该处理器:

@Configuration
public class GlobalConfig {
    @Bean
    public GlobalConfig mybatisPlusConfig() {
        GlobalConfig config = new GlobalConfig();

        MyMetaHandler handler = new MyMetaHandler();
        config.setMetaObjectHandler(handler);

        return config;
    }
}

这里我们通过Spring的@Bean注解创建了一个全局配置类，并将MyMetaHandler处理器注册到其中。

标记需要自动填充的字段

在我们的实体类中，我们需要使用Mybatis-Plus提供的注解来标记公共字段，告诉Mybatis-Plus哪些字段需要自动填充。

下面是一个示例：

public class User {
    @TableId
    private Long id;

    private String name;

    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;

    @TableField(fill = FieldFill.INSERT)
    private Long createUser;

    @TableField(fill = FieldFill.UPDATE)
    private LocalDateTime updateTime;

    @TableField(fill = FieldFill.UPDATE)
    private Long updateUser;

    // getter 和 setter 方法
}

在这个示例中，我们的实体类User中标记了createTime、createUser、updateTime、updateUser这4个字段需要自动填充。@TableField(fill = FieldFill.INSERT)表示该字段在插入时自动赋值，@TableField(fill = FieldFill.UPDATE)表示该字段在更新时自动赋值。当然，我们还需要在这些字段上设置相应的getter和setter方法。

示例说明

下面我们来看两个示例说明：

示例1：同时自动填充创建和修改时间

在这个示例中，我们需要自动填充一个名为createTime的字段，同时，我们需要在更新时自动更新一个名为modifyTime的字段。

首先，我们需要创建一个自动填充处理器类，实现MetaObjectHandler接口，并实现它的insertFill和updateFill方法：

public class CommonFieldMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        setFieldValByName("createTime", LocalDateTime.now(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        setFieldValByName("modifyTime", LocalDateTime.now(), metaObject);
    }
}

这里我们在插入时自动将createTime字段赋值为当前时间，而在更新时自动将modifyTime字段赋值为当前时间。

然后，我们需要在Spring配置文件中将这个处理器注册到Mybatis-Plus的全局配置中：

@Configuration
public class MybatisPlusConfiguration {

    @Autowired
    private CommonFieldMetaObjectHandler commonFieldMetaObjectHandler;

    @Bean
    public GlobalConfig globalConfiguration() {
        GlobalConfig globalConfig = new GlobalConfig();

        globalConfig.setMetaObjectHandler(commonFieldMetaObjectHandler);

        return globalConfig;
    }
}

这里我们使用了Spring的@Autowired注解将CommonFieldMetaObjectHandler处理器注入到配置文件中，然后将它注册到GlobalConfig中。

现在我们还需要在实体类中标记需要自动填充的字段：

public class User {

    @TableId(type = IdType.AUTO)
    private Long id;

    private String name;

    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;

    @TableField(fill = FieldFill.UPDATE)
    private LocalDateTime modifyTime;

    // getter 和 setter 方法
}

在这里，我们标记了createTime字段在插入时需要自动填充，而modifyTime字段在更新时需要自动填充。

示例2：同时自动填充创建人和修改人

在这个示例中，我们需要自动填充一个名为createUser的字段，表示创建该记录的用户Id，同时，我们需要在更新时自动更新一个名为modifyUser的字段，表示最近更新该记录的用户Id。

首先，我们需要创建一个自动填充处理器类，实现MetaObjectHandler接口，并实现它的insertFill和updateFill方法：

public class CommonFieldMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        setFieldValByName("createUser", getCurrentUserId(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        setFieldValByName("modifyUser", getCurrentUserId(), metaObject);
    }

    private Long getCurrentUserId() {
        // 获取当前登录用户Id的方法
        return 1L;
    }
}

这里我们在插入时自动将createUser字段赋值为当前用户Id，而在更新时自动将modifyUser字段赋值为当前用户Id。

然后，我们需要在Spring配置文件中将这个处理器注册到Mybatis-Plus的全局配置中：

@Configuration
public class MybatisPlusConfiguration {

    @Autowired
    private CommonFieldMetaObjectHandler commonFieldMetaObjectHandler;

    @Bean
    public GlobalConfig globalConfiguration() {
        GlobalConfig globalConfig = new GlobalConfig();

        globalConfig.setMetaObjectHandler(commonFieldMetaObjectHandler);

        return globalConfig;
    }
}

这里我们使用了Spring的@Autowired注解将CommonFieldMetaObjectHandler处理器注入到配置文件中，然后将它注册到GlobalConfig中。

现在我们还需要在实体类中标记需要自动填充的字段：

public class User {

    @TableId(type = IdType.AUTO)
    private Long id;

    private String name;

    @TableField(fill = FieldFill.INSERT)
    private Long createUser;

    @TableField(fill = FieldFill.UPDATE)
    private Long modifyUser;

    // getter 和 setter 方法
}

在这里，我们标记了createUser字段在插入时需要自动填充，而modifyUser字段在更新时需要自动填充。

至此，我们已经成功地实现了公共字段自动赋值的功能。