mybatis plus 增删改自动填充字段值

说明

本文实现以下需求效果

创建数据时自动填充 createUserId 和 createTime
更新数据时自动填充 updateUserId 和 updateTime(每次修改都自动填充新的 updateTime 值)
软删除数据时自动填充 deleteUserId 和 deleteTime

创建

实体类

为实体类(DO)的 createUserId 和 createTime 字段配置以下 Annotation，代表标记在插入(insert into)时自动填充字段值

@TableField(fill = FieldFill.INSERT)
private Integer createUserId;

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

实现 `MetaObjectHandler`

如果实体(DO)中配置了上面的注解，就会执行这个 handler。这里在 insert 时自动填充 createUserId 和 createTime 字段的值

public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
    private static final String createUserId = "createUserId";
    private static final String createTime = "createTime";

    @Override
    public void insertFill(MetaObject metaObject) {
        // insert 时自动插入 createUserId、createTime
        this.strictInsertFill(metaObject, createUserId, StpUtil::getLoginIdAsInt, Integer.class);
        this.strictInsertFill(metaObject, createTime, Date::new, Date.class);
        // 关于 is_delete 字段，这里不提供默认值，因为官方推荐设置数据库中列的默认值
    }

    @Override
    public void updateFill(MetaObject metaObject) {}   
}

配置

注入 IOC 容器。
在 MybatisPlusMetaObjectHandler 类上配置 @Configuration 注解也可以达到同样目的。

@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusMetaObjectHandler mybatisPlusCommonDateFieldValueFillHandler(){
        return new MybatisPlusMetaObjectHandler();
    }
}

更新

实体类

在实体类(DO)上配置注解

@TableField(fill = FieldFill.UPDATE)
private Integer updateUserId;

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

实现 `MetaObjectHandler`

如果实体(DO)中配置了上面的注解，就会执行这个 handler。这里在 update 时自动填充 updateUserId 和 updateTime 字段的值

特别注意，这里需要重写 strictFillStrategy 方法，因为默认的行为不会按照预期执行（每次更新数据时都更新 updateTime)

public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
    private static final String updateUserId = "updateUserId";
    private static final String updateTime = "updateTime";

    @Override
    public void insertFill(MetaObject metaObject) {}

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, updateUserId, StpUtil::getLoginIdAsInt, Integer.class);
        this.strictUpdateFill(metaObject, updateTime, Date::new, Date.class);
    }

    /**
     * 严格模式填充策略,默认有值不覆盖,如果提供的值为null也不填充
     *
     * @param metaObject metaObject meta object parameter
     * @param fieldName  java bean property name
     * @param fieldVal   java bean property value of Supplier
     * @return this
     * @since 3.3.0
     */
    @Override
    public MetaObjectHandler strictFillStrategy(MetaObject metaObject, String fieldName, Supplier<?> fieldVal) {
        // 但当自动填充字段为 updateTime 时，始终更新它
        if (fieldName.equals(updateTime)) {
            Object obj = fieldVal.get();
            metaObject.setValue(fieldName, obj);
        } else if (metaObject.getValue(fieldName) == null) { // 这个 if 是源码中的
            Object obj = fieldVal.get();
            if (Objects.nonNull(obj)) {
                metaObject.setValue(fieldName, obj);
            }
        }
        return this;
    }
}

配置

参考创建章节中的配置，如果已经配置了就不需要再配置了

软删除

配置 application.yml

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: is_delete # 逻辑删除属性名称（为数据库中的字段名称）
      logic-delete-value: 1 # 代表已删除的值
      logic-not-delete-value: 0 # 代表未删除的值

实体类

在实体类(DO)中对以下字段配置注解。

标识 isDelete 字段作为逻辑删除的标识，然后有两个需要自动填充值的字段。

/**
  * 逻辑删除标识
  *
  * \@TableLogic\ 注解标记逻辑删除属性
  */
@TableLogic
private Boolean isDelete;

@TableField(fill = FieldFill.UPDATE)
private Integer deleteUserId;

