java设计模式之 代理模式

代理模式简介

代理模式在JDK和java开源项目中都有非常广泛的应用。我们实际开发过程中也经常会用到代理模式。
代理模式的定义：给某一个对象提供一个代理，并由代理对象控制对原对象的引用

两个对象参与同一个请求，接收到的请求由代理对象委托给真实对象处理，代理对象控制请求的访问，它在客户端应用与真实目标之间起到一个中介桥梁的作用。

代理模式包含如下角色：

• ISubject：抽象角色，是一个接口。该接口是对象和它的代理共用的接口(指的是jdk中的代理)。
• RealSubject：真实角色，是实现抽象主题接口的类。
• Proxy：代理角色，内部含有对真实对象RealSubject的引用，从而可以操作真实对象。代理对象提供与真实对象相同的接口，以便在任何时刻都能代替真实对象。同时，代理对象可以在执行真实对象操作时，附加其他的操作，相当于对真实对象进行封装。

实现动态代理的关键技术是反射

静态代理

代理模式可以分为静态代理和动态代理两种，静态代理比较简单，就是硬编码方式，不够灵活，而且代码繁多。所以一般不会使用静态代理，这里就不多说了。

动态代理

为了解决静态代理存在的问题，就有了动态地创建Proxy的想法：在运行状态中，需要代理的地方，根据Subject 和RealSubject，动态地创建一个Proxy，用完之后，就会销毁，这样就可以避免了Proxy 角色的class在系统中冗杂的问题了。

接下来我们以最基本的添加日志功能演示一下代理的实现

JDK实现动态代理

jdk的动态代理步骤

1. 创建一个实现InvocationHandler接口的类，它必须实现invoke()方法
2. 创建被代理的类及接口
3. 调用Proxy的静态方法，创建一个代理类
4. 通过代理调用方法

/** * Created by liubenlong on 2017/2/3. * 动态代理使用到的接口 */public interface HelloWorld {    void sayHello(String name);}

实现类

public class HelloWorldImpl implements HelloWorld {    @Override      public void sayHello(String name) {          System.out.println("我是RealSubject。 Hello " + name);    }  }  

日志代理类

import java.lang.reflect.InvocationHandler;import java.lang.reflect.Method;/** * Created by liubenlong on 2017/2/3. * 日志代理类 */public class CustomInvocationHandler implements InvocationHandler {    private Object target;    public CustomInvocationHandler(Object target) {        this.target = target;    }    @Override    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {        System.out.println("before  log...");        Object invoke = method.invoke(target, args);        System.out.println("end  log...。该方法总共执行时间是10毫秒。");        return invoke;    }}

测试方法：

