使用Mybatis自定义拦截器处理CreateBy,UpdateBy审计数据的填充

最新推荐文章于 2024-08-12 01:18:13 发布

阅读量2k

点赞数

CC 4.0 BY-SA版权

分类专栏： Mybatis 文章标签： mybatis

本文链接：https://blog.youkuaiyun.com/cckevincyh/article/details/123955663

Mybatis 专栏收录该内容

16 篇文章

订阅专栏

本文介绍了如何使用Mybatis自定义拦截器来自动处理CreateBy和UpdateBy等审计字段的填充。通过拦截Executor的update方法，在插入和更新操作中动态设置创建者和更新者信息，实现了在不改变业务代码的情况下完善审计功能。

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

文章目录

- 使用Mybatis自定义拦截器处理CreateBy,UpdateBy审计数据的填充
- - Mybatis自定义拦截器的实现
  - 参考

使用Mybatis自定义拦截器处理CreateBy,UpdateBy审计数据的填充

上一篇博文，我们是用了Mybatis的自定义拦截器，对表进行水平切分。这次我们是用mybatis的拦截器来完成审计数据的填充，比如createBy，updateBy等等。

Mybatis自定义拦截器的实现

我们直接看mybatis自定义拦截器的实现吧。

Mybatis执行增删改的底层核心接口是Executor.update，如果我们想对它进行拦截处理，则需要拦截此方法

所以首先我们需要拦截执行器的方法(Executor)，因为我们需要在插入和修改的过程中加入createBy和updateBy

@Intercepts({@Signature(
        type = Executor.class,
        method = "update",
        args = {MappedStatement.class, Object.class})})
@Component
@Slf4j
public class MybatisInterceptor implements Interceptor {
    private static final Integer INDEX_ZERO = 0;
    private static final Integer INDEX_ONE = 1;
    @Value("${spring.application.name}")
    private String applicationName;

    @Override
    public Object intercept(Invocation invocation) throws InvocationTargetException, IllegalAccessException {
        Object[] queryArgs = invocation.getArgs();
        MappedStatement mappedStatement = (MappedStatement) queryArgs[INDEX_ZERO];
        Object object = queryArgs[INDEX_ONE];
        SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();
        UserInfo userInfo = UserContextHolder.get(); //获取ThreadLocal中的当前用户信息
        String domainId = userInfo != null ? userInfo.getDomainId() : null;
        if (SqlCommandType.INSERT.equals(sqlCommandType)) { //判断类型为INSERT
            return handleInsert(invocation, object, domainId);
        }
        if (SqlCommandType.UPDATE.equals(sqlCommandType)) { //判断类型为UPDATE
            return handleUpdate(invocation, object, domainId);
        }
        return invocation.proceed();
    }

    private Object handleUpdate(Invocation invocation, Object object, String domainId) throws InvocationTargetException, IllegalAccessException {
        handleUpdateBy(object, domainId);
        return invocation.proceed();
    }

    private void handleCreateByAndUpdateBy(Object object, String domainId) {
        if (object instanceof MapperMethod.ParamMap) {
            List<?> list = (List<?>) ((MapperMethod.ParamMap) object).get("list");
            if (CollectionUtil.isNotEmpty(list)) {
                list.forEach(item -> setCreateByAndUpdateBy(item, domainId));
            }
        } else {
            setCreateByAndUpdateBy(object, domainId);
        }
    }

    private void setCreateByAndUpdateBy(Object object, String domainId) { //设置createBy和updateBy， 这里对表实体类都抽取了一个父类CommonEntiy，来存审计数据，比如craeteBy和updateBy
        if (object instanceof CommonEntity) {
            if (StringUtils.isNotEmpty(domainId)) {
                ((CommonEntity) object).setCreateBy(domainId);
                ((CommonEntity) object).setUpdateBy(domainId);
            } else {
                String hostName = StringUtil.defaultString(EnvUtil.getHostName(), applicationName);
                ((CommonEntity) object).setCreateBy(hostName);
                ((CommonEntity) object).setUpdateBy(hostName);
            }
        }
    }

    private void handleUpdateBy(Object object, String domainId) { 设置和updateBy
        if (object instanceof CommonEntity) {
            if (StringUtils.isNotEmpty(domainId)) {
                ((CommonEntity) object).setUpdateBy(domainId);
            } else {
                ((CommonEntity) object).setUpdateBy(StringUtil.defaultString(EnvUtil.getHostName(), applicationName));
            }
        }
    }

    private Object handleInsert(Invocation invocation, Object object, String domainId) throws InvocationTargetException, IllegalAccessException {
        handleCreateByAndUpdateBy(object, domainId);
        Object proceed = invocation.proceed();
        if (proceed instanceof Integer && (Integer) proceed == 0) {
            throw new InsertFailureException("Exception has occurred during data insertion");
        }
        if (object instanceof CommonEntity) {
            ((CommonEntity) object).setVersion(1L);
        }
        return proceed;
    }


    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
}