作者：yhjyumi的專欄

當我們調用ParameterHandler,ResultSetHandler,StatementHandler,Executor的對象的時候,
實際上使用的是Plugin這個代理類的對象,這個類實現了InvocationHandler接口.
接下來我們就知道了,在調用上述被代理類的方法的時候,就會執行Plugin的invoke方法.
Plugin在invoke方法中根據@Intercepts的配置信息(方法名,參數等)動態判斷是否需要攔截該方法.
再然後使用需要攔截的方法Method封裝成Invocation,並調用Interceptor的proceed方法.

這樣我們就達到了攔截目標方法的結果.
例如Executor的執行大概是這樣的流程:
攔截器代理類對象->攔截器->目標方法
Executor->Plugin->Interceptor->Invocation
Executor.Method->Plugin.invoke->Interceptor.intercept->Invocation.proceed->method.invoke


註解
@Intercepts 在實現Interceptor接口的類聲明,使該類註冊成為攔截器
Signature[] value//定義需要攔截哪些類,哪些方法
@Signature 定義哪些類(4種)，方法，參數需要被攔截

Class<?> type()//ParameterHandler,ResultSetHandler,StatementHandler,Executor
String method()//
Class<?>[] args()//

接口
Interceptor 實現攔截器的接口

類
InterceptorChain 攔截器鏈,保存了Mybatis配置的所有攔截器,保存在Configuration
List<Interceptor> interceptors//攔截器

Invocation 類方法的一個封裝,在攔截器中就是被調用的目標方法
Object target//調用的對象

Method method//調用的方法
Object[] args//參數

Plugin 插件,其實就是ParameterHandler,ResultSetHandler,StatementHandler,Executor的代理類(Mybatis使用的JDK代理實現攔截器),實現了InvocationHandler接口
Object target//被代理的目標對象
Interceptor interceptor//攔截器
Map<Class<?>, Set<Method>> signatureMap//接口需要攔截的方法(一對多,每個接口對應多個方法)
//
wrap(Object target, Interceptor interceptor)//把攔截器對象封裝成Plugin代理對象.
invoke(Object proxy, Method method, Object[] args)//


使用例子
1.寫一個類,並且實現Interceptor接口
2.在上述類使用@Intercepts註解,配置攔截信息
3.在配置文件配置插件
@Intercepts({ @Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class,
RowBounds.class, ResultHandler.class }) })
public class MyInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
return invocation.proceed();
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
// TODO Auto-generated method stub

}
}
配置文件加入
<plugins>
<plugin interceptor="weber.mybatis.plugin.MyInterceptor" />
</plugins>

加入測試代碼

1. public static void main(String[] args) throws IOException {
3. String resource = "conf.xml";
5. InputStream is = Test1.class.getClassLoader().getResourceAsStream(resource);
7. SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(is);
9. SqlSession session = sessionFactory.openSession();
11. // User user = session.selectOne("weber.mybatis.mapper.getUser", 1);
12. User userObj = new User();
13. userObj.setId(123);
14. session.selectList("weber.mybatis.mapper.searchByUser", userObj);
16. // UserMapper mapper = session.getMapper(UserMapper.class);
18. // mapper.selectAll();
20. // System.out.println(user);
21. }

開啟debug模式,我們將看到Plugin是如何實現代理的.

當代碼執行到下圖紅色部分的時候

將直接跳到下圖!所以,我們此時的executor不是CachingExecutor對象,而是Plugin代理對象.

此時的method,就是被調用的目標方法如下:

最後附上源碼註釋

