JDK动态代理实现原理

来源:互联网 发布:windows wordpress 编辑:程序博客网 时间:2024/06/05 11:21
之前虽然会用JDK的动态代理,但是有些问题却一直没有搞明白。比如说:InvocationHandler的invoke方法是由谁来调用的,代理对象是怎么生成的,直到前几个星期才把这些问题全部搞明白了。
    废话不多说了,先来看一下JDK的动态是怎么用的。

Java代码 复制代码 收藏代码
  1. package dynamic.proxy;  
  2.  
  3. import java.lang.reflect.InvocationHandler; 
  4. import java.lang.reflect.Method; 
  5. import java.lang.reflect.Proxy; 
  6.  
  7. /**
  8. * 实现自己的InvocationHandler
  9. * @author zyb
  10. * @since 2012-8-9
  11. *
  12. */ 
  13. publicclass MyInvocationHandlerimplements InvocationHandler { 
  14.      
  15.     // 目标对象  
  16.     private Object target; 
  17.      
  18.     /**
  19.      * 构造方法
  20.      * @param target 目标对象
  21.      */ 
  22.     public MyInvocationHandler(Object target) { 
  23.         super(); 
  24.         this.target = target; 
  25.     } 
  26.  
  27.  
  28.     /**
  29.      * 执行目标对象的方法
  30.      */ 
  31.     public Object invoke(Object proxy, Method method, Object[] args)throws Throwable { 
  32.          
  33.         // 在目标对象的方法执行之前简单的打印一下 
  34.         System.out.println("------------------before------------------"); 
  35.          
  36.         // 执行目标对象的方法 
  37.         Object result = method.invoke(target, args); 
  38.          
  39.         // 在目标对象的方法执行之后简单的打印一下 
  40.         System.out.println("-------------------after------------------"); 
  41.          
  42.         return result; 
  43.     } 
  44.  
  45.     /**
  46.      * 获取目标对象的代理对象
  47.      * @return 代理对象
  48.      */ 
  49.     public Object getProxy() { 
  50.         return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),  
  51.                 target.getClass().getInterfaces(), this); 
  52.     } 
  53.  
  54. package dynamic.proxy; 
  55.  
  56. /**
  57. * 目标对象实现的接口,用JDK来生成代理对象一定要实现一个接口
  58. * @author zyb
  59. * @since 2012-8-9
  60. *
  61. */ 
  62. publicinterface UserService { 
  63.  
  64.     /**
  65.      * 目标方法
  66.      */ 
  67.     publicabstractvoid add(); 
  68.  
  69.  
  70. package dynamic.proxy;  
  71.  
  72. /**
  73. * 目标对象
  74. * @author zyb
  75. * @since 2012-8-9
  76. *
  77. */ 
  78. publicclass UserServiceImplimplements UserService { 
  79.  
  80.     /* (non-Javadoc)
  81.      * @see dynamic.proxy.UserService#add()
  82.      */ 
  83.     publicvoid add() { 
  84.         System.out.println("--------------------add---------------"); 
  85.     } 
  86.  
  87. package dynamic.proxy;  
  88.  
  89. import org.junit.Test; 
  90.  
  91. /**
  92. * 动态代理测试类
  93. * @author zyb
  94. * @since 2012-8-9
  95. *
  96. */ 
  97. publicclass ProxyTest { 
  98.  
  99.     @Test 
  100.     publicvoid testProxy()throws Throwable { 
  101.         // 实例化目标对象 
  102.         UserService userService = new UserServiceImpl(); 
  103.          
  104.         // 实例化InvocationHandler 
  105.         MyInvocationHandler invocationHandler = new MyInvocationHandler(userService); 
  106.          
  107.         // 根据目标对象生成代理对象 
  108.         UserService proxy = (UserService) invocationHandler.getProxy(); 
  109.          
  110.         // 调用代理对象的方法 
  111.         proxy.add(); 
  112.          
  113.     } 


执行结果如下:
------------------before------------------
--------------------add---------------
-------------------after------------------


   用起来是很简单吧,其实这里基本上就是AOP的一个简单实现了,在目标对象的方法执行之前和执行之后进行了增强。Spring的AOP实现其实也是用了Proxy和InvocationHandler这两个东西的。

    用起来是比较简单,但是如果能知道它背后做了些什么手脚,那就更好不过了。首先来看一下JDK是怎样生成代理对象的。既然生成代理对象是用的Proxy类的静态方newProxyInstance,那么我们就去它的源码里看一下它到底都做了些什么?
Java代码 复制代码 收藏代码
  1. /**
  2. * loader:类加载器
  3. * interfaces:目标对象实现的接口
  4. * h:InvocationHandler的实现类
  5. */ 
  6. publicstatic Object newProxyInstance(ClassLoader loader, 
  7.                       Class<?>[] interfaces, 
  8.                       InvocationHandler h) 
  9.     throws IllegalArgumentException 
  10.     { 
  11.     if (h ==null) { 
  12.         thrownew NullPointerException(); 
  13.     } 
  14.  
  15.     /*
  16.      * Look up or generate the designated proxy class.
  17.      */ 
  18.     Class cl = getProxyClass(loader, interfaces); 
  19.  
  20.     /*
  21.      * Invoke its constructor with the designated invocation handler.
  22.      */ 
  23.     try
  24.             // 调用代理对象的构造方法(也就是$Proxy0(InvocationHandler h)) 
  25.         Constructor cons = cl.getConstructor(constructorParams); 
  26.             // 生成代理类的实例并把MyInvocationHandler的实例传给它的构造方法 
  27.         return (Object) cons.newInstance(new Object[] { h }); 
  28.     } catch (NoSuchMethodException e) { 
  29.         thrownew InternalError(e.toString()); 
  30.     } catch (IllegalAccessException e) { 
  31.         thrownew InternalError(e.toString()); 
  32.     } catch (InstantiationException e) { 
  33.         thrownew InternalError(e.toString()); 
  34.     } catch (InvocationTargetException e) { 
  35.         thrownew InternalError(e.toString()); 
  36.     } 
  37.     } 


   我们再进去getProxyClass方法看一下
Java代码 复制代码 收藏代码
  1. publicstatic Class<?> getProxyClass(ClassLoader loader,  
  2.                                          Class<?>... interfaces) 
  3.     throws IllegalArgumentException 
  4.     { 
  5.     // 如果目标类实现的接口数大于65535个则抛出异常(我XX,谁会写这么NB的代码啊?) 
  6.     if (interfaces.length >65535) { 
  7.         thrownew IllegalArgumentException("interface limit exceeded"); 
  8.     } 
  9.  
  10.     // 声明代理对象所代表的Class对象(有点拗口) 
  11.     Class proxyClass = null
  12.  
  13.     String[] interfaceNames = new String[interfaces.length]; 
  14.  
  15.     Set interfaceSet = new HashSet();  // for detecting duplicates 
  16.  
  17.     // 遍历目标类所实现的接口 
  18.     for (int i =0; i < interfaces.length; i++) { 
  19.          
  20.         // 拿到目标类实现的接口的名称 
  21.         String interfaceName = interfaces[i].getName(); 
  22.         Class interfaceClass = null
  23.         try
  24.         // 加载目标类实现的接口到内存中 
  25.         interfaceClass = Class.forName(interfaceName, false, loader); 
  26.         } catch (ClassNotFoundException e) { 
  27.         } 
  28.         if (interfaceClass != interfaces[i]) { 
  29.         thrownew IllegalArgumentException( 
  30.             interfaces[i] + " is not visible from class loader"); 
  31.         } 
  32.  
  33.         // 中间省略了一些无关紧要的代码 ....... 
  34.          
  35.         // 把目标类实现的接口代表的Class对象放到Set中 
  36.         interfaceSet.add(interfaceClass); 
  37.  
  38.         interfaceNames[i] = interfaceName; 
  39.     } 
  40.  
  41.     // 把目标类实现的接口名称作为缓存(Map)中的key 
  42.     Object key = Arrays.asList(interfaceNames); 
  43.  
  44.     Map cache; 
  45.      
  46.     synchronized (loaderToCache) { 
  47.         // 从缓存中获取cache 
  48.         cache = (Map) loaderToCache.get(loader); 
  49.         if (cache ==null) { 
  50.         // 如果获取不到,则新建地个HashMap实例 
  51.         cache = new HashMap(); 
  52.         // 把HashMap实例和当前加载器放到缓存中 
  53.         loaderToCache.put(loader, cache); 
  54.         } 
  55.  
  56.     } 
  57.  
  58.     synchronized (cache) { 
  59.  
  60.         do
  61.         // 根据接口的名称从缓存中获取对象 
  62.         Object value = cache.get(key); 
  63.         if (valueinstanceof Reference) { 
  64.             proxyClass = (Class) ((Reference) value).get(); 
  65.         } 
  66.         if (proxyClass !=null) { 
  67.             // 如果代理对象的Class实例已经存在,则直接返回 
  68.             return proxyClass; 
  69.         } elseif (value == pendingGenerationMarker) { 
  70.             try
  71.             cache.wait(); 
  72.             } catch (InterruptedException e) { 
  73.             } 
  74.             continue
  75.         } else
  76.             cache.put(key, pendingGenerationMarker); 
  77.             break
  78.         } 
  79.         } while (true); 
  80.     } 
  81.  
  82.     try
  83.         // 中间省略了一些代码 ....... 
  84.          
  85.         // 这里就是动态生成代理对象的最关键的地方 
  86.         byte[] proxyClassFile = ProxyGenerator.generateProxyClass( 
  87.             proxyName, interfaces); 
  88.         try
  89.             // 根据代理类的字节码生成代理类的实例 
  90.             proxyClass = defineClass0(loader, proxyName, 
  91.             proxyClassFile, 0, proxyClassFile.length); 
  92.         } catch (ClassFormatError e) { 
  93.             thrownew IllegalArgumentException(e.toString()); 
  94.         } 
  95.         } 
  96.         // add to set of all generated proxy classes, for isProxyClass 
  97.         proxyClasses.put(proxyClass, null); 
  98.  
  99.     }  
  100.     // 中间省略了一些代码 ....... 
  101.      
  102.     return proxyClass; 
  103.     } 


