插件的定义和作用
首先引用MyBatis文档对插件(plugins)的定义:
MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下,MyBatis 允许使用插件来拦截的方法调用包括:
Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
ParameterHandler (getParameterObject, setParameters)
ResultSetHandler (handleResultSets, handleOutputParameters)
StatementHandler (prepare, parameterize, batch, update, query)
这些类中方法的细节可以通过查看每个方法的签名来发现,或者直接查看 MyBatis 发行包中的源代码。 如果你想做的不仅仅是监控方法的调用,那么你最好相当了解要重写的方法的行为。 因为如果在试图修改或重写已有方法的行为的时候,你很可能在破坏 MyBatis 的核心模块。 这些都是更低层的类和方法,所以使用插件的时候要特别当心。
Mybatis插件所拦截的4个对象正是在之前的MyBatis框架原理2:SqlSession运行过程文章中介绍的4个实现核心功能的接口。那么插件拦截这4个接口能做什么呢?根据之前文章对4个接口的介绍,可以猜测到:
Executor是SqlSession整个执行过程的总指挥,同时还对缓存进行操作,通过插件可以使用自定义的缓存,比如mybatis-enhanced-cache插件。
StatementHandler负责SQL的编译和执行,通过插件可以改写SQL语句。
ParameterHandler负责SQL的参数设置,通过插件可以改变参数设置。
ResultSetHandler负责结果集映射和存储过程输出参数的组装,通过插件可以对结果集映射规则改写。
插件的原理
在理解插件原理之前,得先搞清楚以下三个概念:
动态代理
代理模式是一种给真实对象提供一个代理对象,并由代理对象控制对真实对象的引用的一种设计模式,动态代理是在程序运行时动态生成代理类的模式,JDK动态代理对象是由java提供的一个Proxy类和InvocationHandler接口以及一个真实对象的接口生成的。通常InvocationHandler的实现类持有一个真实对象字段和定义一个invoke方法,通过Proxy类的newProxyInstance方法就可以生成这个真实对象的代理对象,通过代理对象调度方法实际就是调用InvocationHandler实现类的invoke方法,在invoke方法中可以通过反射实现调用真实对象的方法。
拦截器(Interceptor)
动态代理对象可以对真实对象方法引用,是因为InvocationHandler实现类持有了一个真实对象的字段,通过反射就可以实现这个功能。如果InvocationHandler实现类再持有一个Interceptor接口的实现类,Interceptor接口定义了一个入参为真实对象的intercept方法,Interceptor接口的实现类通过重写intercept方法可以对真实对象的方法引用或者实现增强功能等等,也就是当我们再次使用这个动态代理对象调度方法时,可以根据需求对真实对象的方法做出改变。
从这个Interceptor接口实现类的功能上来看,可以叫做真实对象方法的拦截器。于是我们再想一下,如果前面讲到MyBatis的4个核心功能接口的实现类(比如PreparedStatementHandler)是一个真实对象,我们通过JDK动态代理技术生成一个代理对象,并且生成代理类所需的InvocationHandler实现类同时还持有了一个Interceptor接口实现类,通过使用代理对象调度方法,我们就可以根据需求对PreparedStatementHandler的功能进行增强。
实际上MyBatis确实提供了这样一个Interceptor接口和intercept方法,也提供了这样的一个InvocationHandler接口的实现类,类名叫Plugin,它们都位于MyBatis的org.apache.ibatis.plugin包下。等等,那么MyBatis的插件不就是拦截器吗?拦截器的原理都讲完了,等下还怎么讲什么插件原理?
责任链模式
我们通过JDK动态代理技术生成一个代理对象,代理的真实对象是个StatementHandler,并且持有StatementHandler的拦截器(插件)。如果我们把这个代理对象视为一个target对象,再利用动态代理生成一个代理类,并且持有对这个target对象的拦截器(插件),如果再把新生成的代理视为一个新的target类,同样持有对新target类的拦截器(插件),那么我们就得到了一个像是被包裹了三层拦截器(插件)的StatementHandler的代理对象:
当MyBatis每一次SqlSession会话需要引用到StatementHandler的方法时,如过符合上图中拦截器3的拦截逻辑,则按拦截器3的定义的方法执行;如果不符合拦截逻辑,则将执行责任交给拦截器2处理,以此类推,这样的模式叫做责任链模式。MyBatis全局配置文件里可以配置多个插件,多个插件的运行就是按照这样的责任链模式执行的。
通过对以上三点的理解,我们已经对MyBatis插件原理已经有了初步认识,下面就通过源码看看MyBatis插件是如何运行起来的。
插件的运行过程
插件的接口
MyBatis提供了一个Interceptor接口,插件必须实现这个接口,接口定义了3个方法如下:
publicinterfaceInterceptor{// 执行插件实现的方法,Invocation对象持有真实对象,可通过反射调用真实对象的方法Objectintercept(Invocation invocation)throwsThrowable;// 设置插件拦截的对象target,通常调用Pulgin类的wrap方法生成一个代理类Objectplugin(Object target);// 根据配置文件初始化插件voidsetProperties(Properties properties);}
插件的初始化
在MyBatis初始化时XMLConfigBuilderder的pluginElement方法对插件配置文件解析:
privatevoidpluginElement(XNode parent)throwsException{if(parent !=null) {for(XNode child : parent.getChildren()) { String interceptor = child.getStringAttribute("interceptor"); Properties properties = child.getChildrenAsProperties();// 通过反射生成插件的实例Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();// 调用插件配置参数interceptorInstance.setProperties(properties);// 将插件实例保存到Configuration对象中configuration.addInterceptor(interceptorInstance); } }}
Configuration对象最终将解析出的插件配置保存在持有InterceptorChain对象中,InterceptorChain对象又是通过一个ArrayList来保存所有插件,可见在MyBatis初始化的时候插件配置就已经加载好了,运行时就会根据插件编写的规则执行拦截逻辑。
publicclassInterceptorChain{// 通过集合来保存插件privatefinalList interceptors =newArrayList();// 通过责任链模式调用插件plugin方法生成代理对象publicObjectpluginAll(Object target){for(Interceptor interceptor : interceptors) { target = interceptor.plugin(target); }returntarget; }// Configuration对象调用的添加插件的方法publicvoidaddInterceptor(Interceptor interceptor){ interceptors.add(interceptor); }publicListgetInterceptors(){returnCollections.unmodifiableList(interceptors); }}
插件的运行
如果我们需要拦截MyBatis的Executor接口,Configuration在初始化Executor时就会通过责任链模式将初始化的Executor作为真实对象,调用InterceptorChain的pluginAll放法生成代理对象:
publicExecutornewExecutor(Transaction transaction, ExecutorType executorType){executorType = executorType ==null? defaultExecutorType : executorType;executorType = executorType ==null? ExecutorType.SIMPLE : executorType;Executor executor;// 根据配置文件生成相应Executorif(ExecutorType.BATCH == executorType) { executor =newBatchExecutor(this, transaction);}elseif(ExecutorType.REUSE == executorType) { executor =newReuseExecutor(this, transaction);}else{ executor =newSimpleExecutor(this, transaction);}if(cacheEnabled) { executor =newCachingExecutor(executor);}// 调用InterceptorChain的pluginAll放法生成代理对象executor = (Executor) interceptorChain.pluginAll(executor);returnexecutor;}
InterceptorChain的 pluginAll方法调用插件的plugin方法,plugin方法可以调用MyBatis提供的工具类Plugin类来生成代理对象,Plugin类实现了InvocationHandler,在Plugin类中定义invoke方法来实现拦截逻辑和执行插件方法:
publicclassPluginimplementsInvocationHandler{// target为需要拦截的真实对象 privatefinalObject target;// interceptor为插件privatefinalInterceptor interceptor;privatefinalMap, Set> signatureMap;privatePlugin(Object target, Interceptor interceptor, Map
插件的intercept方法参数为Invocation对象,Invocation对象持有真实对象和一个proceed方法,proceed方法通过反射调用真实对象的方法。于是多个插件生成的责任链模式的代理对象,就可以通过一层一层执行proceed方法来调用真实对象的方法。
插件的开发
自己编写插件必须继承MyBatis的Interceptor接口
publicinterfaceInterceptor{// 执行插件实现的方法,Invocation对象持有真实对象,可通过反射调用真实对象的方法Objectintercept(Invocation invocation)throwsThrowable;// 设置插件拦截的对象target,通常调用Pulgin类的wrap方法生成一个代理类Objectplugin(Object target);// 根据配置文件初始化插件voidsetProperties(Properties properties); }
使用@Intercepts和@Signature注解
@Intercepts({@Signature(type = StatementHandler.class, method ="prepare", args = {Connection.class ,Integet.class})})publicclassMyPluginimplementsInterceptor{...}
用@Intercepts注解申明是一个插件,@Signature注解申明拦截的对象,方法和参数。上面的写法表明了拦截了StatementHandler对象的prepare方法,参数是一个Connection对象和一个Integet。
编写拦截方法
MyBatis提供了一个Invocation工具类,通常我们将需要拦截的真实对象,方法及参数封装在里面作为一个参数传给插件的intercept方法,在插件intercept方法里可以编写拦截逻辑和执行拦截方法,方法参数invocation可以通过反射调用被代理对象的方法:
@Intercepts({@Signature(type = StatementHandler.class, method ="prepare", args = {Connection.class ,Integet.class})})publicclassMyPluginimplementsInterceptor{@overridepublicObjectintercept(Invocation invocation)throwsThrowable{// do something ...// 调用被代理对象的方法invocation.proceed();// do something ...@override调用Plugin工具类生成代理对象publicObjectplugin(Object target){returnPlugin.wrap(target,this); } ... }
生成代理对象
MyBatis还提供了一个Plugin工具类,其中wrap方法用于生成代理类,invoke方法验证拦截类型和方法,并选择是否按拦截器的方法,代码如下:
publicclassPluginimplementsInvocationHandler{privatefinalObject target;// 真实对象privatefinalInterceptor interceptor;// 拦截器(插件)privatefinalMap, Set> signatureMap;// Map保存签名的类型,方法和参数信息privatePlugin(Object target, Interceptor interceptor, Map
总结
MyBatis插件运行依靠Java动态代理技术实现,虽然原理很简单,但是编写插件涉及到修改MyBatis框架底层的接口,需要十分谨慎,做为初学者,最好使用现成的插件。