mybatis的擴展實現源碼解讀

最近項目中需要用到mybatis的擴展，就深入看了下mybatis的實現，對其靈活性和擴展性的設計思想還是非常佩服的

首先說一下mybatis的攔截器使用方法：繼承其Intercepter介面，實現org.apache.ibatis.plugin.Interceptor#intercept方法，在其中或者對其要執行的方法進行攔截，或者對返回值進行解析

同時基於org.apache.ibatis.plugin.Intercepts和org.apache.ibatis.plugin.Signature這兩個註解來決定，對哪些執行器的哪些方法進行攔截

先看下攔截器的核心介面

1

2

3

4

5

6

7

8

9

public interface Interceptor {

Object intercept(Invocation invocation) throws Throwable;

Object plugin(Object target);

void setProperties(Properties properties);

}

其中intercept方法是核心方法，攔截器的實現，plugin方法是用於配置哪些對哪些執行器進行攔截

繼續看源碼，可以看到mybatis的攔截是使用了jdk的動態代理實現的，本質上是一種代理機制

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

public class Plugin implements InvocationHandler {

private final Object target;

private final Interceptor interceptor;

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;

}

public static Object wrap(Object target, Interceptor interceptor) {

Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);

Class<?> type = target.getClass();

Class<?>[] interfaces = getAllInterfaces(type, signatureMap);

if (interfaces.length > 0) {

return Proxy.newProxyInstance(

type.getClassLoader(),

interfaces,

new Plugin(target, interceptor, signatureMap));

}

return target;

}

@Override

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

try {

Set<Method> methods = signatureMap.get(method.getDeclaringClass());

if (methods != null && methods.contains(method)) {

return interceptor.intercept(new Invocation(target, method, args));

}

return method.invoke(target, args);

} catch (Exception e) {

throw ExceptionUtil.unwrapThrowable(e);

}

}

......

}

mybatis的這個Plugin就是代理類，這個代理類是在org.apache.ibatis.plugin.Interceptor#plugin方法中初始化的（調用org.apache.ibatis.plugin.Plugin#wrap），一個Plugin包含一個Intercepter，以及該Intercepter相關的註解配置信息，當對攔截對象的對應方法進行執行的時候，都會根據這些註解配置來判斷是否需要執行該代理攔截（org.apache.ibatis.plugin.Plugin#invoke）

再看下plugin是如何被載入的：

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

public class InterceptorChain {

private final List<Interceptor> interceptors = new ArrayList<Interceptor>();

public Object pluginAll(Object target) {

for (Interceptor interceptor : interceptors) {

target = interceptor.plugin(target);

}

return target;

}

public void addInterceptor(Interceptor interceptor) {

interceptors.add(interceptor);

}

public List<Interceptor> getInterceptors() {

return Collections.unmodifiableList(interceptors);

}

}

org.apache.ibatis.plugin.Interceptor#plugin是在org.apache.ibatis.plugin.InterceptorChain#pluginAll方法中調用的，我們可以看到，如果一個應用中註冊了多個攔截器，那麼實際上是會進行一個for循環的載入，由於上面說到了，載入一次，本質上是對mybatis的執行期進行一次代理包裝，那麼載入多次的話，就會代理包裝多次，實際上就是一種多重代理了，這樣就保證了每次調用都會按照代理順序進行調用和返回的處理

可以看到，在做這些mybatis執行器初始化的時候，都會進行攔截器鏈的載入

至此，mybatis基於jdk動態代理的擴展實現方法就了解清楚了，其靈活性在於，它抽象了執行器的概念，並且攔截器的攔截方法也是固定的，我們可以對不同執行器的不同方法進行攔截，而對這些擴展點進行擴展卻不用寫多個方法實現多個方法，只需要實現一個介面就可以搞定了！

作者：此生重演

原文：https://www.cnblogs.com/cishengchongyan/p/10208040.html

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！