1. 自定義外掛友情提醒
MyBatis 允許我們在已對映 SQL 語句執行過程中的某一點進行攔截呼叫。預設情況下，MyBatis 允許使用外掛來攔截的方法呼叫包括：
- Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)
這些介面中方法的細節可以通過檢視每個方法的簽名來發現，或者直接檢視 MyBatis 發行包中的原始碼。 如果你想做的不僅僅是監控方法的呼叫，那麼你最好相當瞭解要重寫的方法的行為。 因為如果在試圖修改或重寫已有方法的行為的時候，你很可能在破壞 MyBatis 的核心模組。 這些都是更低層的類和方法，所以使用外掛的時候要特別當心。
2. 自定義外掛方式
通過 MyBatis 提供的強大機制，使用外掛是非常簡單的，只需實現 Interceptor 介面，並指定想要攔截的方法簽名即可。
// ExamplePlugin.java
@Intercepts({
@Signature(
type= Executor.class,
method = "query",
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})})
public class ExamplePlugin implements Interceptor {
public Object intercept(Invocation invocation) throws Throwable {
return invocation.proceed();
}
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
public void setProperties(Properties properties) {
}
}複製程式碼3. 外掛配置方式
定義好外掛後，一般將外掛配置在 MyBatis-config.xml 中即可使用：
<plugins>
<plugin interceptor="org.apache.ibatis.builder.ExamplePlugin" >
<property name="pluginProperty" value="100"/>
</plugin>
</plugins>複製程式碼如果你用的是 Spring 專案，還可以通過在 SqlSessionFactoryBean 中注入使用：
//配置分頁外掛，詳情請查閱官方文件
ExamplePlugin examplePlugin = new ExamplePlugin();Properties properties = new Properties();
properties.setProperty("xxx", "xxx");
examplePlugin .setProperties(properties);
//新增外掛
factory.setPlugins(new Interceptor[]{examplePlugin });複製程式碼4. 外掛物件如何建立的
在 ExamplePlugin 中，有一個 plugin(Object target) 方法，這個方法內部呼叫了 Plugin.warp(Object target, Interceptor interceptor) 方法，這個 warp 方法就是要為 target 物件建立代理物件 proxy 。而這個建立出來的代理物件 proxy 就是我們要的外掛物件 。那這個物件是何時何地建立出來的呢？
在 Mybatis 中，建立代理物件 proxy 的類只有一個，就是上面說的 Plugin 類，原始碼如下：
public class Plugin implements InvocationHandler {
// 儲存攔截器攔截的物件（這個target可能是個攔截器，也可能就是目標物件）
private final Object target;
// 攔截器物件
private final Interceptor interceptor;
// 見 getSignatureMap 方法
private final Map<Class<?>, Set<Method>> signatureMap;
private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
this.target = target;
this.interceptor = interceptor;
this.signatureMap = signatureMap;
}
// 判斷interceptor是否支援target攔截，支援則建立target的代理物件，否則原樣返回target
// 如果一個物件適配多個interceptor，則會被多次代理
public static Object wrap(Object target, Interceptor interceptor) {
// 解析 interceptor 的 @interceptors 註解中定義的內容
Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
// 獲取 target 的位元組碼物件
Class<?> type = target.getClass();
// 根據 type 和 signatureMap，獲取 type 查詢所有匹配的攔截器支援攔截的介面位元組碼物件陣列
Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
// 如果 interfaces 的大小大於 0，則給 target 物件建立代理物件。否則不建立代理物件
if (interfaces.length > 0) {
// 建立 target 的代理類物件。利用的是 JDK 動態代理
return Proxy.newProxyInstance(type.getClassLoader(), interfaces, new Plugin(target, interceptor, signatureMap));
}
return target;
}
// 實現 JDK 的 InvocationHandler 介面的 invoke 方法
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
try {
// 獲取 method 所屬類或介面的位元組碼物件
Set<Method> methods = signatureMap.get(method.getDeclaringClass());
// 判斷 methods 中是否包括 method，包含則執行 攔截器的 intercept 方法
if (methods != null && methods.contains(method)) {
return interceptor.intercept(new Invocation(target, method, args));
}
// 呼叫 method 的 invoke 方法，進入下一層呼叫
return method.invoke(target, args);
} catch (Exception e) {
throw ExceptionUtil.unwrapThrowable(e);
}
}
private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
// 獲取 @Intercepts 註解對應的位元組碼物件 interceptsAnnotation
Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
// 如果 interceptsAnnotation 為空，丟擲外掛定義錯誤的異常
if (interceptsAnnotation == null) {
throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
}
// 獲取所有 @Intercepts 中的所有 Signature
Signature[] sigs = interceptsAnnotation.value();
// 定義 type 和 method 的對映 map
Map<Class<?>, Set<Method>> signatureMap = new HashMap<>();
// 遍歷 sigs ，初始化 signatureMap
for (Signature sig : sigs) {
Set<Method> methods = signatureMap.computeIfAbsent(sig.type(), k -> new HashSet<>());
try {
Method method = sig.type().getMethod(sig.method(), sig.args());
methods.add(method);
} catch (NoSuchMethodException e) {
throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
}
}
// 儲存 介面位元組碼物件 和 介面方法位元組碼物件 的對映
return signatureMap;
}
// 判斷目標物件（Executor、StatementHandler、ParameterHandler和ResultSetHandler四個介面中的一種）是否有攔截器攔截
// 方法引數： type：目標物件的位元組碼物件； signatureMap：是我們在 getSignatureMap 方法中得到的
private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
Set<Class<?>> interfaces = new HashSet<>();
while (type != null) {
// 獲取 type 的父介面，並遍歷
for (Class<?> c : type.getInterfaces()) {
// 判斷 signatureMap 中是否包含 type 的父介面
if (signatureMap.containsKey(c)) {
interfaces.add(c);
}
}
// 獲取 type 的父類，繼續 while 迴圈
type = type.getSuperclass();
}
// 返回匹配到的所有介面位元組碼物件
return interfaces.toArray(new Class<?>[interfaces.size()]);
}
}
複製程式碼Plugin 類實現了 JDK 中的 InvocationHandler 介面。包含 5 個方法和 3 個欄位。上面的原始碼分析基本每一句都做了註釋，看懂應該沒有問題，畢竟大家都是老司機了。
其中 5 個方法作用：
（1）getSignatureMap(Interceptor interceptor){.......} 方法：
解析 interceptor 的 @Intercepts 註解中的值。返回介面位元組碼物件和攔截方法的對映集合 map。
比如上面的 ExamplePlugin，@Intercepts 註解中的內容是：
@Intercepts({
@Signature(
type= Executor.class,
method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})
})複製程式碼解析後得到的 Map 包含的值如下圖：
（2）wrap(Object target, Interceptor interceptor) {.....} 方法：
判斷 interceptor 是佛支援 target 攔截，支援則建立 target 的代理物件，否則返回原 target。
（3）getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap){......}方法：
根據給定的 type 位元組碼物件，獲取 signatureMap 中的 key 的值，組成集合返回。
（4）invoke(Object proxy, Method method, Object[] args){......} 方法：
攔截器被 MyBatis 執行的入口就是這個 invoke 方法。具體的執行邏輯在上面的原始碼分析中已經新增了註釋，老鐵往上翻翻即可。不過這個方法中有一行程式碼我需要解釋下，這行程式碼是這樣的：
// 獲取 method 所屬類或介面的位元組碼物件
Set<Method> methods = signatureMap.get(method.getDeclaringClass());複製程式碼這裡的 method 想要從 signatureMap 中拿到值 methods，則 method 必須是攔截器作用的四大介面中的方法，即
- Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)
中的方法。因為 signatureMap 中儲存的 key 就是以上四大介面的位元組碼物件。可以看下圖：
signatureMap 中儲存的 key 和 value 示例：
signatureMap.get(method.getDeclaringClass()) 想要獲得返回值，method.getDeclaringClass() 的返回值必須是 MyBatis 四大介面中的任意一個的位元組碼物件，如下圖：
5. 總結
關於 MyBatis 的外掛的建立就分析到這，對於外掛具體的使用還是那幾句話。外掛會影響 MyBatis 的執行行為，務請慎之又慎。下一篇文章將會分析攔截器在 MyBatis 中作用點，即外掛是在 MyBatis 的什麼地方開始呼叫的。
關於 MyBatis 的外掛化設計，請看 juejin.im/post/5cb614…
有分析不到位的地方，或者有疑惑的地方，歡迎留言分享，我們一起過過招。
還有，歡迎關注我的公眾號，一起提升。
“餘生很長，莫要慌張”