public static void main(String[] args){        System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");        HelloWorldImpl helloWorld = new HelloWorldImpl();        CustomInvocationHandler handler = new CustomInvocationHandler(helloWorld);        HelloWorld proxyInstance = (HelloWorld) Proxy.newProxyInstance(HelloWorldImpl.class.getClassLoader(),                new Class[]{HelloWorld.class},                handler);        proxyInstance.sayHello("haha");    }

输出结果：

before  log...我是RealSubject。 Hello hahaend  log...。该方法总共执行时间是10毫秒。

到这里，我们就可以使用jdk的动态代理来编写代码了。但是为什么需要这几步，JDK内部是怎么实现的呢？这个问题可以从Proxy和InvocationHandler的源码中找打答案。

JDK动态代理原理与源码

这里使用的jdk版本是：1.8.0_111

newProxyInstance()方法的源码：

@CallerSensitivepublic static Object newProxyInstance(ClassLoader loader,                                      Class<?>[] interfaces,                                      InvocationHandler h)    throws IllegalArgumentException{    Objects.requireNonNull(h);    final Class<?>[] intfs = interfaces.clone();    final SecurityManager sm = System.getSecurityManager();    if (sm != null) {        checkProxyAccess(Reflection.getCallerClass(), loader, intfs);    }    /*     * Look up or generate the designated proxy class.     */    Class<?> cl = getProxyClass0(loader, intfs);    /*     * Invoke its constructor with the designated invocation handler.     */    try {        if (sm != null) {            checkNewProxyPermission(Reflection.getCallerClass(), cl);        }        final Constructor<?> cons = cl.getConstructor(constructorParams);        final InvocationHandler ih = h;        if (!Modifier.isPublic(cl.getModifiers())) {            AccessController.doPrivileged(new PrivilegedAction<Void>() {                public Void run() {                    cons.setAccessible(true);                    return null;                }            });        }        return cons.newInstance(new Object[]{h});    } catch (IllegalAccessException|InstantiationException e) {        throw new InternalError(e.toString(), e);    } catch (InvocationTargetException e) {        Throwable t = e.getCause();        if (t instanceof RuntimeException) {            throw (RuntimeException) t;        } else {            throw new InternalError(t.toString(), t);        }    } catch (NoSuchMethodException e) {        throw new InternalError(e.toString(), e);    }}

可以看到，获得代理类的代码是Class<?> cl = getProxyClass0(loader, intfs);
并由此获得代理类的构造函数，生成代理类的实例返回给该方法的调用者。

继续跟进getProxyClass0()方法：

/** *Generate a proxy class.  Must call the checkProxyAccess method * to perform permission checks before calling this. */private static Class<?> getProxyClass0(ClassLoader loader,                                       Class<?>... interfaces) {    if (interfaces.length > 65535) {        throw new IllegalArgumentException("interface limit exceeded");    }    // If the proxy class defined by the given loader implementing    // the given interfaces exists, this will simply return the cached copy;    // otherwise, it will create the proxy class via the ProxyClassFactory    return proxyClassCache.get(loader, interfaces);}

通过注释可以看到，代理类是从proxyClassCache 取的，如果代理类已经通过实现给定接口的类加载器创建了，则返回缓存中的该类的副本；否则将通过ProxyClassFactory创建代理类。
我们查看proxyClassCache的初始化代码

/** * a cache of proxy classes */private static final WeakCache<ClassLoader, Class<?>[], Class<?>>    proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());

可以发现proxyClassCache是个用来缓存代理类的类变量[static final]，大家知道类变量的特点是与类一一对应，在一个虚拟机中类只有一个，对应着在一个虚拟机中类变量也只有一个【这是一个单例模式】，且在此处，在Proxy类被加载的时候就赋值了。

注意这里是虚引用WeakCache。虚引用并不会决定对象的生命周期。如果一个对象仅持有虚引用，那么它就和没有任何引用一样，在任何时候都可能被垃圾回收器回收。具体请参考 Java:对象的强、软、弱和虚引用

在赋值操作的参数中有ProxyClassFactory()这么一个构造函数，这个是动态代理中的关键：生成代理类的类文件字节码。继续跟进去，找到代理类的生成之处了：

/** * A factory function that generates, defines and returns the proxy class given * the ClassLoader and array of interfaces. * 根据给定的类加载器和接口数组生成代理类的工厂类 */private static final class ProxyClassFactory    implements BiFunction<ClassLoader, Class<?>[], Class<?>>{    // prefix for all proxy class names   代理类的前缀    private static final String proxyClassNamePrefix = "$Proxy";    // next number to use for generation of unique proxy class names    //代理类编号，这里使用的是AtomicLong保证线程安全    private static final AtomicLong nextUniqueNumber = new AtomicLong();    @Override    public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {        Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);        for (Class<?> intf : interfaces) {            /*             * Verify that the class loader resolves the name of this             * interface to the same Class object.             */            Class<?> interfaceClass = null;            try {                interfaceClass = Class.forName(intf.getName(), false, loader);            } catch (ClassNotFoundException e) {            }            if (interfaceClass != intf) {                throw new IllegalArgumentException(                    intf + " is not visible from class loader");            }            /*             * Verify that the Class object actually represents an             * interface.             * 验证             */            if (!interfaceClass.isInterface()) {                throw new IllegalArgumentException(                    interfaceClass.getName() + " is not an interface");            }            /*             * Verify that this interface is not a duplicate.             * 确保接口唯一             */            if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {                throw new IllegalArgumentException(                    "repeated interface: " + interfaceClass.getName());            }        }        String proxyPkg = null;     // package to define proxy class in代理类的包名        int accessFlags = Modifier.PUBLIC | Modifier.FINAL;        /*         * Record the package of a non-public proxy interface so that the         * proxy class will be defined in the same package.  Verify that         * all non-public proxy interfaces are in the same package.         */        for (Class<?> intf : interfaces) {            int flags = intf.getModifiers();            if (!Modifier.isPublic(flags)) {                accessFlags = Modifier.FINAL;                String name = intf.getName();                int n = name.lastIndexOf('.');                String pkg = ((n == -1) ? "" : name.substring(0, n + 1));                if (proxyPkg == null) {                    proxyPkg = pkg;                } else if (!pkg.equals(proxyPkg)) {                    throw new IllegalArgumentException(                        "non-public interfaces from different packages");                }            }        }        if (proxyPkg == null) {            // if no non-public proxy interfaces, use com.sun.proxy package            proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";        }        /*         * Choose a name for the proxy class to generate.         * 这里生成代理类的名称         */        long num = nextUniqueNumber.getAndIncrement();        // 默认情况下，代理类的完全限定名为：com.sun.proxy.$Proxy0，com.sun.proxy.$Proxy1……依次递增          String proxyName = proxyPkg + proxyClassNamePrefix + num;        /*         * Generate the specified proxy class.         * 生成指定的代理类。 这里才是真正的生成代理类的字节码的地方           */        byte[] proxyClassFile = ProxyGenerator.generateProxyClass(            proxyName, interfaces, accessFlags);        try {        // 根据二进制字节码返回相应的Class实例              return defineClass0(loader, proxyName,                                proxyClassFile, 0, proxyClassFile.length);        } catch (ClassFormatError e) {            /*             * A ClassFormatError here means that (barring bugs in the             * proxy class generation code) there was some other             * invalid aspect of the arguments supplied to the proxy             * class creation (such as virtual machine limitations             * exceeded).             */            throw new IllegalArgumentException(e.toString());        }    }}

真正生产字节码和代理类的是这句byte[] proxyClassFile = ProxyGenerator.generateProxyClass( proxyName, interfaces, accessFlags);但是ProxyGenerator没有开源，不过我们可以反编译看看：

public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {    ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);    final byte[] var4 = var3.generateClassFile();    // 这里根据参数配置，决定是否把生成的字节码（.class文件）保存到本地磁盘，我们可以通过把相应的class文件保存到本地，再反编译来看看具体的实现，这样更直观      if(saveGeneratedFiles) {        AccessController.doPrivileged(new PrivilegedAction() {            public Void run() {                try {                    int var1 = var0.lastIndexOf(46);                    Path var2;                    if(var1 > 0) {                        Path var3 = Paths.get(var0.substring(0, var1).replace('.', File.separatorChar), new String[0]);                        Files.createDirectories(var3, new FileAttribute[0]);                        var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");                    } else {                        var2 = Paths.get(var0 + ".class", new String[0]);                    }                    Files.write(var2, var4, new OpenOption[0]);                    return null;                } catch (IOException var4x) {                    throw new InternalError("I/O exception saving generated file: " + var4x);                }            }        });    }    return var4;}

我们看看saveGeneratedFiles的声明private static final boolean saveGeneratedFiles = ((Boolean)AccessController.doPrivileged(new GetBooleanAction("sun.misc.ProxyGenerator.saveGeneratedFiles"))).booleanValue();

所以我们可以设置sun.misc.ProxyGenerator.saveGeneratedFiles这个系统属性为true来把生成的class保存到本地文件来查看，就是上面main方法中的System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");。

到这里，可以大致的看清JDK中动态代理的面孔了，实现的步骤为：
1. 创建代理类的源码；
2. 对源码进行编译成字节码；
3. 将字节码加载到内存；
4. 实例化代理类对象并返回给调用者；

运行完main方法后，我们到当前main方法的路径下的com/sun/proxy目录,可以看到有一个$Proxy0.class,用jd-gui反编译查看：

package com.sun.proxy;import com.lbl.proxy.HelloWorld;import java.lang.reflect.InvocationHandler;import java.lang.reflect.Method;import java.lang.reflect.Proxy;import java.lang.reflect.UndeclaredThrowableException;public final class $Proxy0 extends Proxy  implements HelloWorld{  private static Method m1;  private static Method m3;  private static Method m2;  private static Method m0;  public $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 (RuntimeException localRuntimeException)    {      throw localRuntimeException;    }    catch (Throwable localThrowable)    {    }    throw new UndeclaredThrowableException(localThrowable);  }  public final void sayHello(String paramString)    throws   {    try    {      this.h.invoke(this, m3, new Object[] { paramString });      return;    }    catch (RuntimeException localRuntimeException)    {      throw localRuntimeException;    }    catch (Throwable localThrowable)    {    }    throw new UndeclaredThrowableException(localThrowable);  }  public final String toString()    throws   {    try    {      return (String)this.h.invoke(this, m2, null);    }    catch (RuntimeException localRuntimeException)    {      throw localRuntimeException;    }    catch (Throwable localThrowable)    {    }    throw new UndeclaredThrowableException(localThrowable);  }  public final int hashCode()    throws   {    try    {      return ((Integer)this.h.invoke(this, m0, null)).intValue();    }    catch (RuntimeException localRuntimeException)    {      throw localRuntimeException;    }    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("com.lbl.proxy.HelloWorld").getMethod("sayHello", new Class[] { Class.forName("java.lang.String") });      m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);      m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);      return;    }    catch (NoSuchMethodException localNoSuchMethodException)    {      throw new NoSuchMethodError(localNoSuchMethodException.getMessage());    }    catch (ClassNotFoundException localClassNotFoundException)    {    }    throw new NoClassDefFoundError(localClassNotFoundException.getMessage());  }}

