概要:1介绍及配置、2源码分析、3为何拦截这些方法 4注解 和 Plugin类使用
总结:1)plugin()构建处理器(Handler)。interceptor()执行代理类。setProperties设置属性
2)官网提供 @Interceptors和 @Signature及Plugin类,不一定直接用,可以抛弃,直接在plugin内部根据target类型操作
MyBatis提供插件(plugin),插件是拦截器功能。允许插件拦截方法:
Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
ParameterHandler (getParameterObject, setParameters)
ResultSetHandler (handleResultSets, handleOutputParameters)
StatementHandler (prepare, parameterize, batch, update, query)
可拦截Executor接口部分方法如update,query,commit,rollback
拦截器拦截MyBatis中:1拦截执行器方法、2拦截参数、3结果集、4Sql语法构建的处理
一、介绍及配置
接口定义:默认没有实现类,可实现符合自己需求拦截器,下面官网实例
全局xml配置
拦截Executor接口的update方法(就是SqlSession新增,删除,修改操作)
二、源码分析(源头->配置文件开始分析)
1、XMLConfigBuilder解析MyBatis全局配置文件的pluginElement私有方法:通过反射实例化plugin节点中的interceptor属性表示的类
2、然后调Configuration(全局配置类)的addInterceptor方法
3、interceptorChain 拦截器链 是Configuration内部属性,类型为InterceptorChain 定义:
三、为何拦截器会拦截这些方法
理解拦截器配置解析及归属,回过头看,为何拦截器会拦截这些方法(Executor,ParameterHandler,ResultSetHandler,StatementHandler的部分方法):
1)4个方法实例化对应对象:都是Configuration方法。crud操作中都会被执行到,顺序Executor,ParameterHandler,ResultSetHandler,StatementHandler
(ParameterHandler和ResultSetHandler的创建是在创建StatementHandler[3个可用的实现类CallableStatementHandler,PreparedStatementHandler,SimpleStatementHandler]时,其构造函数调用的[这3个实现类的构造函数其实都调用了父类BaseStatementHandler的构造函数])。
2)调interceptorChain的pluginAll方法,InterceptorChain的pluginAll刚介绍过,遍历所有拦截器,调各个拦截器plugin()。注意:plugin返回值会直接赋值给原对象
3)由于可拦截StatementHandler,主要处理sql,比如分页,在拦截器plugin()中处理StatementHandler中的sql即可,反射实现
四、注解 和 Plugin类使用
1、@Intercepts和 @Signature
2、Plugin类的wrap方法:
实现InvocationHandler接口,返回了JDK自身提供动态代理类
3、其中getSignatureMap方法:
1)先拿到拦截器这个类@Interceptors注解,
2)拿注解属性 @Signature注解集合,
3)遍历这个集合,拿@Signature的type属性(Class类型),
4)根据type得到有method和args属性的Method。
5)终会返回Map,type为key,value为Set<Method>,由于 @Interceptors的 @Signature属性是一个属性
如:@Interceptors返回key为Executor,value为集合(只有一个元素,Method实例,Executor的update,有MappedStatement和Object参数)。
Method实例是根据 @Signature的method和args属性得到的。如果args参数跟type类型的method方法对不上,抛异常
4、getAllInterfaces方法:
根据目标实例target(可拦截的类,Executor,ParameterHandler,ResultSetHandler,StatementHandler)和它父类们,返回signatureMap中含有target实现的接口数组
Plugin类作用:根据 @Interceptors注解,得注解属性 @Signature数组,根据每个 @Signature的type,method,args属性反射找到对应Method。根据调用target对象实现接口决定是否返回代理对象替代原先target对象。
如官网例子,当Configuration调newExecutor时,由于Executor的update(MappedStatement ms, Object parameter)被截获。返回代理类Plugin,不是Executor。如果是代理类,执行:Interceptor接口的interceptor方法
proceed方法调用原先方法(不走代理)
https://www.cnblogs.com/fangjian0423/p/mybatis-interceptor.html
https://mp.weixin.qq.com/s/yMH88vB0HAkhFqcdnMM2oQ