初識設計模式 - 代理模式 - ⎝⎛CodingNote.cc ⎞⎠

初識設計模式 – 代理模式

2022 年 9 月 26 日
筆記
程式設計, 設計模式, 面向對象

簡介

概念

舉個簡單的例說明代理模式就是：假如現在需要買一輛二手車，可以自己去找車源、做品質檢測等一系列車輛過戶的流程，但是這實在太浪費時間和精力了，其實可以通過找中介的方式，同樣會找車源、做品質檢測等一系列車輛過戶的流程，但是這樣自己就只需要選車、付錢即可。

功能分類

遠程代理

遠程代理是一種常見的代理模式，遠程代理對象承擔了大部分的網路通訊工作，使得客戶端程式可以訪問在遠程主機上的對象。

對於客戶端而言，無需關心實現具體業務的是誰，只需要按照服務介面所定義的方法直接與本地主機中的代理對象交互即可。

在 Java 語言中，可以通過 RMI(Remote Method Invocation, 遠程方法調用) 機制來實現遠程代理。程式碼示例如下：

服務端部分代理

import java.net.MalformedURLException;
import java.rmi.Naming;
import java.rmi.Remote;
import java.rmi.RemoteException;
import java.rmi.registry.LocateRegistry;
import java.rmi.server.UnicastRemoteObject;

// 遠程介面
public interface IMyRemote extends Remote {
    String SayHello() throws RemoteException;
}

// 遠程介面實現 - 遠程對象
public class MyRemoteImpl extends UnicastRemoteObject implements IMyRemote {
    public MyRemoteImpl() throws RemoteException {
        super();
    }

    @Override
    public String SayHello() throws RemoteException {
        return "Server says, 'Hey'";
    }

    public static void main(String[] args) throws RemoteException, MalformedURLException {
        IMyRemote service = new MyRemoteImpl();
        // 啟動本地 RMI 服務，默認埠是 1099
        LocateRegistry.createRegistry(1099);
        // 註冊遠程對象
        Naming.rebind("rmi://localhost:1099/RemoteHello", service);
    }
}

客戶端部分代理

import java.net.MalformedURLException;
import java.rmi.Naming;
import java.rmi.NotBoundException;
import java.rmi.RemoteException;

public class MyRemoteClient {
    private void go() throws RemoteException, NotBoundException, MalformedURLException {
        IMyRemote service = (IMyRemote) Naming.lookup("rmi://localhost:1099/RemoteHello");
        System.out.println(service.sayHello());
    }

    public static void main(String[] args) throws RemoteException, NotBoundException, MalformedURLException {
        new MyRemoteClients().go();
    }
}

虛擬代理

虛擬代理會在真實對象創建成功之前扮演其替身，而當真實對象創建成功之後，虛擬代理再將用戶的請求轉發給真實對象。

使用虛擬代理的場景非常容易理解，主要有以下兩種：

由於對象本身的複雜性或者網路等原因導致一個對象需要較長的載入時間，此時可以用一個載入時間相對較短的代理對象來代表真實對象，通常在實現時結合多執行緒使用
當一個對象的載入十分耗費系統資源的時候，也非常適合使用虛擬代理

具體實現

代理模式的具體實現從運行時的角度可以分成兩種：一種是靜態代理，即在程式碼運行之前就已經確定好代理關係；另一種是動態代理，可以在程式碼運行時才決定如何實現代理關係。

靜態代理

靜態代理是比較好理解的實現方式，在這種實現方式中，代理類所實現的介面和所代理的方法都被固定，需要在編譯期就預先對原始類編寫代理類。

基於介面

一般情況下，參考基於介面而非實現編程的設計思想，為了讓程式碼的改動盡量少，代理類和原始類應該實現同樣的介面。

如下是使用圖片展示作為例子的程式碼示例：

圖片 Image 介面：描述圖片具有的行為

public interface Image {
    void display();
}

展示圖片 ShowImage 類：實際的圖片原始類

public class ShowImage implements Image {
    public ShowImage() {}

    @Override
    public void display() {
        System.out.println("ShowImage display!");
    }
}

代理圖片 ProxyImage 類：在真實圖片前包裝一層的代理類

