自定义mybatis拦截器

Posted 2023-04-27

参考技术A mybatis拦截器非常强大。用好了后，基础工具、高大上的代码封装都可以手到擒来。

一 mybatis中可以被拦截的类

（1） Executor ：执行器

（2） ParameterHandler：参数处理器

（3） ResultSetHandler ：结果集处理器

（4） StatementHandler：sql语句处理器。

二 自定义mybatis拦截器的定义。

（1）自定义类实现org.apache.ibatis.plugin.Interceptor接口

（2）自定义类上添加注解 org.apache.ibatis.plugin.Intercepts

（3）在上面注解中 定义要拦截的mybits的类型及对应方法。

通过org.apache.ibatis.plugin.Signature注解来定义。里面有三个参数： type代表拦截的类型即上面4个处理器，method 代码拦截的哪个方法,args 代表方法的参数类型。

三 实现代码

例子：mysql表中有的字段是decimal类型。查出的结果需要保留一位小数。

因为是对结果进行处理。这里我们拦截的是 ResultSetHandler

processMap方法实现如下

拦截器理解后还是挺简单的。积少成多。很快会成为面神。

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

文章目录

• • 使用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);
    

好了，通过上面的mybatis自定义拦截器，我们就完成了对审计数据的填充了。

参考

mybatis自定义拦截器拦截sql，处理createTime,updateTime,createBy,updateBy等问题