@TableField(fill = FieldFill.UPDATE)
private Date deleteTime;

重写 DefaultSqlInjector

如果需要在软删除时自动填充其他字段的值，才需要重写这个 DefaultSqlInjector，否则忽略本小节。

这里配置了逻辑删除时填充其他字段值的 SqlInjector

public class MybatisPlusSqlInjector extends DefaultSqlInjector {
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        final List<AbstractMethod> methods = super.getMethodList(mapperClass);

        methods.add(new LogicDeleteByIdWithFill());

        return methods;
    }
}

实现 `MetaObjectHandler`

由于 mybatis plus 的 @TableField 注解枚举字段 fill 的值没有我们想要的 Delete，所以 Update 和 Delete 实际上都是走的 updateFill 函数，在函数内部我们需要区分出到底是更新还是软删除，才能继续下一步即自动填充不同行为下字段的值

注意，我们配置了 @TableLogic 注解后，isDelete 字段在软删除时 mybatis plus 会自动填充值，但是我们还是需要在软删除之前手动赋值一次，因为 updateFill 函数内我们需要区分行为，软删除之前如果不手动设置，就无法识别是软删除行为，就无法自动填充值了。

public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
    private static final String isDelete = "isDelete";
    private static final String updateUserId = "updateUserId";
    private static final String deleteUserId = "deleteUserId";
    private static final String updateTime = "updateTime";
    private static final String deleteTime = "deleteTime";

    @Override
    public void insertFill(MetaObject metaObject) {}

    @Override
    public void updateFill(MetaObject metaObject) {
        // 软删除时，需要外面先 setIsDelete(true)，否则无法识别是更新还是软删除操作
        if (metaObject.hasGetter(isDelete) && metaObject.getValue(isDelete) == Boolean.TRUE) {
            this.strictUpdateFill(metaObject, deleteUserId, StpUtil::getLoginIdAsInt, Integer.class);
            this.strictUpdateFill(metaObject, deleteTime, Date::new, Date.class);
        } else {
            this.strictUpdateFill(metaObject, updateUserId, StpUtil::getLoginIdAsInt, Integer.class);
            this.strictUpdateFill(metaObject, updateTime, Date::new, Date.class);
        }
    }

    /**
     * 严格模式填充策略,默认有值不覆盖,如果提供的值为null也不填充
     *
     * @param metaObject metaObject meta object parameter
     * @param fieldName  java bean property name
     * @param fieldVal   java bean property value of Supplier
     * @return this
     * @since 3.3.0
     */
    @Override
    public MetaObjectHandler strictFillStrategy(MetaObject metaObject, String fieldName, Supplier<?> fieldVal) {
        // 但当自动填充字段为 updateTime 时，始终更新它
        if (fieldName.equals(updateTime)) {
            Object obj = fieldVal.get();
            metaObject.setValue(fieldName, obj);
        } else if (metaObject.getValue(fieldName) == null) { // 这个 if 是源码中的
            Object obj = fieldVal.get();
            if (Objects.nonNull(obj)) {
                metaObject.setValue(fieldName, obj);
            }
        }
        return this;
    }
}

配置(注入到 IOC)

我们需要将上面写的 MybatisPlusSqlInjector 注入 IOC 容器。

同样的，这两个 Bean 的配置，与在 MybatisPlusSqlInjector 和 MybatisPlusMetaObjectHandler 上配置 @Configuration 注解的效果一样。

@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusSqlInjector mybatisPlusSqlInjector(){
        return new MybatisPlusSqlInjector();
    }

    @Bean
    public MybatisPlusMetaObjectHandler mybatisPlusCommonDateFieldValueFillHandler(){
        return new MybatisPlusMetaObjectHandler();
    }
}

创建 MyBaseRepository

我这里将 Mapper 称为 Repository。因为我用到了 MapStruct 库，个人感觉它更适合被称为 Mapper。

