标签：conf 一段 复制 lis proc config value statement 技术分享
摘一段来自MyBatis官方文档的文字。
MyBatis允许你在某一点拦截已映射语句执行的调用。默认情况下，MyBatis允许使用插件来拦截方法调用
这些类中方法的详情可以通过查看每个方法的签名来发现，而且它们的源代码存在于MyBatis发行包中。你应该理解你所覆盖方法的行为，假设你所做的要比监视调用要多。如果你尝试修改或覆盖一个给定的方法，你可能会打破MyBatis的核心。这是低层次的类和方法，要谨慎使用插件。
插件示例：打印每条SQL语句及其执行时间
以下通过代码来演示一下如何使用MyBatis的插件，要演示的场景是：打印每条真正执行的SQL语句及其执行的时间。这是一个非常有用的需求，MyBatis本身的日志可以记录SQL，但是有以下几个问题：
写MyBatis插件非常简单，只需要实现Interceptor接口即可，我这里将我的Interceptor命名为SqlCostInterceptor：
分析一下这段代码（这个是改良过的版本，主要是增加了对select * from xxx where id in <foreach collection="list">...</foreach>这种写法占位符替换为真正参数的支持）。
首先是注解@Intercepts与@Signature，这两个注解是必须的，因为Plugin的wrap方法会取这两个注解里面参数。@Intercepts中可以定义多个@Signature，一个@Signature表示符合如下条件的方法才会被拦截：
接着的一个问题是：有四个接口可以拦截，为什么使用StatementHandler去拦截？根据名字来看ParameterHandler和ResultSetHandler，前者处理参数，后者处理结果是不可能使用的，剩下的就是Executor和StatementHandler了。拦截StatementHandler的原因是而不是用Executor的原因是：
接着讲一下setProperties方法，可以将一些配置属性配置在<plugin></plugin>的子标签<property />中，所有的配置属性会在形参Properties中，setProperties方法可以拿到配置的属性进行需要的处理。
接着讲一下plugin方法，这里是为目标接口生成代理，不需要也没必要自己去写生成代理的方法，MyBatis的Plugin类已经为我们提供了wrap方法（当然如果自己有自己的逻辑也可以在Plugin.wrap方法前后加入，但是最终一定要使用Plugin.wrap方法生成代理），看一下该方法的实现：
1 public static Object wrap(Object target, Interceptor interceptor) {
2 Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
3 Class<?> type = target.getClass();
4 Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
5 if (interfaces.length > 0) {
6 return Proxy.newProxyInstance(
7 type.getClassLoader(),
8 interfaces,
9 new Plugin(target, interceptor, signatureMap));
10 }
11 return target;
12 }
因为这里的target一定是一个接口，因此可以放心使用JDK本身提供的Proxy类，这里相当于就是如果该接口满足方法签名那么就为之生成一个代理。
最后就是intercept方法了，这里就是拦截器的核心代码了，方法的逻辑我就不解释了，可以自己看一下，唯一要注意的一点就是无论如何最终一定要返回invocation.proceed()，保证拦截器的层层调用。
xml文件配置即效果演示
写完了插件，只需要在config.xml文件中进行一次配置即可，非常简单：
1 <plugins> 2 <plugin interceptor="org.xrq.mybatis.plugin.SqlCostInterceptor" /> 3 </plugins>
这里每个<plugin>子标签代表一个插件，interceptor表示拦截器的完整路径，每个人的不同。
有了类和这段配置，就可以使用SqlCostInterceptor了，SqlCostInterceptor是通用的，但是每个人的CRUD是不同的，我打印一下我这里CRUD执行的结果：
SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "1", "123@sina.com", "个人使用");]执行耗时[1ms] SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "2", "123@qq.com", "企业使用");]执行耗时[1ms] SQL：[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "3", "123@sohu.com", "注册账号使用");]执行耗时[0ms]
看到打印了完整的SQl语句以及SQL语句执行时间。
不过要说明一点，这个插件只是一个简单的Demo，我并没有完整测试过，应该是无法覆盖所有场景的，所以如果想用这段代码片段打印真正的SQL及其执行时间的朋友，还需要在这个基础上做修改，不过即使不改代码，这个插件起到美化SQL的作用，去除一些换行符还是没问题的。
至于MyBatis插件的实现原理，会在我【MyBatis源码分析】系列文章中详细解读，文章地址为【MyBatis源码分析】插件实现原理。
后记
MyBatis插件机制非常有用，用得好可以解决很多问题，不只是这里的打印SQL语句以及记录SQL语句执行时间，分页、分表都可以通过插件来实现。用好插件的关键是我开头就列举的，这里再列一次：
只有理解这四个接口及相关方法是干什么的，才能写出好的拦截器，开发出符合预期的功能。
原文地址：http://www.cnblogs.com/xrq730/p/6972268.html
MyBatis插件及示例----打印每条SQL语句及其执行时间
标签：conf 一段 复制 lis proc config value statement 技术分享
原文地址：http://www.cnblogs.com/oskyhg/p/7076066.html
