Java动态代理与CGLIB

原文出处： Hosee

1. 静态代理模式

因为需要对一些函数进行二次处理，或是某些函数不让外界知道时，可以使用代理模式，通过访问第三方，间接访问原函数的方式，达到以上目的，来看一下代理模式的类图：

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 41 42 43

interface Hosee{      String sayhi(); }   class Hoseeimpl implements Hosee{        @Override      public String sayhi()      {          return "Welcome oschina hosee's blog" ;      }   }   class HoseeProxy implements Hosee{        Hosee h;        public HoseeProxy(Hosee h)      {          this .h = h;      }        @Override      public String sayhi()      {          System.out.println( "I'm proxy!" );          return h.sayhi();      }   }   public class StaticProxy {        public static void main(String[] args)      {          Hoseeimpl h = new Hoseeimpl();          HoseeProxy hp = new HoseeProxy(h);          System.out.println(hp.sayhi());      }   }

1.1 静态代理的弊端

如果要想为多个类进行代理，则需要建立多个代理类，维护难度加大。

仔细想想，为什么静态代理会有这些问题，是因为代理在编译期就已经决定，如果代理哪个发生在运行期，这些问题解决起来就比较简单，所以动态代理的存在就很有必要了。

2. 动态代理

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 41 42 43 44 45 46 47

import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.lang.reflect.Proxy;   interface HoseeDynamic {      String sayhi(); }   class HoseeDynamicimpl implements HoseeDynamic {      @Override      public String sayhi()      {          return "Welcome oschina hosee's blog" ;      } }   class MyProxy implements InvocationHandler {      Object obj;      public Object bind(Object obj)      {          this .obj = obj;          return Proxy.newProxyInstance(obj.getClass().getClassLoader(), obj                  .getClass().getInterfaces(), this );      }      @Override      public Object invoke(Object proxy, Method method, Object[] args)              throws Throwable      {          System.out.println( "I'm proxy!" );          Object res = method.invoke(obj, args);          return res;      } }   public class DynamicProxy {      public static void main(String[] args)      {          MyProxy myproxy = new MyProxy();          HoseeDynamicimpl dynamicimpl = new HoseeDynamicimpl();          HoseeDynamic proxy = (HoseeDynamic)myproxy.bind(dynamicimpl);          System.out.println(proxy.sayhi());      } }

类比静态代理，可以发现，代理类不需要实现原接口了，而是实现InvocationHandler。通过

1 2	Proxy.newProxyInstance(obj.getClass().getClassLoader(), obj                  .getClass().getInterfaces(), this );

来动态生成一个代理类，该类的类加载器与被代理类相同，实现的接口与被代理类相同。

通过上述方法生成的代理类相当于静态代理中的代理类。

这样就实现了在运行期才决定代理对象是怎么样的，解决了静态代理的弊端。

当动态生成的代理类调用方法时，会触发invoke方法，在invoke方法中可以对被代理类的方法进行增强。

通过动态代理可以很明显的看到它的好处，在使用静态代理时，如果不同接口的某些类想使用代理模式来实现相同的功能，将要实现多个代理类，但在动态代理中，只需要一个代理类就好了。

除了省去了编写代理类的工作量，动态代理实现了可以在原始类和接口还未知的时候，就确定代理类的代理行为，当代理类与原始类脱离直接联系后，就可以很灵活地重用于不同的应用场景中。

2.1 动态代理的弊端

代理类和委托类需要都实现同一个接口。也就是说只有实现了某个接口的类可以使用Java动态代理机制。但是，事实上使用中并不是遇到的所有类都会给你实现一个接口。因此，对于没有实现接口的类，就不能使用该机制。

而CGLIB则可以实现对类的动态代理

2.2 回调函数原理

上文说了，当动态生成的代理类调用方法时，会触发invoke方法。

很显然invoke方法并不是显示调用的，它是一个回调函数，那么回调函数是怎么被调用的呢？

上述动态代理的代码中，唯一不清晰的地方只有

1 2	Proxy.newProxyInstance(obj.getClass().getClassLoader(), obj                  .getClass().getInterfaces(), this );

跟踪这个方法的源码，可以看到程序进行了验证、优化、缓存、同步、生成字节码、显示类加载等操作，前面的步骤并不是我们关注的重点，而最后它调用了

1 2	byte [] proxyClassFile = ProxyGenerator.generateProxyClass(                  proxyName, interfaces);

该方法用来完成生成字节码的动作，这个方法可以在运行时产生一个描述代理类的字节码byte[]数组。

在main函数中加入

1	System.getProperties().put( "sun.misc.ProxyGenerator.saveGeneratedFiles" , "true" );