我们需要自己定义一个 MyBaseMapper 继承自 BaseMapper(mybatis plus 的)，然后添加一个如下的方法签名，必须跟下面示例代码一样，因为我猜测内部是通过反射来调用的这个函数，所以方法签名必须一致，否则无法被 mybatis plus 库调用哦。

public interface MyBaseMapper<Entity>  extends BaseMapper<Entity> {
    /**
     * 逻辑删除填充其他字段的值
     *
     * @param entity 要删除的实体对象
     * @return 受影响记录数量
     */
    int deleteByIdWithFill(Entity entity);
}

我们原来的 Repository 继承自 mybatis plus 的 BaseMapper，现在我们需要修改为继承自上面新写的 MyBaseMapper。

创建 MyBaseService

因为我希望 XXXService 中也有 deleteByIdWithFill 函数，所以这里我还自定义了 Service 的基类，如果不需要的话可以忽略本小节。

自定义的 MyBaseService 继承自 mybatis plus 的 IService<> 接口，然后添加如下方法签名，注意方法签名中的返回值是 boolean 而不是 int，因为写 Service 需要方便外部使用。

public interface MyBaseService<Entity> extends IService<Entity> {
    /**
     * 逻辑删除填充其他字段的值
     *
     * @param entity 要删除的实体对象
     * @return 受影响记录数量
     */
    boolean deleteByIdWithFill(Entity entity);
}

然后我们写一个 MyBaseService 的实现类。

注意这里我们需要继承自 mybatis plus 的 ServiceImpl 实现，减少我们自己实现的代码量，同时还需要实现我们的 MyBaseService 接口，然后内部写的巴巴适适的😋

public class MyBaseServiceImpl<EntityRepository extends MyBaseMapper<Entity>, Entity>
        extends ServiceImpl<EntityRepository, Entity>
        implements MyBaseService<Entity> {
    /**
     * 逻辑删除填充其他字段的值
     *
     * @param entity 要删除的实体对象
     * @return 受影响记录数量
     */
    @Override
    public boolean deleteByIdWithFill(Entity entity) {
         return SqlHelper.retBool(getBaseMapper().deleteByIdWithFill(entity));
    }
}

最后，原来的 XXXService 修改为继承自新写的 MyBaseService，XXXServiceImpl 修改为继承自新写的 MyBaseServiceImpl

public interface TestService extends MyBaseService<Test> {}

@Service
public class TestServiceImpl extends MyBaseServiceImpl<TestRepository, Test>
implements TestService{}

食用🍜

在 Controller 中的使用方法

@PostMapping("delete")
public ResponseEntity<?> delete(@Valid @NotNull(message = CommonRule.error.whenParamNull) @RequestBody TestTestDeleteBodyVo body) {
    final Test test = testService.getById(body.getId());
    if (test == null) {
        return ResponseEntity.ok().build();
    }

    test.setIsDelete(true);
    testService.deleteByIdWithFill(test); // 软删除必须是这样删除

    return ResponseEntity.ok().build();
}

posted @ 2021-07-14 13:19 myEsn2E9 阅读(1749) 评论(2) 编辑收藏举报

刷新页面返回顶部

Loading

myEsn2E9's Notepad

...

mybatis plus 增删改自动填充字段值

说明

创建

实体类

实现 `MetaObjectHandler`

配置

更新

实体类

实现 `MetaObjectHandler`

配置

软删除

配置 application.yml

实体类

重写 DefaultSqlInjector

实现 `MetaObjectHandler`

配置(注入到 IOC)

创建 MyBaseRepository

创建 MyBaseService

食用🍜

公告

Loading

myEsn2E9's Notepad

...

mybatis plus 增删改自动填充字段值

说明

创建

实体类

实现 MetaObjectHandler

配置

更新

实体类

实现 MetaObjectHandler

配置

软删除

配置 application.yml

实体类

重写 DefaultSqlInjector

实现 MetaObjectHandler

配置(注入到 IOC)

创建 MyBaseRepository

创建 MyBaseService

食用🍜

公告

实现 `MetaObjectHandler`

实现 `MetaObjectHandler`

实现 `MetaObjectHandler`