使用MybatisPlus为字段值进行自动填充

使用MybatisPlus为字段值进行自动填充

保存或更新数据时,前端通常不会传入诸如isDeletedcreateTimeupdateTime这三个字段,因此我们需要手动赋值。但是数据库中几乎每张表都有上述字段,所以手动去赋值就显得有些繁琐。为简化上述操作,我们可采取以下措施。

  • 首先是is_deleted字段在数据库中默认设置为0
  • create_timeupdate_time:可使用mybatis-plus的自动填充功能,所谓自动填充,就是通过统一配置,在插入或更新数据时,自动为某些字段赋值,具体配置如下,详细信息可参考官方文档

为相关字段配置触发填充的时机,例如create_time需要在插入数据时填充,而update_time需要在更新数据时填充。具体配置如下,观察@TableField注解中的fill属性。

在使用自动填充之前,需要编写一个MybatisPlus自动填充的配置类:

@Component
public class MybatisMetaObjectHandler implements MetaObjectHandler {

// 在进行插入时进行自动填充的操作
    @Override
    public void insertFill(MetaObject metaObject) {
        Date date = new Date();
	// 自动填充 createTime, updateTime字段
        this.strictInsertFill(metaObject,"createTime", Date.class,date);
        this.strictUpdateFill(metaObject,"updateTime", Date.class,date);
    }

// 在进行修改时进行自动填充的操作
    @Override
    public void updateFill(MetaObject metaObject) {
	// 自动填充updateTime字段
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
    }
}

然后在 java 代码中为你需要自动填充的字段上加上对应的注解信息,例如:

@Data
public class BaseEntity {

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

    @Schema(description = "创建时间")
    @JsonIgnore
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private Date createTime;

    @Schema(description = "更新时间")
    @JsonIgnore
    @TableField(value = "update_time",fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @Schema(description = "逻辑删除")
    @JsonIgnore
    @TableLogic
    @TableField("is_deleted")
    private Byte isDeleted;
}

其中:MetaObject 是 Mybatis 反射工具类,通过 MetaObject 可以获取和设置对象的属性值。

posted @ 2024-07-08 16:54  LilyFlower  阅读(4)  评论(0编辑  收藏  举报