设计模式-代理模式

概述

当访问对象不适合或者不能直接引用目标对象，可以提供一个代理以控制对该对象的访问，代理对象作为访问对象和目标对象之间的中介。

Java 中的代理按照代理类生成时机不同又分为静态代理和动态代理；

静态代理代理类在编译期就生成，而动态代理代理类则是在 Java 运行时动态生成；

动态代理又有 JDK 代理和 CGLib 代理两种。

结构

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

• 抽象主题类： 通过接口或抽象类声明真实主题和代理对象实现的业务方法。

• 真实主题类： 实现了抽象主题中的具体业务，是代理对象所代表的真实对象，是最终要引用的对象。

• 代理类 ： 提供了与真实主题相同的接口，其内部含有对真实主题的引用，它可以访问、控制或扩展真实主题的功能。

静态代理

【例】火车站卖票

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

/**
 * @author zhangjianyu
 * email: 578547270@qq.com
 * create_time: 2023-07-13 18:03
 * description: 卖火车票的接口类
 */
public interface SellTickets {

    void sell();
}

/**
 * @author zhangjianyu
 * email: 578547270@qq.com
 * create_time: 2023-07-13 18:04
 * description: 火车站类：火车票具有卖票功能，实现 SellTickets 接口
 */
public class RailwayStation implements SellTickets {
    public void sell() {
        System.out.println("出售火车票");
    }
}

/**
 * @author zhangjianyu
 * email: 578547270@qq.com
 * create_time: 2023-07-13 18:04
 * description: 代售点类：代理火车站，进行卖票操作，同时对该方法做了点增强（收取费用）
 */
public class SellAgent implements SellTickets {

    final private RailwayStation railwayStation = new RailwayStation();

    public void sell() {
        System.out.println("代理收取费用");
        railwayStation.sell();
    }
}

/**
 * @author zhangjianyu
 * email: 578547270@qq.com
 * create_time: 2023-07-13 18:05
 * description: 测试类
 */
public class StaticProxyTest {

    public static void main(String[] args) {
        SellAgent sellAgent = new SellAgent();
        sellAgent.sell();
    }
}

从上面代码中可以看出测试类直接访问的是 ProxyPoint 类对象，也就是说 ProxyPoint 作为访问对象和目标对象的中介。

同时也对 sell 方法进行了增强（代理点收取一些服务费用）。

动态代理

JDK 动态代理

Java 中提供了一个动态代理类 Proxy，Proxy 并不是我们上述所说的代理对象的类，而是提供了一个创建代理对象的静态方法（newProxyInstance 方法）来获取代理对象。

注：JDK 动态代要求必须定义接口，因为它只能对接口进行代理。

/**
 * @author zhangjianyu
 * email: 578547270@qq.com
 * create_time: 2023-07-13 18:09
 * description: 获取代理对象的工厂类
 */
public class ProxyFactory {
    private final RailwayStation station = new RailwayStation();

    public SellTickets getProxyObject() {
        // 返回代理对象
        /*
            ClassLoader loader: 类加载器,用于加载代理类,可以通过目标对象获取类加载器
            Class<?>[] interfaces: 代理类实现的接口的字节码对象
            InvocationHandler h: 代理对象调用处理程序
        */
        return (SellTickets) Proxy.newProxyInstance(
                station.getClass().getClassLoader(),
                station.getClass().getInterfaces(),
                new InvocationHandler() {
                    /**
                     * @param proxy 代理对象, 和proxyObject是同一个对象,在invoke方法中基本不用
                     * @param method 对接口中的方法进行封装的method对象
                     * @param args 调用方法的实际参数
                     * @return 方法的返回值
                     */
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("代理收取费用(jdk动态代理)");
                        return method.invoke(station, args);
                    }
                });
    }

}

ProxyFactory 是代理类吗？

ProxyFactory 不是代理模式中所说的代理类，而是程序在运行过程中动态的在内存中生成的代理类。

通过阿里巴巴开源的 Java 诊断工具（Arthas【阿尔萨斯】）查看代理类的结构：（去除其他代码）

// 程序运行过程中动态生成的代理类
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]);
      return;
    }
  
    public final void sell() {
      this.h.invoke(this, m3, null);
    }
}

从上面的类中，我们可以看到以下几个信息：

• 代理类 $Proxy0 实现了 SellTickets 接口，这也就印证了真实类和代理类实现同样的接口。

• 代理类 $Proxy0 将我们提供了的匿名内部类对象传递给了父类。

动态代理的执行流程是什么样？

摘取整个流程的重点代码：