1. /**
2. * @author Clinton Begin
3. */
4. //Plugin是JDK動態代理類
5. public class Plugin implements InvocationHandler {
7. private Object target;//目標對象(ParameterHandler,ResultSetHandler,StatementHandler,Executor)
8. private Interceptor interceptor;//被代理的攔截器
9. //目標類需要攔截的方法緩存.因為一個攔截器可以攔截多個類,一個類可以攔截多個方法.
10. //所以用Map + Set的數據結構存儲
11. private Map<Class<?>, Set<Method>> signatureMap;//保存每個攔截器的@signature的配置信息
13. private Plugin(Object target, Interceptor interceptor, Map<Class<?>, Set<Method>> signatureMap) {
14. this.target = target;
15. this.interceptor = interceptor;
16. this.signatureMap = signatureMap;
17. }
18. //把目標對象和攔截器封裝成Plugin代理類實例.
19. public static Object wrap(Object target, Interceptor interceptor) {
20. Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);//獲取攔截器的攔截信息(需要攔截的類和方法)
21. Class<?> type = target.getClass();
22. Class<?>[] interfaces = getAllInterfaces(type, signatureMap);//Proxy代理只能代理接口
23. if (interfaces.length > 0) {
24. return Proxy.newProxyInstance(
25. type.getClassLoader(),
26. interfaces,
27. new Plugin(target, interceptor, signatureMap));//Plugin作為代理類,但是實際業務是由Interceptor攔截器完成的.
28. }
29. return target;
30. }
32. @Override
33. //proxy,類代理的對象,例如CachingExecutor對象
34. public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
35. try {//從這裏代碼看到,會攔截所有的Executor方法,動態的去判斷攔截器要不要去攔截.所以要小心使用攔截器,會影響性能.
36. Set<Method> methods = signatureMap.get(method.getDeclaringClass());
37. if (methods != null && methods.contains(method)) {
38. //Invocation是目標對象,目標對象需要攔截的方法,我攔截方法的參數的封裝.
39. return interceptor.intercept(new Invocation(target, method, args));//調用攔截器實現攔截
40. }
41. return method.invoke(target, args);//不需要攔截的方法直接放行
42. } catch (Exception e) {
43. throw ExceptionUtil.unwrapThrowable(e);
44. }
45. }
47. private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
48. Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);//獲取攔截器註解@Signature
49. // issue #251
50. if (interceptsAnnotation == null) {
51. throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
52. }
53. Signature[] sigs = interceptsAnnotation.value();//一個Signature表示一個攔截類型
54. //保存需要攔截類的信息,class作為key, 需要攔截類的方法作為value集合Set保存.一個攔截器可以攔截一個類中多個方法
55. Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
56. for (Signature sig : sigs) {
57. Set<Method> methods = signatureMap.get(sig.type());
58. if (methods == null) {
59. methods = new HashSet<Method>();
60. signatureMap.put(sig.type(), methods);
61. }
62. try {
63. Method method = sig.type().getMethod(sig.method(), sig.args());//獲取需要攔截的方法
64. methods.add(method);
65. } catch (NoSuchMethodException e) {
66. throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
67. }
68. }
69. return signatureMap;
70. }
72. private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
73. Set<Class<?>> interfaces = new HashSet<Class<?>>();
74. while (type != null) {
75. for (Class<?> c : type.getInterfaces()) {
76. if (signatureMap.containsKey(c)) {
77. interfaces.add(c);
78. }
79. }
80. type = type.getSuperclass();
81. }
82. return interfaces.toArray(new Class<?>[interfaces.size()]);
83. }
85. }

1. /**
2. * @author Clinton Begin
3. */
4. //InterceptorChain裏保存了所有的攔截器，它在mybatis初始化的時候創建。存在Configuration中
5. public class InterceptorChain {
7. private final List<Interceptor> interceptors = new ArrayList<Interceptor>();
9. //每一個攔截器對目標類都進行一次代理(也就是會出現代理的代理的代理.....有點拗口)
10. public Object pluginAll(Object target) {
11. for (Interceptor interceptor : interceptors) {
12. target = interceptor.plugin(target);
13. }
14. return target;
15. }
17. public void addInterceptor(Interceptor interceptor) {
18. interceptors.add(interceptor);
19. }
21. public List<Interceptor> getInterceptors() {
22. return Collections.unmodifiableList(interceptors);
23. }
25. }

1. /**
2. * @author Clinton Begin
3. */
4. public interface Interceptor {
6. Object intercept(Invocation invocation) throws Throwable;//攔截方法,在這裏處理攔截器的業務邏輯
8. Object plugin(Object target);//把目標對象封裝成Plugin對象
10. void setProperties(Properties properties);
12. }

Mybatis那些事-攔截器(Plugin+Interceptor)