带着问题看源码之: ibatis/mybatis 源码解析 -
Interceptor 接口声明 , 有三个方法
Objectintercept(Invocation invocation)throws Throwable;
Objectplugin(Object target);
void setProperties(Properties properties);
问题一: 我们的 Interceptor 是何时被注册到 ibatis 的, 注册到哪里去了
首先回答注册到哪里去: configuration.InterceptorChain 中 , 结构为 : List interceptors =new ArrayList();
xml 声明 Interceptor 的地方 有两个:
1. ibatis 的 config 配置 <plugins> 中配置 , 这个配置文件 我们一般叫做 mybatis-config.xml
2. spring 配置数据源的地方配置 sqlSessionFactory(class="org.mybatis.spring.SqlSessionFactoryBean") 时 以property 的方式给sqlSessionFactoryBean 的 plugins 赋值
① 方式声明的plugin 添加的 configuration的 InterceptorChain 路径为: SqlSessionFactoryBean.afterPropertiesSet().buildSqlSessionFactory() ---> XmlConfigBuilder.parse().parseConfiguration(XNode root).pluginElement(root.evalNode("plugins")).configuration.addInterceptor(interceptorInstance)
进而调用 InterceptorChain的addInterceptor 方法添加 到 InterceptorChain 的 List interceptors =new ArrayList(); 中
②方式声明的plugin 添加到 configuration的InterceptorChain 路径为:
SqlSessionFactoryBean.afterPropertiesSet().buildSqlSessionFactory().configuration.addInterceptor(interceptorInstance)
①和②的实现逻辑都从 sqlSessionFactoryBean.afterPropertiesSet().buildSqlSessionFactory() 开始看就好
问题二: 我们的Interceptor 是何时被调用的 , 初次被调用时调用了哪个方法
InterceptorChain 除了问题一的 addInterceptor 方法外 还有两个方法:
public Object pluginAll(Object target)
public List getInterceptors()
下面我们看一下 pluginAll 的实现:
public Object pluginAll(Object target) {
for (Interceptor interceptor :interceptors) {
target = interceptor.plugin(target);
}
return target;
}
初次被调用时调用了哪个方法: 所以是先调用了 plugin 方法 。
那是哪里 调用了 pluginAll 呢 ？
追踪方法调用链 找到如下 四个地方:
1. org.apache.ibatis.session.Configuration#newParameterHandler -->代理ParameterHandler 类
2. org.apache.ibatis.session.Configuration#newResultSetHandler --> 代理ResultSetHandler类
3. org.apache.ibatis.session.Configuration#newStatementHandler --> 代理StatementHandler 类 (常用)
4. org.apache.ibatis.session.Configuration#newExecutor(org.apache.ibatis.transaction.Transaction, org.apache.ibatis.session.ExecutorType) --> 代理 Executor 类
处理的目的不同 , 拦截的类, 方法 就不同 ;
可以代理的方法 是 上面的类 拥有的方法 , 代理哪些方法是 你的 Interceptor 类上的@Interceptors 注解的@Signature声明的
举个例子:
@Intercepts({@Signature(
type = Executor.class,
method ="query",
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}
), @Signature(
type = Executor.class,
method ="query",
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}
), @Signature(
type = Executor.class,
method ="update",
args = {MappedStatement.class, Object.class}
)})
那么回过头来看, 调用了我们的Interceptor的 plugin 方法 , 我们应该做什么呢?
其实上面的四个方法 调用我们的plugin 时 , 只是四个可以拦截的类 创建实例的时候 , 并没有进入到 ParameterHandler 、ResultSetHandler、 StatementHandler、Executor 相应的可拦截方法，所以我们就需要ibatis 在真正执行 @Signature 指定的那些操作时告知我们 ，这里常规的是通过 Plugin.wrap 方法 创建一个 target 的代理类 , 在代理类中判断target 对象执行的方法是否为我们 @signature 中指定的方法时 才执行我们的逻辑 , 这里为 调用我们的 Interceptor 方法 , 我们看一下 Plugin的wrap 方法 就知晓了。
调用我们实现拦截的目的逻辑 , 在 Plugin 这个代理类的invoke方法中：
这里 是否 调用 Interceptor 的 Interceptor 方法判断的依据是 当前 方法是否在 signatureMap 中 ， 其实signatureMap 是在Plugin.wrap 创建Plugin 作为 我们自定义Interceptor 的代理类是 处理的 Plugin#getSignatureMap 主要就是解析当前Interceptor 的注解 @Interceptors 以及 @Signature 将符合条件的方法放到signatureMap 中 ;
我们的Interceptor是何时被调用的:
1. 先被调用了plugin , 这里调用 Plugin.wrap 方法 创建了一个 target (ParameterHandler , ResultSetHandler , StatementHandler , Executor) 的代理类 , 并将当前Interceptor 作为参数传递过去 用于解析 Interceptor 上的@Interceptors , @Signature 注解 识别相应target的 哪些方法需要被代理加入到 signatureMap 中
2. 当target 类 执行方法调用时 , 我们的 代理类判断 是否包含在 signatureMap 中, 如果包含则调用 Interceptor 的 Interceptor 方法
所以： Interceptor 的 Interceptor 方法才是我们 ibatis 拦截器 实现自定义逻辑的 关键所在 ， 拦截不同的方法 我们可以拿到 ibatis 运行时不同的参数对象 ， 从而 获取/更改 对象属性 以 实现自己的目的。
实现自己的目的 还需要对每一个参数的意义和功能有所了解， ibatis 中涉及的专业名词 出现的地方 、生效的地方及意义会在后面带着问题看源码的文章中讲解。
除了 众所周知的 debug 看源码 , 带着问题看源码可能更容易印象深刻 。 2019-08-17 22:23
