Plugins
摘一段來自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：
分析一下這段代碼（這個是改良過的版本，主要是增加了對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<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語句執行時間，分頁、分表都可以通過插件來實現。用好插件的關鍵是我開頭就列舉的，這里再列一次：
- Executor（update、query、flushStatements、commint、rollback、getTransaction、close、isClosed）
- ParameterHandler（getParameterObject、setParameters）
- ResultSetHandler（handleResultSets、handleOutputParameters）
- StatementHandler（prepare、parameterize、batch、update、query）
只有理解這四個接口及相關方法是干什么的，才能寫出好的攔截器，開發出符合預期的功能。