// 程序运行过程中动态生成的代理类
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]);
    }
	  
    // ② 根据多态的特性，执行的是代理类 $Proxy0 中的 sell() 方法
    public final void sell() {
	      // ③ 代理类 $Proxy0 中的 sell() 方法中又调用了 InvocationHandler 接口的子实现类对象的 invoke 方法
        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() {
                    // ④ invoke 方法通过反射执行了真实对象所属类 TrainStation 中的 sell() 方法
                    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();
      	// ① 在测试类中通过代理对象调用 sell() 方法
        SellTickets proxyObject = factory.getProxyObject();
        proxyObject.sell();
    }
}

执行流程如下：

① 在测试类中通过代理对象调用 sell() 方法

② 根据多态的特性，执行的是代理类 $Proxy0 中的 sell() 方法

③ 代理类 $Proxy0 中的 sell() 方法中又调用了 InvocationHandler 接口的子实现类对象的 invoke 方法

④ invoke 方法通过反射执行了真实对象所属类 TrainStation 中的 sell() 方法

CGLIB 动态代理

上面的案例中，如果没有定义 SellTickets 接口，只定义了 TrainStation 火车站类。则 JDK 代理无法使用，因为 JDK 动态代理要求必须定义接口，它只能对接口进行代理。

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

CGLIB 是第三方提供的包，所以需要引入依赖：

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

/**
 * @author zhangjianyu
 * email: 578547270@qq.com
 * create_time: 2023-07-13 18:25
 * description: 代理工厂类：用来获取代理对象
 */
public class ProxyFactory implements MethodInterceptor {

    private RailwayStation station = new RailwayStation();

    public RailwayStation getProxyObject() {
        // 创建Enhancer对象,类似于JDK代理中的Proxy类
        Enhancer enhancer = new Enhancer();
        // 设置父类的字节码对象(指定父类)
        enhancer.setSuperclass(RailwayStation.class);
        // 设置回调函数
        enhancer.setCallback(this);
        // 创建代理对象
        return (RailwayStation) enhancer.create();
    }

    /**
     *
     * @param o 代理对象
     * @param method 真实对象中的方法的Method实例
     * @param objects 实际参数
     * @param methodProxy 代理对象中的方法的method实例
     * @return 方法执行结果
     */
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        System.out.println("代理收取费用 cglib代理");
        return method.invoke(station, objects);
    }
}

三种代理的对比

两种动态代理的对比：JDK 代理 和 CGLib 代理

• CGLib 动态代理，底层采用 ASM 字节码生成框架，使用字节码技术生成代理类，在 JDK1.6 之前比使用 JDK 动态代理的效率要高。唯一需要注意的是，CGLib 不能对声明为 final 的类或者方法进行代理，因为CGLib 的原理是动态生成被代理类的子类。

• JDK1.6、JDK1.7、JDK1.8 逐步对 JDK 动态代理优化之后，在调用次数较少的情况下，JDK 代理效率高于 CGLib 代理效率；只有当进行大量调用的时候，JDK1.6 和 JDK1.7 比 CGLib 代理效率低一点，但是到 JDK1.8 的时候，JDK 代理效率高于 CGLib 代理。

所以，JDK1.8 以后，如果有接口就使用 JDK 动态代理，没有接口就使用 CGLib 代理。

动态代理和静态代理的对比：

• 动态代理与静态代理相比较，最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理 (InvocationHandler.invoke)。这样，在接口方法数量比较多的时候，我们可以进行灵活处理，而不需要像静态代理那样每一个方法进行中转。

• 如果接口增加一个方法，静态代理模式除了所有实现类需要实现这个方法外，所有代理类也需要实现此方法，增加了代码维护的复杂度，而动态代理不会出现该问题。

优缺点

优点：

• 代理模式在客户端与目标对象之间起到一个中介作用和保护目标对象的作用；

• 代理对象可以扩展目标对象的功能；

• 代理模式能将客户端与目标对象分离，在一定程度上降低了系统的耦合度；

保护、增强、解耦

缺点：

• 增加了系统的复杂度；

使用场景

远程（Remote）代理

• 本地服务通过网络请求远程服务。为了实现本地到远程的通信，我们需要实现网络通信，处理其中可能的异常。为良好的代码设计和可维护性，我们将网络通信部分隐藏起来，只暴露给本地服务一个接口，通过该接口即可访问远程服务提供的功能，而不必过多关心通信部分的细节。

• RPC 的思想

防火墙（Firewall）代理

• 当你将浏览器配置成使用代理功能时，防火墙就将你的浏览器的请求转给互联网；当互联网返回响应时，代理服务器再把它转给你的浏览器。

• VPN 的思想

保护（Protect or Access）代理

• 控制对一个对象的访问，如果需要，可以给不同的用户提供不同级别的使用权限。