Proxy 代理模式

动机

有时，我们需要对一个对象的访问进行控制。比如说如果我们有一些开销较大的对象，但是只需要使用其中一部分方法，我们只要在完全需要它们的时候才初始化这些对象。那时， 我们可以用一些暴露出同样接口的轻量级对象来替代那些笨重的对象。这些轻量级的对象就称为代理，并且它们只会在真正需要的时候才实例化那些笨重的对象，那时，我们就转而使用一些轻量级的对象了。

这种对对象的访问进行控制的需求源自于： 需要控制开销较大的对象的实例化和初始化过程；赋予对象不同的访问权限；以及提供多样化的途径来访问和引用运行于其它进程或机器的对象；其它。

设想一个图片预览软件。这种软件必须能够列举和展示文件夹中的高清图片。不过，人们有多频繁打开文件夹并且查看里边的所有图片。有时，你要寻找特定的照片，有时，你只想要查看图片名称。图片预览程序必须能够列出所有的照片对象，但是这些对象必须在需要渲染的时候才加载到内存中。

目的

此模式的目标是要为对象提供一个占位符来控制对其的引用

实现

proxy uml类图

• Subject 表示 RealSubject 要实现的接口。代理 Proxy 也要实现这个接口，这样在使用 RealObject 的地方都能使用代理类 Proxy。
• Proxy
  • 保持访问 RealSubject 的引用
  • 实现 RealSubject 一样的接口，这样 Proxy 就能替代 RealSubject了
  • 控制 RealSubject 的访问，可能还需要负责其它的创建和删除
  • 根据代理的类型，其他职责
• RealSubject 代理类代表的真正对象

说明

客户端 client 持有一个 Proxy 的引用，然后 client 按照原先处理 RealSubject 一样处理 Proxy 从而调用 doOperation() 。 这时，Proxy 在调用 RealSubject.doOperation() 之前可以做些其他的事情。 Proxy 可以新建一个 RealObject 对象，执行初始化操作，检查 client 对该方法的调用许可，然后再调用方法。Proxy 也可以在调用 doOperation() 之后做一些额外的任务，如增加对象的引用计数。

适用范围 & 例子

代理模式适用于需要控制对象的访问的时候，也适用于对象的复杂引用。常见的情景如下：

• Virtual Proxies - 虚拟代理 将开销大的对象的创建和初始化延迟到需要的时候，对象根据需要来创建。
• Remote Proxies - 远程代理 为在不同地址空间的对象提供一个本地表示。常见的例子是 Java RMI 桩对象，这些桩对象在调用桩对象的方法时作为代理同处于其他机器上的远程对象进行通信的方法调用。
• Protection Proxies - 保护代理 代理对 RealSubject 的方法访问进行控制，赋予部分对象访问权限、拒绝其它对象的访问。
• Smart References - 智能引用 为指定的对象提供复杂的访问控制。比如跟踪一个对象的引用数量，如果超过特定的值就拒绝访问。或者是按需从数据库中将对象加载到内存里。

例子 - Virtual Proxy

如文章开头讲的，列出和展示高清图片的图片预览程序需要显示出所有照片的列表，不过在用户从列表中选择一张图片之前不需要展示实体的图片。

Virtual Proxy - Image Viewer Program

下面代码中的 Image 接口代表前面提到的 Subject 。 这个接口中只有一个 showImage() 的方法，具体实现类必须实现它来把图片渲染到屏幕。

package proxy;

/**
* Subject Interface
*/
public interface Image{
  public void showImage();
}

下面的代码展示了代理的实现。图片代理是个虚拟代理，它创建并按需加载真实的图片对象，这样可以节省将图片加载进内存的开销，直到渲染图片的时候才需要加载。

package proxy;

public class ImageProxy implements Image{

    /**
     * 私有代理数据
     */
    private String imageFilePath;

    /**
     * 引用 RealSubject
     */
    private Image proxifiedImage;

    public ImageProxy(String imageFilePath){
        this.imageFilePath = imageFilePath;
    }
    
    @Override
    public void showImage() {

        // 只在需要渲染图片的时候才创建图片对象
        proxifiedImage = new HighResolutionImage(imageFilePath);
        
        proxifiedImage.showImage();
    }
}

以下是图片预览程序的代码；程序中就简单的加载了三张图片，只渲染一张图片，一次用代理模式 ImageProxy ，另一次直接使用真实对象 HighResolutionImage 。我们可以看到，当我们使用代理模式的时候，虽然三张图片加载进来了，但是这高分辨率的图片直到渲染的时候才加载。然而对于没有使用代理模式的部分，尽管实际上只要渲染一张图片，三张图片也都加载到内存中了。

package proxy;

/**
 * Image Viewer Promgram
 */
public class ImageViewer {
    public static void main(String[] args) {
        // 假设用户选中有三张图片的文件夹

        // 创建3个图片对象
        Image highResolutionImage1 = new ImageProxy("sample/veryHighResPhoto1.jpeg");
        Image highResolutionImage2 = new ImageProxy("sample/veryHighResPhoto2.jpeg");
        Image highResolutionImage3 = new ImageProxy("sample/veryHighResPhoto3.jpeg");

        // 假设用户点击列表中的一个图片，这只会引起程序调用这个图片的 showImage() 方法。
        // 注意，这种情况只会把这张图片加载进内存
        highResolutionImage1.showImage();

        // 思考下， 如果直接使用 HighResolutionImage 对象会怎么样
        Image highResolutionImageNoProxy1 = new HighResolutionImage("sample/veryHighResPhoto1.jpeg");
        Image highResolutionImageNoProxy2 = new HighResolutionImage("sample/veryHighResPhoto2.jpeg");
        Image highResolutionImageNoProxy3 = new HighResolutionImage("sample/veryHighResPhoto3.jpeg");

        // 如果用户只选中了图片2， 由于这种情况所有图片都已经加载到内存中了，
        // 但是用户并没有查看所有图片，内存就浪费了
        highResolutionImageNoProxy2.showImage();
        
    }

}

示例代码： https://github.com/minorpoet/design-patterns/tree/master/proxy

具体问题和实现

Java 远程方法调用（RMI）
在Java RMI 中在一个机器中（运行于JVM）的客户端对象可以调用处于另一个机器上的远程对象（另一个JVM）的方法。代理（也称为桩）位于客户端机器中，客户端对象调用代理对象就好像远程对象本身一样（记住代理同样实现了 RealSubject 实现的接口）。代理对象本身会同远程对象进行通信，调用远程对象的方法，有返回值的话就返回给客户端。这种情形的代理就是 Remote Proxy 远程代理。

相关模式

• 适配器模式 适配器 adapter 实现了和其适配的对象 adaptee 不同的接口，而代理实现的接口和其主题对象一致
• 装饰器模式 装饰器 decorator 的实现可以和代理一样，不过装饰器增强了的对象的功能，而代理控制了对象的访问

总结

已知应用：

• 如上述介绍 Java RMI 实现了远程代理
• 安全代理 Security Proxies 控制对象的访问权限，可以在很多面向对象编程语言中发现其应用，包括 java, c#, c++...