进去ProxyGenerator类的静态方法generateProxyClass,这里是真正生成代理类class字节码的地方。
Java代码 复制代码 收藏代码
  1. publicstaticbyte[] generateProxyClass(final String name, 
  2.                                            Class[] interfaces) 
  3.    { 
  4.        ProxyGenerator gen = new ProxyGenerator(name, interfaces); 
  5.     // 这里动态生成代理类的字节码,由于比较复杂就不进去看了 
  6.        finalbyte[] classFile = gen.generateClassFile(); 
  7.  
  8.     // 如果saveGeneratedFiles的值为true,则会把所生成的代理类的字节码保存到硬盘上 
  9.        if (saveGeneratedFiles) { 
  10.            java.security.AccessController.doPrivileged( 
  11.            new java.security.PrivilegedAction<Void>() { 
  12.                public Void run() { 
  13.                    try
  14.                        FileOutputStream file = 
  15.                            new FileOutputStream(dotToSlash(name) +".class"); 
  16.                        file.write(classFile); 
  17.                        file.close(); 
  18.                        returnnull
  19.                    } catch (IOException e) { 
  20.                        thrownew InternalError( 
  21.                            "I/O exception saving generated file: " + e); 
  22.                    } 
  23.                } 
  24.            }); 
  25.        } 
  26.  
  27.     // 返回代理类的字节码 
  28.        return classFile; 
  29.    } 


