摘一段来自mybatis官方文档的文字。
mybatis允许你在某一点拦截已映射语句执行的调用。默认情况下，mybatis允许使用插件来拦截方法调用
executor（update、query、flushstatements、commint、rollback、gettransaction、close、isclosed）
parameterhandler（getparameterobject、setparameters）
resultsethandler（handleresultsets、handleoutputparameters）
statementhandler（prepare、parameterize、batch、update、query）
这些类中方法的详情可以通过查看每个方法的签名来发现，而且它们的源代码存在于mybatis发行包中。你应该理解你所覆盖方法的行为，假设你所做的要比监视调用要多。如果你尝试修改或覆盖一个给定的方法，你可能会打破mybatis的核心。这是低层次的类和方法，要谨慎使用插件。
插件示例：打印每条sql语句及其执行时间
以下通过代码来演示一下如何使用mybatis的插件，要演示的场景是：打印每条真正执行的sql语句及其执行的时间。这是一个非常有用的需求，mybatis本身的日志可以记录sql，但是有以下几个问题：
mybatis日志打印出来的sql日志，参数都被占位符?替换，无法知道真正执行的sql语句中的参数是什么
mybatis日志打印出来的sql日志，有大量的换行符，通常一句sql语句要通过十几行显示，阅读体验非常差
无法记录sql执行时间，有sql执行时间就可以精准定位到执行时间比较慢的sql
写mybatis插件非常简单，只需要实现interceptor接口即可，我这里将我的interceptor命名为sqlcostinterceptor：
1 /** 2 * sql执行时间记录拦截器 3 */ 4 @intercepts({@signature(type = statementhandler.class, method = query, args = {statement.class, resulthandler.class}), 5 @signature(type = statementhandler.class, method = update, args = {statement.class}), 6 @signature(type = statementhandler.class, method = batch, args = { statement.class })}) 7 public class sqlcostinterceptor implements interceptor { 8 9 @override 10 public object intercept(invocation invocation) throws throwable { 11 object target = invocation.gettarget(); 12 13 long starttime = system.currenttimemillis(); 14 statementhandler statementhandler = (statementhandler)target; 15 try { 16 return invocation.proceed(); 17 } finally { 18 long endtime = system.currenttimemillis(); 19 long sqlcost = endtime - starttime; 20 21 boundsql boundsql = statementhandler.getboundsql(); 22 string sql = boundsql.getsql(); 23 object parameterobject = boundsql.getparameterobject(); 24 list<parametermapping> parametermappinglist = boundsql.getparametermappings(); 25 26 // 格式化sql语句，去除换行符，替换参数 27 sql = formatsql(sql, parameterobject, parametermappinglist); 28 29 system.out.println(sql：[ + sql + ]执行耗时[ + sqlcost + ms]); 30 } 31 } 32 33 @override 34 public object plugin(object target) { 35 return plugin.wrap(target, this); 36 } 37 38 @override 39 public void setproperties(properties properties) { 40 41 } 42 43 @suppresswarnings(unchecked) 44 private string formatsql(string sql, object parameterobject, list<parametermapping> parametermappinglist) { 45 // 输入sql字符串空判断 46 if (sql == null || sql.length() == 0) { 47 return ; 48 } 49 50 // 美化sql 51 sql = beautifysql(sql); 52 53 // 不传参数的场景，直接把sql美化一下返回出去 54 if (parameterobject == null || parametermappinglist == null || parametermappinglist.size() == 0) { 55 return sql; 56 } 57 58 // 定义一个没有替换过占位符的sql，用于出异常时返回 59 string sqlwithoutreplaceplaceholder = sql; 60 61 try { 62 if (parametermappinglist != null) { 63 class<?> parameterobjectclass = parameterobject.getclass(); 64 65 // 如果参数是strictmap且value类型为collection，获取key=list的属性，这里主要是为了处理<foreach>循环时传入list这种参数的占位符替换 66 // 例如select * from xxx where id in <foreach collection="list">...</foreach> 67 if (isstrictmap(parameterobjectclass)) { 68 strictmap strictmap = (strictmap)parameterobject; 69 70 if (islist(strictmap.get(list).getclass())) { 71 sql = handlelistparameter(sql, strictmap.get(list)); 72 } 73 } else if (ismap(parameterobjectclass)) { 74 // 如果参数是map则直接强转，通过map.get(key)方法获取真正的属性值 75 // 这里主要是为了处理<insert>、<delete>、<update>、<select>时传入parametertype为map的场景 76 map<?, ?> parammap = (map<?, ?>) parameterobject; 77 sql = handlemapparameter(sql, parammap, parametermappinglist); 78 } else { 79 // 通用场景，比如传的是一个自定义的对象或者八种基本数据类型之一或者string 80 sql = handlecommonparameter(sql, parametermappinglist, parameterobjectclass, parameterobject); 81 } 82 } 83 } catch (exception e) { 84 // 占位符替换过程中出现异常，则返回没有替换过占位符但是格式美化过的sql，这样至少保证sql语句比boundsql中的sql更好看 85 return sqlwithoutreplaceplaceholder; 86 } 87 88 return sql; 89 } 90 91 /** 92 * 美化sql 93 */ 94 private string beautifysql(string sql) { 95 sql = sql.replace(\n, ).replace(\t, ).replace( , ).replace(( , ().replace( ), )).replace( ,, ,); 96 97 return sql; 98 } 99 100 /**101 * 处理参数为list的场景102 */103 private string handlelistparameter(string sql, collection<?> col) {104 if (col != null && col.size() != 0) {105 for (object obj : col) {106 string value = null;107 class<?> objclass = obj.getclass();108 109 // 只处理基本数据类型、基本数据类型的包装类、string这三种110 // 如果是复合类型也是可以的，不过复杂点且这种场景较少，写代码的时候要判断一下要拿到的是复合类型中的哪个属性111 if (isprimitiveorprimitivewrapper(objclass)) {112 value = obj.tostring();113 } else if (objclass.isassignablefrom(string.class)) {114 value = \ + obj.tostring() + \; 115 }116 117 sql = sql.replacefirst(\\?, value);118 }119 }120 121 return sql;122 }123 124 /**125 * 处理参数为map的场景126 */127 private string handlemapparameter(string sql, map<?, ?> parammap, list<parametermapping> parametermappinglist) {128 for (parametermapping parametermapping : parametermappinglist) {129 object propertyname = parametermapping.getproperty();130 object propertyvalue = parammap.get(propertyname);131 if (propertyvalue != null) {132 if (propertyvalue.getclass().isassignablefrom(string.class)) {133 propertyvalue = \ + propertyvalue + \;134 }135 136 sql = sql.replacefirst(\\?, propertyvalue.tostring());137 }138 }139 140 return sql;141 }142 143 /**144 * 处理通用的场景145 */146 private string handlecommonparameter(string sql, list<parametermapping> parametermappinglist, class<?> parameterobjectclass, 147 object parameterobject) throws exception {148 for (parametermapping parametermapping : parametermappinglist) {149 string propertyvalue = null;150 // 基本数据类型或者基本数据类型的包装类，直接tostring即可获取其真正的参数值，其余直接取paramtermapping中的property属性即可151 if (isprimitiveorprimitivewrapper(parameterobjectclass)) {152 propertyvalue = parameterobject.tostring();153 } else {154 string propertyname = parametermapping.getproperty();155 156 field field = parameterobjectclass.getdeclaredfield(propertyname);157 // 要获取field中的属性值，这里必须将私有属性的accessible设置为true158 field.setaccessible(true);159 propertyvalue = string.valueof(field.get(parameterobject));160 if (parametermapping.getjavatype().isassignablefrom(string.class)) {161 propertyvalue = \ + propertyvalue + \;162 }163 }164 165 sql = sql.replacefirst(\\?, propertyvalue);166 }167 168 return sql;169 }170 171 /**172 * 是否基本数据类型或者基本数据类型的包装类173 */174 private boolean isprimitiveorprimitivewrapper(class<?> parameterobjectclass) {175 return parameterobjectclass.isprimitive() || 176 (parameterobjectclass.isassignablefrom(byte.class) || parameterobjectclass.isassignablefrom(short.class) ||177 parameterobjectclass.isassignablefrom(integer.class) || parameterobjectclass.isassignablefrom(long.class) ||178 parameterobjectclass.isassignablefrom(double.class) || parameterobjectclass.isassignablefrom(float.class) ||179 parameterobjectclass.isassignablefrom(character.class) || parameterobjectclass.isassignablefrom(boolean.class));180 }181 182 /**183 * 是否defaultsqlsession的内部类strictmap184 */185 private boolean isstrictmap(class<?> parameterobjectclass) {186 return parameterobjectclass.isassignablefrom(strictmap.class);187 }188 189 /**190 * 是否list的实现类191 */192 private boolean islist(class<?> clazz) {193 class<?>[] interfaceclasses = clazz.getinterfaces();194 for (class<?> interfaceclass : interfaceclasses) {195 if (interfaceclass.isassignablefrom(list.class)) {196 return true;197 }198 }199 200 return false;201 }202 203 /**204 * 是否map的实现类205 */206 private boolean ismap(class<?> parameterobjectclass) {207 class<?>[] interfaceclasses = parameterobjectclass.getinterfaces();208 for (class<?> interfaceclass : interfaceclasses) {209 if (interfaceclass.isassignablefrom(map.class)) {210 return true;211 }212 }213 214 return false;215 }216 217 }
分析一下这段代码（这个是改良过的版本，主要是增加了对select * from xxx where id in <foreach collection="list">...</foreach>这种写法占位符替换为真正参数的支持）。
首先是注解@intercepts与@signature，这两个注解是必须的，因为plugin的wrap方法会取这两个注解里面参数。@intercepts中可以定义多个@signature，一个@signature表示符合如下条件的方法才会被拦截：
接口必须是type定义的类型
方法名必须和method一致
方法形参的class类型必须和args定义class类型顺序一致
接着的一个问题是：有四个接口可以拦截，为什么使用statementhandler去拦截？根据名字来看parameterhandler和resultsethandler，前者处理参数，后者处理结果是不可能使用的，剩下的就是executor和statementhandler了。拦截statementhandler的原因是而不是用executor的原因是：
executor的update与query方法可能用到mybatis的一二级缓存从而导致统计的并不是真正的sql执行时间
statementhandler的update与query方法无论如何都会统计到preparedstatement的execute方法执行时间，尽管也有一定误差（误差主要来自会将处理结果的时间也算上），但是相差不大
接着讲一下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 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语句执行时间，分页、分表都可以通过插件来实现。用好插件的关键是我开头就列举的，这里再列一次：
executor（update、query、flushstatements、commint、rollback、gettransaction、close、isclosed）
parameterhandler（getparameterobject、setparameters）
resultsethandler（handleresultsets、handleoutputparameters）
statementhandler（prepare、parameterize、batch、update、query）
只有理解这四个接口及相关方法是干什么的，才能写出好的拦截器，开发出符合预期的功能。
以上就是mybatis插件的详细介绍的详细内容。