JDK动态代理为什么必须实现一个接口InvocationHandler

从上面生产的代理类可以看到，生成的代理类是继承了Proxy类的，这就是说明了为什么使用JDK动态代理不能实现继承式动态代理，原因是Java不允许多继承，而生成的代理类本身就已经继承了Proxy类。

我们自己模拟实现动态代理

根据上面源码的分析， 其实我们可以自己实现一个动态代理。请参考另一篇文章自己动手模拟动态代理的实现

使用cglib实现动态代理

前面分析到，因为Java只允许单继承，而JDK生成的代理类本身就继承了Proxy类，因此，使用JDK实现的动态代理不能完成继承式的动态代理，但是我们可以使用cglib来实现继承式的动态代理。
大名鼎鼎的spring中就含有cglib动态代理，在此也以Spring中自带的cglib完成动态代理的实现：

cglib 创建某个类A的动态代理类的模式是：

1.   查找A上的所有非final 的public类型的方法定义；2.   将这些方法的定义转换成字节码；3.   将组成的字节码转换成相应的代理的class对象；4.   实现 MethodInterceptor接口，用来处理 对代理类上所有方法的请求（这个接口和JDK动态代理InvocationHandler的功能和角色是一样的）

引入cglib的maven依赖：

<dependency>            <groupId>cglib</groupId>            <artifactId>cglib</artifactId>            <version>3.2.4</version>        </dependency>