加入这句代码后再次运行程序，磁盘中将会产生一个名为”$Proxy().class”的代理类Class文件，反编译（反编译工具我使用的是 JD-GUI ）后可以看见如下代码：

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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.lang.reflect.Proxy; import java.lang.reflect.UndeclaredThrowableException;   public final class $Proxy0 </code><code class="java keyword">extends</code> <code class="java plain">Proxy</code></div><div class="line number7 index6 alt2"><code class="java spaces">&nbsp;&nbsp;</code><code class="java keyword">implements</code> <code class="java plain">HoseeDynamic</code></div><div class="line number8 index7 alt1"><code class="java plain">{</code></div><div class="line number9 index8 alt2"><code class="java spaces">&nbsp;&nbsp;</code><code class="java keyword">private</code> <code class="java keyword">static</code> <code class="java plain">Method m1;</code></div><div class="line number10 index9 alt1"><code class="java spaces">&nbsp;&nbsp;</code><code class="java keyword">private</code> <code class="java keyword">static</code> <code class="java plain">Method m3;</code></div><div class="line number11 index10 alt2"><code class="java spaces">&nbsp;&nbsp;</code><code class="java keyword">private</code> <code class="java keyword">static</code> <code class="java plain">Method m0;</code></div><div class="line number12 index11 alt1"><code class="java spaces">&nbsp;&nbsp;</code><code class="java keyword">private</code> <code class="java keyword">static</code> <code class="java plain">Method m2;</code></div><div class="line number13 index12 alt2">&nbsp;</div><div class="line number14 index13 alt1"><code class="java spaces">&nbsp;&nbsp;</code><code class="java keyword">public</code> <code class="java plain">$Proxy0(InvocationHandler paramInvocationHandler)      throws    {      super (paramInvocationHandler);    }      public final boolean equals(Object paramObject)      throws    {      try      {        return ((Boolean) this .h.invoke( this , m1, new Object[] { paramObject })).booleanValue();      }      catch (Error|RuntimeException localError)      {        throw localError;      }      catch (Throwable localThrowable)      {        throw new UndeclaredThrowableException(localThrowable);      }    }      public final String sayhi()      throws    {      try      {        return (String) this .h.invoke( this , m3, null );      }      catch (Error|RuntimeException localError)      {        throw localError;      }      catch (Throwable localThrowable)      {        throw new UndeclaredThrowableException(localThrowable);      }    }      public final int hashCode()      throws    {      try      {        return ((Integer) this .h.invoke( this , m0, null )).intValue();      }      catch (Error|RuntimeException localError)      {        throw localError;      }      catch (Throwable localThrowable)      {        throw new UndeclaredThrowableException(localThrowable);      }    }      public final String toString()      throws    {      try      {        return (String) this .h.invoke( this , m2, null );      }      catch (Error|RuntimeException localError)      {        throw localError;      }      catch (Throwable localThrowable)      {        throw new UndeclaredThrowableException(localThrowable);      }    }      static    {      try      {        m1 = Class.forName( "java.lang.Object" ).getMethod( "equals" , new Class[] { Class.forName( "java.lang.Object" ) });        m3 = Class.forName( "HoseeDynamic" ).getMethod( "sayhi" , new Class[ 0 ]);        m0 = Class.forName( "java.lang.Object" ).getMethod( "hashCode" , new Class[ 0 ]);        m2 = Class.forName( "java.lang.Object" ).getMethod( "toString" , new Class[ 0 ]);        return ;      }      catch (NoSuchMethodException localNoSuchMethodException)      {        throw new NoSuchMethodError(localNoSuchMethodException.getMessage());      }      catch (ClassNotFoundException localClassNotFoundException)      {        throw new NoClassDefFoundError(localClassNotFoundException.getMessage());      }    } }

动态代理类不仅代理了显示定义的接口中的方法，而且还代理了java的根类Object中的继承而来的equals()、hashcode()、toString()这三个方法，并且仅此三个方法。

可以在上述代码中看到，无论调用哪个方法，都会调用到InvocationHandler的invoke方法，只是参数不同。

2.3 动态代理与静态代理的区别

1. Proxy类的代码被固定下来，不会因为业务的逐渐庞大而庞大；
2. 可以实现AOP编程，这是静态代理无法实现的；
3. 解耦，如果用在web业务下，可以实现数据层和业务层的分离。
4. 动态代理的优势就是实现无侵入式的代码扩展。 静态代理这个模式本身有个大问题，如果类方法数量越来越多的时候，代理类的代码量是十分庞大的。所以引入动态代理来解决此类问题

3. CGLIB

cglib是针对类来实现代理的，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但因为采用的是继承，所以不能对final修饰的类进行代理。

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 41 42 43 44 45 46 47 48 49

import java.lang.reflect.Method;   import net.sf.cglib.proxy.Enhancer; import net.sf.cglib.proxy.MethodInterceptor; import net.sf.cglib.proxy.MethodProxy;   class CGlibHosee {      public String sayhi()      {          return "Welcome oschina hosee's blog" ;      } }   class CGlibHoseeProxy {      Object obj;        public Object bind( final Object target)      {          this .obj = target;          Enhancer enhancer = new Enhancer();          enhancer.setSuperclass(obj.getClass());          enhancer.setCallback( new MethodInterceptor()          {              @Override              public Object intercept(Object obj, Method method, Object[] args,                      MethodProxy proxy) throws Throwable              {                  System.out.println( "I'm proxy!" );                  Object res = method.invoke(target, args);                  return res;              }          });          return enhancer.create();      }   }   public class CGlibProxy {      public static void main(String[] args)      {          CGlibHosee cGlibHosee = new CGlibHosee();          CGlibHoseeProxy cGlibHoseeProxy = new CGlibHoseeProxy();          CGlibHosee proxy = (CGlibHosee) cGlibHoseeProxy.bind(cGlibHosee);          System.out.println(proxy.sayhi());      } }

cglib需要指定父类和回调方法。当然cglib也可以与Java动态代理一样面向接口，因为本质是继承。

Reference：

1. http://blog.csdn.net/lidatgb/article/details/8941711

2. http://shensy.iteye.com/blog/1698197

3. http://www.cnblogs.com/jqyp/archive/2010/08/20/1805041.html

4. http://www.shangxueba.com/jingyan/1853835.html

5. 《深入理解Java虚拟机》

6. http://paddy-w.iteye.com/blog/841798

    <!-- BEGIN #author-bio -->