public class ProxyImage implements Image {
    // 通過依賴注入的方式
    private ShowImage showImage;

    public ProxyImage(ShowImage showImage) {
        this.showImage = showImage;
    }

    @Override
    public void display() {
        System.out.println("ProxyImage display start!");
        this.showImage.display();
        System.out.println("ProxyImage display end!");
    }
}

基於繼承

如果原始類並沒有實現介面，並且原始類程式碼由其他人開發維護，可以通過代理類繼承原始類的方法來實現代理模式。

假設上述展示圖片 ShowImage 類沒有實現介面，可以重新定義代理圖片 ProxyImage 類如下：

public class ProxyImage extends ShowImage {
    public ProxyImage() {}

    @Override
    public void display() {
        System.out.println("ProxyImage display start!");
        super.display();
        System.out.println("ProxyImage display end!");
    }
}

動態代理

靜態代理需要針對每個類都創建一個代理類，並且每個代理類中的程式碼都有點像模板式的「重複」程式碼，增加了開發成本和維護成本。

對於靜態代理存在的問題，可以通過動態代理來解決。

動態代理的原理是：不事先為每個原始類編寫代理類，而是在程式碼運行的時候動態地創建原始類對應的代理類，然後在系統中用代理類替換掉原始類。

在 Java 中，主要就是利用反射機制在運行時創建代理類。程式碼示例如下：

// 定義介面，描述行為
public interface Subject {
    void hello(String param);
}

// 實現介面
public class SubjectImpl implements Subject {
    public SubjectImpl() {}

    @Override
    public void hello(String param) {
        System.out.println("hello " + param);
    }
}

// 創建代理類
public class SubjectProxy implements InvocationHandler {
    private Subject subject;

    public SubjectProxy(Subject subject) {
        this.subject = subject;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("----- Start -----");
        Object invoke = method.invoke(subject, args);
        System.out.println("----- End -----");
        return invoke;
    }
}

// 實際調用
public class Main {
    public static void main(String[] args) {
        Subject subject = new SubjectImpl();
        InvocationHandler subjectProxy = new SubjectProxy(subject);
        // 代理類的類載入器
        // 被代理類的介面，如果有多個就是以數組形式傳入
        // 代理類實例
        Subject proxyInstance = (Subject) Proxy.newProxyInstance(
                subjectProxy.getClass().getClassLoader(),
                subject.getClass().getInterfaces(),
                subjectProxy
        );
        // 執行代理方法
        proxyInstance.hello("world");
    }
}

常見的 Java 動態代理實現方式有 JDK 代理、CGLib 代理。基於 JDK 的動態代理必須實現一個介面，而 CGLib 動態代理沒有這個限制，是另一種不錯的選擇。

總結

優點

代理模式的主要優點如下：

協調調用者和被調用者，在一定程度上降低了系統的耦合，滿足迪米特原則
客戶端可以針對抽象主題角色進行編程，增加和更換代理類無需修改源程式碼，符合開閉原則
公共的事務由代理來完成，使得真實處理的業務更加純粹，不再去關注公共業務，而公共業務發生擴展時也變得更加集中和方便

缺點

代理模式的主要缺點如下：

在客戶端和真實主題之間增加代理對象，有些類型的代理模式可能會造成請求的處理速度變慢
實現代理模式需要額外的成本，有些代理模式的實現非常複雜

適用場景

代理模式的適用場景如下：

當客戶端對象需要訪問遠程主機中的對象時，可以使用遠程代理
當需要用一個消耗資源較少的對象來代表一個消耗資源較多的對象時，可以使用虛擬代理
當需要控制一個對象的訪問，為不同用戶提供不同級別的的訪問許可權時，可以使用保護代理
當需要為某一個被頻繁訪問的操作結果提供一個臨時存儲空間，以供多個客戶端共享訪問這些結果時，可以使用緩衝代理
當需要為一個對象的訪問（引用）提供一些額外的操作時，可以使用智慧引用代理

源碼

在 JDK 中，提供了 java.lang.reflect.Proxy 支援創建動態代理類。

Tags: 程式設計設計模式面向對象