现在,JDK是怎样动态生成代理类的字节的原理已经一目了然了。

好了,再来解决另外一个问题,那就是由谁来调用InvocationHandler的invoke方法的。要解决这个问题就要看一下JDK到底为我们生成了一个什么东西。用以下代码可以获取到JDK为我们生成的字节码并写到硬盘中。
Java代码 复制代码 收藏代码
  1. package dynamic.proxy;  
  2.  
  3. import java.io.FileOutputStream; 
  4. import java.io.IOException; 
  5.  
  6. import sun.misc.ProxyGenerator; 
  7.  
  8. /**
  9. * 代理类的生成工具
  10. * @author zyb
  11. * @since 2012-8-9
  12. */ 
  13. publicclass ProxyGeneratorUtils { 
  14.  
  15.     /**
  16.      * 把代理类的字节码写到硬盘上
  17.      * @param path 保存路径
  18.      */ 
  19.     publicstaticvoid writeProxyClassToHardDisk(String path) { 
  20.         // 第一种方法,这种方式在刚才分析ProxyGenerator时已经知道了 
  21.         // System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", true); 
  22.          
  23.         // 第二种方法 
  24.          
  25.         // 获取代理类的字节码 
  26.         byte[] classFile = ProxyGenerator.generateProxyClass("$Proxy11", UserServiceImpl.class.getInterfaces()); 
  27.          
  28.         FileOutputStream out = null
  29.          
  30.         try
  31.             out = new FileOutputStream(path); 
  32.             out.write(classFile); 
  33.             out.flush(); 
  34.         } catch (Exception e) { 
  35.             e.printStackTrace(); 
  36.         } finally
  37.             try
  38.                 out.close(); 
  39.             } catch (IOException e) { 
  40.                 e.printStackTrace(); 
  41.             } 
  42.         } 
  43.     } 
  44.  
  45. package dynamic.proxy;  
  46.  
  47. import org.junit.Test; 
  48.  
  49. /**
  50. * 动态代理测试类
  51. * @author zyb
  52. * @since 2012-8-9
  53. *
  54. */ 
  55. publicclass ProxyTest { 
  56.  
  57.     @Test 
  58.     publicvoid testProxy()throws Throwable { 
  59.         // 实例化目标对象 
  60.         UserService userService = new UserServiceImpl(); 
  61.          
  62.         // 实例化InvocationHandler 
  63.         MyInvocationHandler invocationHandler = new MyInvocationHandler(userService); 
  64.          
  65.         // 根据目标对象生成代理对象 
  66.         UserService proxy = (UserService) invocationHandler.getProxy(); 
  67.          
  68.         // 调用代理对象的方法 
  69.         proxy.add(); 
  70.          
  71.     } 
  72.      
  73.     @Test 
  74.     publicvoid testGenerateProxyClass() { 
  75.         ProxyGeneratorUtils.writeProxyClassToHardDisk("F:/$Proxy11.class"); 
  76.     } 


通过以上代码,就可以在F盘上生成一个$Proxy.class文件了,现在用反编译工具来看一下这个class文件里面的内容。
Java代码 复制代码 收藏代码
  1. // Decompiled by DJ v3.11.11.95 Copyright 2009 Atanas Neshkov  Date: 2012/8/9 20:11:32 
  2. // Home Page: http://members.fortunecity.com/neshkov/dj.html  http://www.neshkov.com/dj.html - Check often for new version! 
  3. // Decompiler options: packimports(3) 
  4.  
  5. import dynamic.proxy.UserService; 
  6. import java.lang.reflect.*; 
  7.  
  8. publicfinalclass $Proxy11extends Proxy 
  9.     implements UserService 
  10.  
  11.     // 构造方法,参数就是刚才传过来的MyInvocationHandler类的实例 
  12.     public $Proxy11(InvocationHandler invocationhandler) 
  13.     { 
  14.         super(invocationhandler); 
  15.     } 
  16.  
  17.     publicfinalboolean equals(Object obj) 
  18.     { 
  19.         try 
  20.         { 
  21.             return ((Boolean)super.h.invoke(this, m1, new Object[] { 
  22.                 obj 
  23.             })).booleanValue(); 
  24.         } 
  25.         catch(Error _ex) { } 
  26.         catch(Throwable throwable) 
  27.         { 
  28.             thrownew UndeclaredThrowableException(throwable); 
  29.         } 
  30.     } 
  31.  
  32.     /**
  33.      * 这个方法是关键部分
  34.      */ 
  35.     publicfinalvoid add() 
  36.     { 
  37.         try 
  38.         { 
  39.             // 实际上就是调用MyInvocationHandler的public Object invoke(Object proxy, Method method, Object[] args)方法,第二个问题就解决了 
  40.             super.h.invoke(this, m3,null); 
  41.             return
  42.         } 
  43.         catch(Error _ex) { } 
  44.         catch(Throwable throwable) 
  45.         { 
  46.             thrownew UndeclaredThrowableException(throwable); 
  47.         } 
  48.     } 
  49.  
  50.     publicfinalint hashCode() 
  51.     { 
  52.         try 
  53.         { 
  54.             return ((Integer)super.h.invoke(this, m0, null)).intValue(); 
  55.         } 
  56.         catch(Error _ex) { } 
  57.         catch(Throwable throwable) 
  58.         { 
  59.             thrownew UndeclaredThrowableException(throwable); 
  60.         } 
  61.     } 
  62.  
  63.     publicfinal String toString() 
  64.     { 
  65.         try 
  66.         { 
  67.             return (String)super.h.invoke(this, m2, null); 
  68.         } 
  69.         catch(Error _ex) { } 
  70.         catch(Throwable throwable) 
  71.         { 
  72.             thrownew UndeclaredThrowableException(throwable); 
  73.         } 
  74.     } 
  75.  
  76.     privatestatic Method m1; 
  77.     privatestatic Method m3; 
  78.     privatestatic Method m0; 
  79.     privatestatic Method m2; 
  80.  
  81.     // 在静态代码块中获取了4个方法:Object中的equals方法、UserService中的add方法、Object中的hashCode方法、Object中toString方法 
  82.     static  
  83.     { 
  84.         try 
  85.         { 
  86.             m1 = Class.forName("java.lang.Object").getMethod("equals",new Class[] { 
  87.                 Class.forName("java.lang.Object"
  88.             }); 
  89.             m3 = Class.forName("dynamic.proxy.UserService").getMethod("add",new Class[0]); 
  90.             m0 = Class.forName("java.lang.Object").getMethod("hashCode",new Class[0]); 
  91.             m2 = Class.forName("java.lang.Object").getMethod("toString",new Class[0]); 
  92.         } 
  93.         catch(NoSuchMethodException nosuchmethodexception) 
  94.         { 
  95.             thrownew NoSuchMethodError(nosuchmethodexception.getMessage()); 
  96.         } 
  97.         catch(ClassNotFoundException classnotfoundexception) 
  98.         { 
  99.             thrownew NoClassDefFoundError(classnotfoundexception.getMessage()); 
  100.         } 
  101.     } 


好了,到目前为止,前面 的两个问题都已经知道回事了,现在再用JDK动态代理的时候就不只会用而已了,真正的达到了“知其然,知其所以然”的目的。。。
0 0
原创粉丝点击