從mybatis源碼看JDK動態代理

時間 2020-04-07

原文原文鏈接

網上好多說到動態代理的文章內容都是這樣子的：程序員

一個實際幹事的類Real；一個被創造的代理類Proxy。sql

Proxy調用Real中被代理的方法；有模有樣的在被代理的方法先後打印出一些字符串。編程

好比下面的例子：mybatis

 1 public class JdkProxy {
 2     static interface IProxy{
 3         String say(String s);
 4     }
 5     static class Real implements IProxy{
 6         @Override
 7         public String say(String s) {
 8             System.out.println("說完了，返回結果");
 9             return s;
10         }
11     }   
12 
13     static class MyInvocationHandler implements  InvocationHandler{
14         private Object real;
15 
16         public MyInvocationHandler(Object real) {
17             this.real = real;
18         }
19 
20         @Override
21         public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
22             Object res=null;
23             if(method.getName().equals("say")){
24                 System.out.println("say start...");
25                 res=method.invoke(real,args);
26                 System.out.println("say end...");
27             }
28             return res;
29         }
30     }    
31 
32     public static void main(String[] args) {
33         execu1();      
34     }
35 
36     private static void execu1(){
37         System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");
38         Real real=new Real();
39         IProxy proxy=(IProxy) Proxy.newProxyInstance(real.getClass().getClassLoader(), real.getClass().getInterfaces(),new MyInvocationHandler(real));
40         String s=proxy.say("abc");
41         System.out.println(s);
42     }   
43 
44 }

上面21-27行代碼是調用被代理的方法；app

若是我如今不調用被代理的方法，而是直接寫一個方法體。ide

代碼以下：ui

 1 public class JdkProxy {
 2     static interface IProxy{
 3         String say(String s);
 4     }
 5     static class Real implements IProxy{
 6         @Override
 7         public String say(String s) {
 8             System.out.println("說完了，返回結果");
 9             return s;
10         }
11     }   
12 
13     static class MyInvocationHandler implements  InvocationHandler{
14         private Object real;
15 
16         public MyInvocationHandler(Object real) {
17             this.real = real;
18         }
19 
20         @Override
21         public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
22            return "我什麼也不代理，我直接就是一個方法"; 23         }
24     }    
25 
26     public static void main(String[] args) {
27         execu1();      
28     }
29 
30     private static void execu1(){
31         System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");
32         Real real=new Real();
33         IProxy proxy=(IProxy) Proxy.newProxyInstance(IProxy.class.getClassLoader(),new Class[]{IProxy.class},new MyInvocationHandler(real));
34         String s=proxy.say("abc");
35         System.out.println(s);
36     }   
37 
38 }

改動代碼是22行的代碼。this

若是不須要被代理的方法了，那麼還須要實際幹活的類嗎？spa

繼續修改代碼：代理

 1 public class JdkProxy {
 2     static interface IProxy{
 3         String say(String s);
 4     }   
 5 
 6     static class MyInvocationHandler implements  InvocationHandler{
 7         
 8 
 9         @Override
10         public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
11            return "我什麼也不代理，我直接就是一個方法";
12         }
13     }    
14 
15     public static void main(String[] args) {
16         execu1();      
17     }
18 
19     private static void execu1(){
20         System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");      
21         IProxy proxy=(IProxy) Proxy.newProxyInstance(IProxy.class.getClassLoader(),new Class[]{IProxy.class},new MyInvocationHandler());
22         String s=proxy.say("abc");
23         System.out.println(s);
24     } 
25 }

上面的程序依然可以正常運行。

從這個層面來講，動態代理就是給咱們創造了一個類，至於有沒有實際幹活的類無關。

網上處處都在說mybatis接口編程的用的是動態代理，創造代理類咱們很好理解，那麼他到底代理了什麼類呢？

先來個簡單的mybatis例子：

1 SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("mybatis-config.xml"));
2 SqlSession sqlSession= sqlSessionFactory.openSession();
3 IRoleMapper iRoleMapper=sqlSession.getMapper(IRoleMapper.class);
4 List<Role> list=iRoleMapper.getRole(1L);

第三行代碼就應該是獲取代理的過程；iRoleMapper指向具體的代理類。

下面查看源碼：

getMapper（）源碼：

 1  public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
 2     final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
 3     if (mapperProxyFactory == null) {
 4       throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
 5     }
 6     try {
 7       return mapperProxyFactory.newInstance(sqlSession);
 8     } catch (Exception e) {
 9       throw new BindingException("Error getting mapper instance. Cause: " + e, e);
10     }
11   }

代碼比較簡潔，代理類是在第7行生成的。進入newInstance()方法：

newInstance()源碼：

1 protected T newInstance(MapperProxy<T> mapperProxy) {
2     return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
3   }
4 
5   public T newInstance(SqlSession sqlSession) {
6     final MapperProxy<T> mapperProxy = new MapperProxy<>(sqlSession, mapperInterface, methodCache);
7     return newInstance(mapperProxy);
8   }

第1行的newInstance調用的是JDK的代理方法

第5行的newInstance是Mybatis本身的方法，根據JDK動態代理的調用規則，第6行的MapperProxy必定繼承了InvocationHandler接口，而且實現了接口方法invoke（）；

invoke（）源碼

 1  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
 2     try {
 3       if (Object.class.equals(method.getDeclaringClass())) {
 4         return method.invoke(this, args);
 5       } else if (method.isDefault()) {
 6         if (privateLookupInMethod == null) {
 7           return invokeDefaultMethodJava8(proxy, method, args);
 8         } else {
 9           return invokeDefaultMethodJava9(proxy, method, args);
10         }
11       }
12     } catch (Throwable t) {
13       throw ExceptionUtil.unwrapThrowable(t);
14     }
15     final MapperMethod mapperMethod = cachedMapperMethod(method);
16     return mapperMethod.execute(sqlSession, args);
17   }