package com.lbl.proxy;import net.sf.cglib.proxy.Enhancer;import net.sf.cglib.proxy.MethodInterceptor;import net.sf.cglib.proxy.MethodProxy;import java.lang.reflect.Method;//1.具体主题public class Train{      public void move(){          System.out.println("火车行驶中…");      }  }  //2.生成代理  class CGLibProxy implements MethodInterceptor {    private Enhancer enhancer = new Enhancer();    public Object getProxy(Class<?> clazz){          enhancer.setSuperclass(clazz);          enhancer.setCallback(this);          return enhancer.create();      }      /**      * 拦截所有目标类方法的调用      * 参数：      * obj目标实例对象      *method 目标方法的反射对象      * args方法的参数      * proxy代理类的实例      */      public Object intercept(Object obj, Method method, Object[] args,                            MethodProxy proxy) throws Throwable {        //代理类调用父类的方法          System.out.println("日志开始");          proxy.invokeSuper(obj, args);          System.out.println("日志结束");          return null;      }  }  //3.测试  class Test4 {    public static void main(String[] args) {          CGLibProxy proxy = new CGLibProxy();          Train t = (Train) proxy.getProxy(Train.class);          t.move();      }  } 

输出结果：

日志开始火车行驶中…日志结束

spring中的代理

参考资料

模拟JDK动态代理 ; 自己动手模拟实现java动态代理
Java动态代理机制详解（JDK 和CGLIB，Javassist，ASM）
Java设计模式——代理模式实现及原理