Mybatis-Plus自动填充

原创已于 2024-05-12 15:00:39 修改 · 1k 阅读

17 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #数据库

于 2024-04-19 23:33:08 首次发布

本文详细描述了如何使用MybatisPlus的@TableField和MetaObjectHandler定制化实体类的时间字段填充策略，提升开发效率。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、业务场景

在我们对数据库中数据的插入或者修改的时候，往往需要填写create_time和update_time字段 , 如果每次进行这样的操作都要在service层中获取时间然后赋值再插入的话十分的繁琐且重复

二、解决方案

2.1 实现过程：

在需要自动填充的实体类的字段上加上 @TableField注解来指定是在进行什么操作(查询、插入、更新、删除) 时，要对该字段进行字段填充，

然后我们实现MetaObjectHandler接口，就可以对填充策略进行设计

2.2 为实体类添加@TableField注解

FieldFill字段枚举类有四种自动填充处理策略，分别是Default (默认不处理)、Insert (插入时填充)、Update (更新时填充)、Insert_Update (插入和更新时填充)

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("user")
@ApiModel(value="User对象", description="")
public class User implements Serializable {

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

    private String username;

    private String password;

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

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


}

2.3 实现MetaObjectHandler接口, 进行填充策略设计

MybatisPlus还提供了专门的数据源对象处理器，我们只需实现MetaObjectHandler接口便可进行一些填充策略的设置

/**
 * mybatis-plus自动填充策略设置
 */
@Slf4j
@Component
public class DatetimeMetaObjectHandler implements MetaObjectHandler {
    //进行插入时填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("mybatis-plus 开始在你插入的时候 字段填充字段......");
        this.setFieldValByName("createTime", LocalDateTime.now(), metaObject);
        this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
    }

    //进行修改操作时填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("mybatis-plus 开始在你修改的时候 字段填充字段......");
        this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
    }
}