公共字段自动填充-MyBatis-Plus

由于使用了MyBatis-Plus提供的方法操作数据库,所有无法直接使用AOP技术来在mapper方法执行前对公共字段赋值。

在 MyBatis-Plus 中,可以通过实现 MyBatis-Plus 提供的 MetaObjectHandler 接口来实现公共字段的自动填充,比如在插入或更新数据时,自动填充创建时间、更新时间等字段。

实现步骤:

  1. 创建一个类并实现 MetaObjectHandler 接口 该类用于实现自动填充的逻辑。

  2. 配置自动填充字段 在实体类中,通过注解来标识哪些字段需要自动填充。

1. 实现**MetaObjectHandler**接口

创建实现 MetaObjectHandler 的类,该类用于在插入和更新时自动填充字段,比如创建时间、更新时间、创建用户、更新用户等。

java 复制代码
// 标注为Spring组件,使其可以被Spring容器管理
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    // 插入时的自动填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        // 字段自动填充的逻辑,可以判断当前字段是否为空然后进行填充
        
        // 使用strictInsertFill方法填充"createTime"字段,填充类型为LocalDateTime,填充值为当前时间
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); 
        
        // 使用strictInsertFill方法填充"updateTime"字段,填充类型为LocalDateTime,填充值为当前时间
        this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); 
        
        // 使用strictInsertFill方法填充"createUser"字段,填充类型为Long,填充值为当前用户ID
        this.strictInsertFill(metaObject, "createUser", Long.class, BaseContext.getCurrentId());   
        
        // 使用strictInsertFill方法填充"updateUser"字段,填充类型为Long,填充值为当前用户ID
        this.strictInsertFill(metaObject, "updateUser", Long.class, BaseContext.getCurrentId());   
    }

    // 更新时的自动填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        // 使用strictUpdateFill方法填充"updateTime"字段,填充类型为LocalDateTime,填充值为当前时间
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); 
        
        // 使用strictUpdateFill方法填充"updateUser"字段,填充类型为Long,填充值为当前用户ID
        this.strictUpdateFill(metaObject, "updateUser", Long.class, BaseContext.getCurrentId());   
    }
}

解释:

  • insertFill:这个方法在插入数据时会被触发,用于自动填充createTime、createUser、updateTime等字段。
  • updateFill:这个方法在更新数据时会被触发,用于自动填充updateTime、updateUser字段。
  • BaseContext.getCurrentId():这是为了获取当前操作用户的ID,可以结合ThreadLocal进行存储与获取。

2. 在实体类中标记需要自动填充的字段

在实体类中的相关字段上使用@TableField注解来声明这些字段需要自动填充。

java 复制代码
// 使用@Data注解自动生成getter、setter、toString、equals和hashCode方法
@Data
public class Employee {

    @TableField(fill = FieldFill.INSERT)  // 在插入时自动填充该字段
    private LocalDateTime createTime; // 创建时间字段,类型为LocalDateTime

    @TableField(fill = FieldFill.INSERT_UPDATE)  // 在插入和更新时自动填充该字段
    private LocalDateTime updateTime; // 更新时间字段,类型为LocalDateTime

    @TableField(fill = FieldFill.INSERT)  // 在插入时自动填充该字段
    private Long createUser; // 创建人ID字段,类型为Long

    @TableField(fill = FieldFill.INSERT_UPDATE)  // 在插入和更新时自动填充该字段
    private Long updateUser; // 更新人ID字段,类型为Long

    // 。。。其他属性略。。。
}

解释:

  • @TableField(fill = FieldFill.INSERT):表示在插入时自动填充该字段,例如 createTime 和 createUser。
  • @TableField(fill = FieldFill.INSERT_UPDATE):表示在插入和更新时都会自动填充该字段,例如 updateTime 和 updateUser。

3. 工作原理

  • 当你在执行 save 或者 update 操作时,MyBatis-Plus 会自动调用你实现的 MetaObjectHandler,检查并自动为指定字段填充默认值。
  • 使用 BaseContext.getCurrentId() 是为了获取当前操作的用户ID,配合 ThreadLocal,你可以在拦截器中设置用户ID信息,从而实现每个操作记录都是由特定的用户生成或更新的。

4. 总结

  1. 创建 MetaObjectHandler 实现类,负责自动填充字段逻辑。
  2. 在实体类中通过 @TableField 注解标记需要自动填充的字段。
  3. MyBatis-Plus 提供了 FieldFill.INSERT、FieldFill.UPDATE 和 FieldFill.INSERT_UPDATE 来区分字段在插入和更新时的自动填充需求。
相关推荐
小羊没烦恼!4 天前
微服务化的基石——持续集成
java·大数据·word·powerpoint·.net
俊昭喜喜里4 天前
java中的继承和多态的区别
java
小羊没烦恼!4 天前
初探性能优化——2个月到4小时的性能提升
java·开发语言·windows·算法·c#
譕痕4 天前
JSONObject与JSONArray封装数据格式区别
java·json
胡写代码4 天前
别再前后端各写一套表单校验了
java·后端
小鱼能吃糖4 天前
缺陷修复总览 · mall电商项目:5类缺陷,1个病根,4个业务域
java·电商
此时不提桶,更待何时4 天前
01-06-A-JVM排查实战详解
java·jvm
这个DBA有点耶4 天前
MVCC深入:Read View、版本链与快照读——InnoDB并发控制的内核
数据库·mysql·架构
vipxieliang4 天前
ValidX 在 DDD 领域驱动设计中的实践
java·spring boot
DBA_G4 天前
从地面到云霄:GBase数据库在民航三大场景的落地实践
数据库