结构型模式 —— 代理模式

代理模式

1 概述

由于某些原因需要给对象提供一个代理以控制该对象的访问。这时，访问对象不适合或者不能直接引用目标对象，代理对象作为访问对象和目标对象之间的中介。
Java中的代理按照代理类生成时机不同又分为静态代理和动态代理。静态代理代理类在编译器就生成了，而动态代理代理类则是在Java运行时动态生成，动态代理又分为JDK代理和CGLIB代理两种。

2 结构

代理模式分为三种角色：

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

3 静态代理

去火车站车票代售点买票的案例：

//抽象主题类
public interface SellTickets {
    //买票方法
    void sell();
}

//真实主题类
public class TrainStation implements SellTickets{
    @Override
    public void sell() {
        System.out.println("火车站出票");
    }
}

//代理类
public class ProxyPoint implements SellTickets{
    private TrainStation trainStation = new TrainStation();
    @Override
    public void sell() {
        System.out.println("代售点收取手续费用");
        trainStation.sell();
    }
}

//测试类
public class Test {
    public static void main(String[] args) {
        ProxyPoint proxyPoint = new ProxyPoint();
        proxyPoint.sell();
    }
}

测试结果：
代售点收取手续费用
火车站出票

说明：从代码中可以看出，我们并没有直接到TrainStation（火车站类）对象购票而是通过ProxyPoint（代售点类）对象进行的购票，同时在ProxyPoint中也可以对sell方法进行增强（代理点收取一些服务费用）。

4 JDK动态代理

//抽象主题类
public interface SellTickets {
    //买票方法
    void sell();
}

//真实主题类
public class TrainStation implements SellTickets {
    @Override
    public void sell() {
        System.out.println("火车站出票");
    }
}

//获取代理对象的工厂类
public class ProxyFactory {
    //声明目标对象
    private TrainStation trainStation = new TrainStation();
    //获取代理对象
    public SellTickets getProxyObject(){
        /*
         * ClassLoader loader:类加载器，用于加载代理类，可以通过目标对象获取类加载器
         * Class<?>[] interfaces:代理类实现的接口的字节码文件
         * InvocationHandler h:代理对象的调用处理程序
         */
        //返回代理对象
        SellTickets sellTickets = (SellTickets) Proxy.newProxyInstance(
                trainStation.getClass().getClassLoader(),
                trainStation.getClass().getInterfaces(),
                new InvocationHandler() {
                    /*
                     * Object proxy:proxy 等同于 sellTickets 是代理对象，在invoke方法中基本不用
                     * Method method:对接口中的方法进行封装的method对象
                     * Object[] args:调用方法的实际参数
                     */
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("代售点收取手续费用");
                        //执行目标对象的方法
                        Object invoke = method.invoke(trainStation, args);
                        return invoke;
                    }
                }
        );
        return sellTickets;
    }
}

//测试类
public class Test {
    public static void main(String[] args) {
        //创建获取代理对象的工厂类对象
        ProxyFactory proxyFactory = new ProxyFactory();
        SellTickets proxyObject = proxyFactory.getProxyObject();
        proxyObject.sell();
    }
}

测试结果：
代售点收取手续费用
火车站出票

注意： ProxyFactory并不是代理模式中所说的代理类，而代理类是程序在运行过程中动态的在内存中生成的类，通过阿里巴巴开源的Java诊断工具（Arthas【阿尔萨斯】）可以查看代理类的结构

public class $Proxy0 extends Proxy implements SellTickets {

    private static Method m;
    
    //InvocationHandler是我们在ProxyFactory的Proxy.newProxyInstance的第三个参数InvocationHandler对象
    protected $Proxy0(InvocationHandler h) {
        super(h);
    }

    static {
        try {
            //获取SellTickets里面sell()方法的method对象
            m = Class.forName("设计模式.结构型模式.代理模式.JDK代理.SellTickets").getMethod("sell",new Class[0]);
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
    
    @Override
    public final void sell() {
        try {
            this.h.invoke(this, m, null);
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
    }
}

执行流程如下：

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

从上面的代码中我们可以看出：

• 代理类实现了SellTickets，这也就印证了真实类和代理类实现同样的接口
• 代理类将我们提供了的匿名内部类对象（InvocationHandler）传递给了父类（Proxy）

5 CGLIB动态代理

同样是上面的案例，如果没有定义SellTickets接口，只定义了TrainStation（火车站类）,就没办法使用JDK代理来实现，因为JDK动态代理要求必须定义接口，然后对接口进行代理。
CGLIB是一个功能强大，高性能的代码生成包，它为没有实现接口的类提供代理，为JDK的动态代理提供了很好的补充。
CGLIB是第三方提供的包，所以需要引入jar包：

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

//真实主题类
public class TrainStation{
    public void sell() {
        System.out.println("火车站出票");
    }
}

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 trainStation = new TrainStation();
    //获取代理对象
    public TrainStation getProxyObject(){
        //创建Enhancer对象，类似于JDK代理中的Proxy
        Enhancer enhancer = new Enhancer();
        //设置父类字节码对象)(指定代理类的父类)
        enhancer.setSuperclass(TrainStation.class);
        //设置回调函数
        enhancer.setCallback(this);
        //创建代理对象
        TrainStation trainStation = (TrainStation) enhancer.create();
        return trainStation;
    }

    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        System.out.println("代售点收取手续费用");
        Object invoke = method.invoke(trainStation, objects);
        return invoke;
    }
}

//测试类
public class Test {
    public static void main(String[] args) {
        ProxyFactory proxyFactory = new ProxyFactory();
        TrainStation proxyObject = proxyFactory.getProxyObject();
        proxyObject.sell();
    }
}

测试结果：
代售点收取手续费用
火车站出票

6 三种代理的对比

JDK代理和CGLIB代理：
使用CHLIB实现动态代理，CGLIB底层采用ASM字节码生成框架，使用字节码技术生成代理类，在JDK1.6之前比使用Java反射效率更高。唯一要注意的是，CGLIB不能对声明为final的类或者方法进行代理，因为CGLIB原理是动态生成被代理类的子类。
在JDK1.6，JDK1.7，JDK1.8逐步对JDK动态代理优化之后，在调用次数较少的情况下，JDK代理效率高于CGLIB代理效率，只有当进行大量调用的时候，JDK1.6和JDK1.7中JDK代理比CGLIB代理效率低一点，但是到JDK1.8的时候，JDK代理效率高于CGLIB代理。一般情况下，如果有接口使用JDK动态代理，如果没有接口使用CGLIB代理。

动态代理和静态代理：
动态代理与静态代理相比较，最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理（InvocationHandler.incoke）。这样，在接口方法数量比较多的时候，我们可以进行灵活处理，而不需要像静态代理那样每一个方法进行中转。
如果接口增加一个方法，静态代理模式除了所有实现类需要实现这个方法外，所有代理类也需要实现此方法，增加了代码维护的复杂度，而动态代理不会出现该问题。

7 优缺点

优点：

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

缺点：

• 增加了系统的复杂度

8 使用场景

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