代理模式

概述

由于某些原因需要给某对象提供一个代理以控制该对象的访问。这时，访问对象不适合或者不能直接引用目标对象，代理对象作为访问对象和目标对象之间的中介。

Java中的代理按照代理类生成时机不同又分为静态代理和静态代理。静态代理的代理类在编译器就生成，而动态代理的代理类则是在Java运行时动态生成。动态代理又有JDK代理和CGLIB代理两种。

结构

代理（Proxy）模式分为三种角色：

抽象主题（Subject）类：通过接口或抽象类声明真实主题和代理对象实现的业务方法
真实主题（Real Subject）类：实现了抽象主题中的具体业务，是代理对象所代表的真实对象，是最终要引用的对象
代理（Proxy）类：提供了真实主题相同的接口，其内部含有对真实主题的引用，它可以访问、控制或者扩展真实主题的功能

静态代理

案例

购买火车票的话，需要坐车去火车站，排队等一系列的操作，显然比较麻烦。而火车站在多个地方都有车票代售点，我们就近在选择代售点购买车票就比较方便。这个例子其实就是典型的代理模式，火车站是目标对象，代售点就是代理对象。UML类型图如下：

代码

抽象主题（SellTickets）

java

package com.huangjiliang.design.heima.structure.proxy.state;

/**
 * 销售车票接口【抽象主题】
 */
public interface SellTickets {

    void sell();

}

目标对象（TrainStation）

java

package com.huangjiliang.design.heima.structure.proxy.state;

/**
 * 火车站类【目标对象】
 */
public class TrainStation implements SellTickets{
    @Override
    public void sell() {
        System.out.println("火车站卖票！");
    }
}

代理对象（ProxyPoint）

java

package com.huangjiliang.design.heima.structure.proxy.state;

/**
 * 代售点【代理类】
 */
public class ProxyPoint implements SellTickets{

    private TrainStation trainStation = new TrainStation();

    @Override
    public void sell() {
        System.out.println("代售点收取手续费~！");
        trainStation.sell();
    }
}

客户端（Client）

java

package com.huangjiliang.design.heima.structure.proxy.state;

/**
 * 客户端
 */
public class Client {

    public static void main(String[] args) {
        // 本来是通过火车站购买火车票的，但是可以通过代理火车站进行购买，而代理类可以做自己的一些事情，比如收手续费等
        ProxyPoint proxyPoint = new ProxyPoint();
        proxyPoint.sell();
    }

}

总结

从上面代码中可以看到客户端类直接访问的是代理对象ProxyPoint，也就是说dialing对象作为访问对象和目标对象的中介。同时也对sell方法进行了增强（代理点收取一定的手续费等）

JDK动态代理

Java中提供了一个动态代理类Proxy，Proxy并不是静态代理案例的代理对象的类（ProxxyPoint），而是提供了一个创建代理对象的静态方法（newProxyInstance方法）来获取代理对象

代码

抽象主题（SellTickets）

java

package com.huangjiliang.design.heima.structure.proxy.jdk;

/**
 * 销售车票接口【抽象主题】
 */
public interface SellTickets {

    void sell();

}

目标对象（TrainStation）

java

package com.huangjiliang.design.heima.structure.proxy.jdk;

/**
 * 火车站类【目标对象】
 */
public class TrainStation implements SellTickets {
    @Override
    public void sell() {
        System.out.println("火车站卖票！");
    }
}

代理工厂-获取代理对象（ProxyFactory）

java

package com.huangjiliang.design.heima.structure.proxy.jdk;


import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

/**
 * 代理工厂，用来创建代理对象
 */
public class ProxyFactory {

    private TrainStation trainStation = new TrainStation();

    // 使用Proxy获取代理对象
    /**
     * newProxyInstance()方法参数说明：
     *  参数1【ClassLoader loader】：类加载器，用来加载代理类，使用真实对象的类加载器即可
     *  参数2【 Class<?>[] interfaces】：真实对象所实现的接口，代理模式真实对象和代理对象实现相同的接口
     *  参数3【InvocationHandler h】：代理对象的调用处理程序
     *
     * @return
     */
    public SellTickets getProxyObject() {
        SellTickets sellTickets = (SellTickets)Proxy.newProxyInstance(trainStation.getClass().getClassLoader(), trainStation.getClass().getInterfaces(), new InvocationHandler() {

            /**
             * invoke()方法参数说明：
             * 参数1【Object proxy】：代理对象
             * 参数2【Method method】：对应在代理对象上调用的接口方法的Method实例
             * 参数3【Object[] args】：代理对象调用接口方法时需要传递的实际参数
             *
             *
             * @param proxy the proxy instance that the method was invoked on
             *
             * @param method the {@code Method} instance corresponding to
             * the interface method invoked on the proxy instance.  The declaring
             * class of the {@code Method} object will be the interface that
             * the method was declared in, which may be a superinterface of the
             * proxy interface that the proxy class inherits the method through.
             *
             * @param args an array of objects containing the values of the
             * arguments passed in the method invocation on the proxy instance,
             * or {@code null} if interface method takes no arguments.
             * Arguments of primitive types are wrapped in instances of the
             * appropriate primitive wrapper class, such as
             * {@code java.lang.Integer} or {@code java.lang.Boolean}.
             *
             * @return
             * @throws Throwable
             */
            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                System.out.println("代理点收费手续费（JDK动态代理方式）");
                // 执行真实对象的方法
                Object invoke = method.invoke(trainStation, args);
                return invoke;
            }
        });
        return sellTickets;
    }
}

客户端（Client）

java

package com.huangjiliang.design.heima.structure.proxy.jdk;

/**
 * 客户端
 */
public class Client {

    public static void main(String[] args) {
        // 本来是通过火车站购买火车票的，但是可以通过代理火车站进行购买[此处是JDK动态代理]，而代理类可以做自己的一些事情，比如收手续费等
        ProxyFactory proxyFactory = new ProxyFactory();
        SellTickets proxyObject = proxyFactory.getProxyObject();
        proxyObject.sell();
    }

}

总结

ProxyFactory并不是代理模式中所说的代理类，而代理类是程序在运行过程中动态的内存中生成的类。通过阿里巴巴java诊断工具（Arthas）查看代理类的结构

java

package com.sun.proxy;

import com.itheima.proxy.dynamic.jdk.SellTickets;
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 SellTickets {
    private static Method m1;
    private static Method m2;
    private static Method m3;
    private static Method m0;

    public $Proxy0(InvocationHandler invocationHandler) {
        super(invocationHandler);
    }

    static {
        try {
            m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
            m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
            m3 = Class.forName("com.itheima.proxy.dynamic.jdk.SellTickets").getMethod("sell", new Class[0]);
            m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
            return;
        }
        catch (NoSuchMethodException noSuchMethodException) {
            throw new NoSuchMethodError(noSuchMethodException.getMessage());
        }
        catch (ClassNotFoundException classNotFoundException) {
            throw new NoClassDefFoundError(classNotFoundException.getMessage());
        }
    }

    public final boolean equals(Object object) {
        try {
            return (Boolean)this.h.invoke(this, m1, new Object[]{object});
        }
        catch (Error | RuntimeException throwable) {
            throw throwable;
        }
        catch (Throwable throwable) {
            throw new UndeclaredThrowableException(throwable);
        }
    }

    public final String toString() {
        try {
            return (String)this.h.invoke(this, m2, null);
        }
        catch (Error | RuntimeException throwable) {
            throw throwable;
        }
        catch (Throwable throwable) {
            throw new UndeclaredThrowableException(throwable);
        }
    }

    public final int hashCode() {
        try {
            return (Integer)this.h.invoke(this, m0, null);
        }
        catch (Error | RuntimeException throwable) {
            throw throwable;
        }
        catch (Throwable throwable) {
            throw new UndeclaredThrowableException(throwable);
        }
    }

    public final void sell() {
        try {
            this.h.invoke(this, m3, null);
            return;
        }
        catch (Error | RuntimeException throwable) {
            throw throwable;
        }
        catch (Throwable throwable) {
            throw new UndeclaredThrowableException(throwable);
        }
    }
}

从上面的类代码中，可以得到一下几个信息
- 代理类（$Proxy0）实现了SellTickets。这也就印证了之前说的真实类和代理类实现同一个接口（即抽象主题）
- 代理类（$Proxy0）将我们提供的匿名内部类对象传递给了父类

JDK动态代理执行流程

java

// 程序运行过程中动态生成的代理类
public final class $Proxy0 extends Proxy implements SellTickets {
    private static Method m3;

    public $Proxy0(InvocationHandler invocationHandler) {
        super(invocationHandler);
    }

    static {
        m3 = Class.forName("com.itheima.proxy.dynamic.jdk.SellTickets").getMethod("sell", new Class[0]);
    }

    public final void sell() {
        this.h.invoke(this, m3, null);
    }
}

// Java提供的动态代理相关类
public class Proxy implements java.io.Serializable {
    protected InvocationHandler h;
     
    protected Proxy(InvocationHandler h) {
        this.h = h;
    }
}

// 代理工厂类
public class ProxyFactory {

    private TrainStation station = new TrainStation();

    public SellTickets getProxyObject() {
        SellTickets sellTickets = (SellTickets) Proxy.newProxyInstance(station.getClass().getClassLoader(),
                station.getClass().getInterfaces(),
                new InvocationHandler() {
                    
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

                        System.out.println("代理点收取一些服务费用(JDK动态代理方式)");
                        Object result = method.invoke(station, args);
                        return result;
                    }
                });
        return sellTickets;
    }
}


// 测试访问类
public class Client {
    public static void main(String[] args) {
        // 获取代理对象
        ProxyFactory factory = new ProxyFactory();
        SellTickets proxyObject = factory.getProxyObject();
        proxyObject.sell();
    }
}

在测试类中通过代理对象调用sell()方法
根据多态的特性，执行的是代理类（$Proxy0）中的sell()方法
代理类（$Proxy0）中的sell()方法中又调用了InvocationHandler接口的子实现类对象invoke方法
invoke方法通过反射执行了真实对象所属类（TrainStation）中的sell方法

CGLIB动态代理

如果没有定义SellTickets接口【即没有定义抽象主题】，只定义了TrainStation（火车站类）。很明显JDK代理就无法使用了。因为JDK动态代理必须要求目标对象和代理对象实现一个抽象主题，从而进行代理。

CGLIB是一个功能强大，高性能的代码生成包，它为没有实现接口的类提供代理，为JDK的动态代理提供了很好的补充

CGLIB是第三方提供的包，所以需要引入jar包的坐标。

依赖引入

implementation group: 'cglib', name: 'cglib', version: '3.3.0'

代码

目标对象（TrainStation）

java

package com.huangjiliang.design.heima.structure.proxy.cglib;

/**
 * 火车站类【目标对象】
 */
public class TrainStation {

    public void sell() {
        System.out.println("火车站卖票！");
    }
}

代理工厂（ProxyFactory）

java

package com.huangjiliang.design.heima.structure.proxy.cglib;

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

public class ProxyFactory implements MethodInterceptor {

    private TrainStation target = new TrainStation();

    public TrainStation getProxyObject() {
        // 创建Enhancer对象，类似于JDK动态代理的Proxy类
        Enhancer enhancer = new Enhancer();
        // 设置父类的字节码对象
        enhancer.setSuperclass(target.getClass());
        // 设置回调函数
        enhancer.setCallback(this);
        // 创建代理对象
        TrainStation proxyObject = (TrainStation)enhancer.create();
        return proxyObject;
    }

    /**
     * invoke()方法参数说明：
     * 参数1【Object obj】：代理对象
     * 参数2【Method method】：真实对象中的方法的Method实例
     * 参数3【Object[] args】：实际参数
     * 参数4【MethodProxy proxy】：代理对象中的方法的method实例
     *
     * @param obj "this", the enhanced object
     * @param method intercepted Method
     * @param args argument array; primitive types are wrapped
     * @param proxy used to invoke super (non-intercepted method); may be called
     * as many times as needed
     * @return
     * @throws Throwable
     */
    @Override
    public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
        System.out.println("代理类收取手续费【CGLIB动态代理】");
        TrainStation invoke = (TrainStation)proxy.invokeSuper(obj, args);
        return invoke;
    }
}

客户端（Client）

java

package com.huangjiliang.design.heima.structure.proxy.cglib;

/**
 * 客户端
 */
public class Client {

    public static void main(String[] args) {
        // 本来是通过火车站购买火车票的，但是可以通过代理火车站进行购买[此处是CGLIB动态代理]，而代理类可以做自己的一些事情，比如收手续费等
        ProxyFactory proxyFactory = new ProxyFactory();
        TrainStation proxyObject = proxyFactory.getProxyObject();
        proxyObject.sell();
    }

}

三种代理的对比

JDK代理和Cglib代理
使用cglib实现动态代理，cglib底层采用asm字节码生成框架，使用字节码技术生成代理类，在JDK1.6之前比使用java反射效率要高。唯一需要注意的是，cglib不能为fianl的类或者方法进行代理，因为cglib原理是动态生成被代理类的子类
在JDK1.6、JDK1.7、JDK1.8逐步对JDK动态代理优化之后，在调用次数较少的情况下，JDK代理效率高于cglib代理效率，只有当进行大量调用的时候，JDK1.6、JDK1.7比cglibdialing效率低一些。但是到了JDK1.8的时候，jdk动态代理的效率高于cglib。所以如果又接口使用JDK动态代理，如果没有接口使用CGLIB代理
动态代理和静态代理
动态代理比静态代理慢，而动态代理最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理（InvocationHandler.invoke）。这样，在接口方法数量比较多的时候，我们可以进行灵活处理，而不是需要像静态代理那样每一个方法都进行中中转
如果接口增加一个方法，静态代理模式处理所有实现类需要实现这个方法外，所有代理类也需要实现此方法。增加了代码维护的复杂度，而动态代理就不会出现该问题

优缺点

优点：

代理模式在客户端与目标对象之间起到一个中介作用和保护目标对象的作用
代理对象可以扩展目标对象的功能
代理模式能将客户端与目标对象分离，在一定程度上降低了系统的耦合度

缺点：

增加了系统的复杂度

使用场景

远程（Remote）代理
本地服务通过网络请求远程服务，为了实现本地到远程的通讯。我们需要实现网络通信，处理其中可能的异常，为良好的代码设计和可维护性，我们将网络通信部分隐藏起来，只暴露给本地服务一个接口，通过该接口即可访问远程服务提供的功能，而不必过多关心通信部分的细节
防火墙（Firewall）代理
当将浏览器配置成代理功能时，防火墙将浏览器的请求转给互联网；当互联网返回响应时，代理服务器再将它转给我们的浏览器
保护（protect or access）代理
控制对一个对象的访问，如果需要，可以给不同的用户提供不同级别的使用权限

代理模式 ​

概述 ​

结构 ​

静态代理 ​

案例 ​

代码 ​

抽象主题（SellTickets） ​

目标对象（TrainStation） ​

代理对象（ProxyPoint） ​

客户端（Client） ​

总结 ​

JDK动态代理 ​

代码 ​

抽象主题（SellTickets） ​

目标对象（TrainStation） ​

代理工厂-获取代理对象（ProxyFactory） ​

客户端（Client） ​

总结 ​

CGLIB动态代理 ​

依赖引入 ​

代码 ​

目标对象（TrainStation） ​

代理工厂（ProxyFactory） ​

客户端（Client） ​

三种代理的对比 ​

优缺点 ​

使用场景 ​

代理模式

概述

结构

静态代理

案例

代码

抽象主题（SellTickets）

目标对象（TrainStation）

代理对象（ProxyPoint）

客户端（Client）

总结

JDK动态代理

代码

抽象主题（SellTickets）

目标对象（TrainStation）

代理工厂-获取代理对象（ProxyFactory）

客户端（Client）

总结

CGLIB动态代理

依赖引入

代码

目标对象（TrainStation）

代理工厂（ProxyFactory）

客户端（Client）

三种代理的对比

优缺点

使用场景