代理模式

代理模式（proxy pattern），是程式設計中的一種設計模式。所謂的代理者是指一個類別可以作為其它東西的介面。代理者可以作任何東西的介面：網路連接、記憶體中的大物件、檔案或其它昂貴或無法複製的資源。

## 概述

著名的代理模式例子為參照計數（reference counting）指標物件。當一個複雜物件的多份副本須存在時，代理模式可以結合享元模式以減少記憶體用量。典型作法是建立一個複雜物件及多個代理者，每個代理者會參照到原本的複雜物件。而作用在代理者的運算會轉送到原本物件。一旦所有的代理者都不存在時，複雜物件會被移除。

## 結構

<image>

在上面的UML類圖中，`Proxy`類實現了`Subject`接口，使它充當`Subject`對象的代替者。它維護一個引用（`realSubject`）至被代替的對象（`RealSubject`），使其可以轉發給它（`realSubject.operation()`）。

序列圖展示了運行時交互：The `Client`對象通過合作於`Proxy`對象，來控制到`RealSubject`對象的訪問。在這個例子中，`Proxy`轉發請求至`RealSubject`，它辦理這個請求。

## 示例

### C++

下面是C++的例子：

```cpp
import std;

using std::string;
using std::unique_ptr;

// Subject Interface
class Image {
public:
    virtual void display() const = 0;
    virtual ~Image() = default;
};

// Real Subject (expensive to load)
class RealImage : public Image {
private:
    string filename;
public:
    explicit RealImage(const string& file):
        filename{file} {
        loadFromDisk();
    }

    void display() const override {
        std::println("Displaying image: {}", filename);
    }

private:
    void loadFromDisk() const {
        std::println("Loading image from disk: {}", filename);
    }
};

// Proxy (controls access to RealImage)
class ProxyImage : public Image {
private:
    string filename;
    mutable unique_ptr<RealImage> realImage; // lazily created
public:
    explicit ProxyImage(const string& file):
        filename{file} {}

    void display() const override {
        if (!realImage) {
            std::println("(Proxy) Loading image on demand...");
            realImage = std::make_unique<RealImage>(filename);
        }
        realImage->display();
    }
};

// Client code
int main() {
    Image* img = new ProxyImage("photo.png");

    // First display (should load)
    img->display();

    // Second display (should use cached image)
    img->display();

    delete img;
    return 0;
}
```

### Java

以下Java範例解釋惰性載入模式中的「虛擬代理」方法。`ProxyImage` 類別用來存取遠端方法。

```java
import java.util.*;
 
interface Image {
    public void displayImage();
}

//on System A 
class RealImage implements Image {
    private String filename;
    public RealImage(String filename) { 
        this.filename = filename;
        loadImageFromDisk();
    }

    private void loadImageFromDisk() {
        System.out.println("Loading   " + filename);
    }

    public void displayImage() { 
        System.out.println("Displaying " + filename); 
    }
}

//on System B 
class ProxyImage implements Image {
    private String filename;
    private Image image;
 
    public ProxyImage(String filename) { 
        this.filename = filename; 
    }
    public void displayImage() {
        if(image == null)
              image = new RealImage(filename);
        image.displayImage();
    }
}
 
class ProxyExample {
    public static void main(String[] args) {
        Image image1 = new ProxyImage("HiRes_10MB_Photo1");
        Image image2 = new ProxyImage("HiRes_10MB_Photo2");     
        
        image1.displayImage(); // loading necessary
        image2.displayImage(); // loading necessary
    }
}
```

程式的輸出為：

```output
 Loading    HiRes_10MB_Photo1
 Displaying HiRes_10MB_Photo1
 Loading    HiRes_10MB_Photo2
 Displaying HiRes_10MB_Photo2
```

### C#

C#的例子：

```csharp
using System;

namespace Proxy {
    interface IImage {
        void Display();
    }

    class RealImage : IImage {
        public RealImage(string fileName) {
            FileName = fileName;
            LoadFromFile();
        }

        private void LoadFromFile() {
            Console.WriteLine("Loading " + FileName);
        }

        public String FileName { get; private set; }

        public void Display() {
            Console.WriteLine("Displaying " + FileName);
        }
    }

    class ProxyImage : IImage {
        public ProxyImage(string fileName) {
            FileName = fileName;
        }

        public String FileName { get; private set; }

        private IImage image;

        public void Display() {
            if (image == null)
                image = new RealImage(FileName);
            image.Display();
        }
    }
    class Program {
        static void Main(string[] args) {
            IImage image = new ProxyImage("HiRes_Image");
            for (int i = 0; i < 10; i++)
                image.Display();
        }
    }
}
```

程式的輸出為：

```output
 Loading HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
 Displaying HiRes_Image
```

### Python

下面是Python的上述類似記憶化反向代理的例子：

```python
from abc import ABC, abstractmethod
import functools

class Image(ABC):
    @abstractmethod
    def display(self): pass

@functools.lru_cache(maxsize=2)
class RealImage(Image):
    def __init__(self, filename):
        self.filename = filename
        self.load_from_disk()
    def load_from_disk(self):
        print("Loading    ", self.filename)
    def display(self):
        print("Displaying ", self.filename)

class ProxyImage(Image):
    def __init__(self, filename):
        self.filename = filename
    def display(self):
        RealImage(self.filename).display()

def example():
    image1 = ProxyImage("HiRes_Photo1")
    image2 = ProxyImage("HiRes_Photo2")
    image3 = ProxyImage("HiRes_Photo3")
    image1.display()
    image2.display()
    image3.display()
    image3.display() 
    image2.display()
    image1.display()
```

這裡的標準庫`functools`的`lru_cache`緩存採用了最少最近使用（LRU）緩存替換演算法，緩存的最大大小`maxsize`的預設值為`128`，如果設置其為`None`，這個緩存就等同於沒有大小限制的`cache`緩存，這裡為了演示替換效果而將其設置為很小的`2`。下面其執行：

```pycon
>>> example()
Loading     HiRes_Photo1
Displaying  HiRes_Photo1
Loading     HiRes_Photo2
Displaying  HiRes_Photo2
Loading     HiRes_Photo3
Displaying  HiRes_Photo3
Displaying  HiRes_Photo3
Displaying  HiRes_Photo2
Loading     HiRes_Photo1
Displaying  HiRes_Photo1
```

## 外部連結

- Java 中的代理模式
- UML 和 LePUS3 （一種形式塑模語言）中的代理模式
- 以代理模式掌控大局
- PerfectJPattern 開源計劃，提供 Java 中代理模式的元件實作。