温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

mybatis plus CU如何实现自动填充和软删除自动填充

发布时间:2021-07-14 15:33:45 来源:亿速云 阅读:321 作者:chen 栏目:开发技术

本篇内容主要讲解“mybatis plus CU如何实现自动填充和软删除自动填充”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“mybatis plus CU如何实现自动填充和软删除自动填充”吧!

说明

CU 是 CRUD 中的创建和修改

本文实现以下需求效果

  • 创建数据时自动填充 createTime

  • 更新数据时自动填充 updateTime(每次修改都自动填充新的 updateTime 值)

  • 软删除数据时自动填充 deleteUserIddeleteTime

创建

实体类

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

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

实现 MetaObjectHandler

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

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

    @Override
    public void insertFill(MetaObject metaObject) {
        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 Date updateTime;

实现 MetaObjectHandler

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

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

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

    @Override
    public void insertFill(MetaObject metaObject) {}

    @Override
    public void updateFill(MetaObject metaObject) {
        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,所以 UpdateDelete 实际上都是走的 updateFill 函数,在函数内部我们需要区分出到底是更新还是软删除,才能继续下一步即自动填充不同行为下字段的值

public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
    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) {
        // 有这两个字段并且也已经 deleteUserId 有值(外面必须为实体类设置 deleteUserId 字段的值),deleteTime 外面不给值
        if (metaObject.hasGetter(deleteUserId)
                && metaObject.hasGetter(deleteTime)
                && !ObjectUtil.isNull(metaObject.getValue(deleteUserId))
                && ObjectUtil.isNull(metaObject.getValue(deleteTime))) {
            this.strictUpdateFill(metaObject, deleteUserId, () -> (Integer) metaObject.getValue(deleteUserId), Integer.class);
            this.strictUpdateFill(metaObject, deleteTime, Date::new, Date.class);
        } else {
            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 的配置,与在 MybatisPlusSqlInjectorMybatisPlusMetaObjectHandler 上配置 @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 修改为继承自新写的 MyBaseServiceXXXServiceImpl 修改为继承自新写的 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.setDeleteUserId(StpUtil.getLoginIdAsInt()); // 必须在软删之前设置 deleteUserId 字段的值
    testService.deleteByIdWithFill(test); // 软删除必须是这样删除

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

到此,相信大家对“mybatis plus CU如何实现自动填充和软删除自动填充”有了更深的了解,不妨来实际操作一番吧!这里是亿速云网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI