mybatis（3）—自定义拦截器（上）基础使用

Posted 2023-03-20

参考技术A

mybatis自定义拦截器（一）基本使用
mybatis自定义拦截器（二）对象详解

1. 不同拦截类型执行顺序：

2. 多个插件拦截的顺序？

需要注意的是，因为拦截器Aa和拦截器Bb均是拦截的StatementHandler对象，所以拦截器B在此获取StatementHandler的时候，获取的是代理对象。

3. 多个插件plugin()和intercept()方法的执行顺序

先执行每个插件的plugin方法，若是@Intercepts注解标明需要拦截该对象，那么生成类型对象的代理对象。（即使该插件需要拦截该类型对象，但是依旧会执行下一个插件的plugin方法）。知道执行完毕所有的plugin方法。在执行每个Intercept方法。

自定义拦截器必须使用mybatis提供的注解来声明我们要拦截的类型对象。

Mybatis插件都要有Intercepts [in特赛婆斯] 注解来指定要拦截哪个对象哪个方法。我们知道，Plugin.wrap方法会返回四大接口对象的代理对象，会拦截所有的方法。在代理对象执行对应方法的时候，会调用InvocationHandler处理器的invoke方法。

具体规则如下：

如果我们的拦截器需要一些变量对象，而且这个对象是支持可配置的。
类似于Spring中的@Value("$")从 application.properties 文件中获取。
使用方法：

方法中获取参数： properties.getProperty("username");

问题：但是为什么不直接使用@Value("$") 获取变量？

解答：因为mybatis框架本身就是一个可以独立使用的框架，没有像Spring这种做了很多的依赖注入。

这个方法的作用是就是让mybatis判断，是否要进行拦截，然后做出决定是否生成一个代理。

需要注意的是：每经过一个拦截器对象都会调用插件的plugin方法，也就是说，该方法会调用4次。根据@Intercepts注解来决定是否进行拦截处理。

解答：判断是否拦截这个类型对象（根据@Intercepts注解决定），然后决定是返回一个代理对象还是返回原对象。

故我们在实现plugin方法时，要判断一下目标类型，是本插件要拦截的对象时才执行Plugin.wrap方法，否则的话，直接返回目标本身。

我们知道，mybatis只能拦截四种类型的对象。而 intercept 方法便是处理拦截到的对象。比如我们要拦截 StatementHandler#query(Statement st,ResultHandler rh) 方法，那么 Invocation 就是这个对象， Invocation 中有三个参数。

org.apache.ibatis.reflection.SystemMetaObject#forObject ：方便的获取对象中的值。

案例：将参数拼接到sql语句。

因为已经执行了ParameterHandler拦截器，故Statement对象已经是完全拼接好的SQL语句。

一个MappedStatement对象对应Mapper配置文件中的一个select/update/insert/delete节点，主要描述的是一条sql语句。其属性为：

https://blog.csdn.net/Liu_York/article/details/88053053

https://www.jianshu.com/p/7c7b8c2c985d

MyBatis 插件之拦截器（Interceptor）

Mybatis Plugin（拦截器）的开发

Mybatis拦截器介绍

使用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等问题