這系列相關博客,參考 設計模式之美
前面幾節,我們學習了設計模式中的創建型模式。創建型模式主要解決對象的創建問題,封裝複雜的創建過程,解耦對象的創建代碼和使用代碼。
其中,單例模式用來創建全局唯一的對象。工廠模式用來創建不同但是相關類型的對象(繼承同一父類或者接口的一組子類),由給定的參數來決定創建哪種類型的對象。建造者模式是用來創建複雜對象,可以通過設置不同的可選參數,“定製化”地創建不同的對象。原型模式針對創建成本比較大的對象,利用對已有對象進行復制的方式進行創建,以達到節省創建時間的目的。
從今天起,我們開始學習另外一種類型的設計模式:結構型模式。結構型模式主要總結了一些類或對象組合在一起的經典結構,這些經典的結構可以解決特定應用場景的問題。結構型模式包括:代理模式、橋接模式、裝飾器模式、適配器模式、門面模式、組合模式、享元模式。今天我們要講其中的代理模式。它也是在實際開發中經常被用到的一種設計模式。
話不多說,讓我們正式開始今天的學習吧!
代理模式的原理解析
**代理模式(Proxy Design Pattern)**的原理和代碼實現都不難掌握。它在不改變原始類(或叫被代理類)代碼的情況下,通過引入代理類來給原始類附加功能。我們通過一個簡單的例子來解釋一下這段話。
這個例子來自我們在第 25、26、39、40 節中講的性能計數器。當時我們開發了一個MetricsCollector 類,用來收集接口請求的原始數據,比如訪問時間、處理時長等。在業務系統中,我們採用如下方式來使用這個 MetricsCollector 類:
public class UserController {
//...省略其他屬性和方法...
private MetricsCollector metricsCollector; // 依賴注入
public UserVo login(String telephone, String password) {
long startTimestamp = System.currentTimeMillis();
// ... 省略login邏輯...
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
RequestInfo requestInfo = new RequestInfo("login", responseTime, startTi
metricsCollector.recordRequest(requestInfo);
//...返回UserVo數據...
}
public UserVo register(String telephone, String password) {
long startTimestamp = System.currentTimeMillis();
// ... 省略register邏輯...
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
RequestInfo requestInfo = new RequestInfo("register", responseTime, star
metricsCollector.recordRequest(requestInfo);
//...返回UserVo數據...
}
}
很明顯,上面的寫法有兩個問題。第一,性能計數器框架代碼侵入到業務代碼中,跟業務代碼高度耦合。如果未來需要替換這個框架,那替換的成本會比較大。第二,收集接口請求的代碼跟業務代碼無關,本就不應該放到一個類中。業務類最好職責更加單一,只聚焦業務處理。
爲了將框架代碼和業務代碼解耦,代理模式就派上用場了。代理類UserControllerProxy 和原始類 UserController 實現相同的接口 IUserController。UserController 類只負責業務功能。代理類 UserControllerProxy 負責在業務代碼執行前後附加其他邏輯代碼,並通過委託的方式調用原始類來執行業務代碼。具體的代碼實現如下所示:
public interface IUserController {
UserVo login(String telephone, String password);
UserVo register(String telephone, String password);
}
public class UserController implements IUserController {
//...省略其他屬性和方法...
@Override
public UserVo login(String telephone, String password) {
//...省略login邏輯...
//...返回UserVo數據...
}
@Override
public UserVo register(String telephone, String password) {
//...省略register邏輯...
//...返回UserVo數據...
}
}
public class UserControllerProxy implements IUserController {
private MetricsCollector metricsCollector;
private UserController userController;
public UserControllerProxy(UserController userController) {
this.userController = userController;
this.metricsCollector = new MetricsCollector();
}
@Override
public UserVo login(String telephone, String password) {
long startTimestamp = System.currentTimeMillis();
// 委託
UserVo userVo = userController.login(telephone, password);
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
RequestInfo requestInfo = new RequestInfo("login", responseTime, startTi
metricsCollector.recordRequest(requestInfo);
return userVo;
}
@Override
public UserVo register(String telephone, String password) {
long startTimestamp = System.currentTimeMillis();
UserVo userVo = userController.register(telephone, password);
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
RequestInfo requestInfo = new RequestInfo("register", responseTime, star
metricsCollector.recordRequest(requestInfo);
return userVo;
}
}
//UserControllerProxy使用舉例
//因爲原始類和代理類實現相同的接口,是基於接口而非實現編程
//將UserController類對象替換爲UserControllerProxy類對象,不需要改動太多代碼
IUserController userController = new UserControllerProxy(new UserController(
參照基於接口而非實現編程的設計思想,將原始類對象替換爲代理類對象的時候,爲了讓代碼改動儘量少,在剛剛的代理模式的代碼實現中,代理類和原始類需要實現相同的接口。但是,如果原始類並沒有定義接口,並且原始類代碼並不是我們開發維護的(比如它來自一個第三方的類庫),我們也沒辦法直接修改原始類,給它重新定義一個接口。在這種情況下,我們該如何實現代理模式呢?
對於這種外部類的擴展,我們一般都是採用繼承的方式。這裏也不例外。我們讓代理類繼承原始類,然後擴展附加功能。原理很簡單,不需要過多解釋,你直接看代碼就能明白。具體代碼如下所示:
public class UserControllerProxy extends UserController {
private MetricsCollector metricsCollector;
public UserControllerProxy() {
this.metricsCollector = new MetricsCollector();
}
public UserVo login(String telephone, String password) {
long startTimestamp = System.currentTimeMillis();
UserVo userVo = super.login(telephone, password);
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
RequestInfo requestInfo = new RequestInfo("login", responseTime, startTi
metricsCollector.recordRequest(requestInfo);
return userVo;
}
public UserVo register(String telephone, String password) {
long startTimestamp = System.currentTimeMillis();
UserVo userVo = super.register(telephone, password);
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
RequestInfo requestInfo = new RequestInfo("register", responseTime, star
metricsCollector.recordRequest(requestInfo);
return userVo;
}
}
//UserControllerProxy使用舉例
UserController userController = new UserControllerProxy();
動態代理的原理解析
不過,剛剛的代碼實現還是有點問題。一方面,我們需要在代理類中,將原始類中的所有的方法,都重新實現一遍,並且爲每個方法都附加相似的代碼邏輯。另一方面,如果要添加的附加功能的類有不止一個,我們需要針對每個類都創建一個代理類。
如果有 50 個要添加附加功能的原始類,那我們就要創建 50 個對應的代理類。這會導致項目中類的個數成倍增加,增加了代碼維護成本。並且,每個代理類中的代碼都有點像模板式的“重複”代碼,也增加了不必要的開發成本。那這個問題怎麼解決呢?
我們可以使用動態代理來解決這個問題。所謂動態代理(Dynamic Proxy),就是我們不事先爲每個原始類編寫代理類,而是在運行的時候,動態地創建原始類對應的代理類,然後在系統中用代理類替換掉原始類。那如何實現動態代理呢?
如果你熟悉的是 Java 語言,實現動態代理就是件很簡單的事情。因爲 Java 語言本身就已經提供了動態代理的語法(實際上,動態代理底層依賴的就是 Java 的反射語法)。我們來看一下,如何用 Java 的動態代理來實現剛剛的功能。具體的代碼如下所示。其中,MetricsCollectorProxy 作爲一個動態代理類,動態地給每個需要收集接口請求信息的類創建代理類。
public class MetricsCollectorProxy {
private MetricsCollector metricsCollector;
public MetricsCollectorProxy() {
this.metricsCollector = new MetricsCollector();
}
public Object createProxy(Object proxiedObject) {
Class<?>[] interfaces = proxiedObject.getClass().getInterfaces();
DynamicProxyHandler handler = new DynamicProxyHandler(proxiedObject);
return Proxy.newProxyInstance(proxiedObject.getClass().getClassLoader(),
}
private class DynamicProxyHandler implements InvocationHandler {
private Object proxiedObject;
public DynamicProxyHandler(Object proxiedObject) {
this.proxiedObject = proxiedObject;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws
long startTimestamp = System.currentTimeMillis();
Object result = method.invoke(proxiedObject, args);
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
String apiName = proxiedObject.getClass().getName() + ":" + method.get
RequestInfo requestInfo = new RequestInfo(apiName, responseTime, start
metricsCollector.recordRequest(requestInfo);
return result;
}
}
}
//MetricsCollectorProxy使用舉例
MetricsCollectorProxy proxy = new MetricsCollectorProxy();
IUserController userController = (IUserController) proxy.createProxy(new Use
實際上,Spring AOP 底層的實現原理就是基於動態代理。用戶配置好需要給哪些類創建代理,並定義好在執行原始類的業務代碼前後執行哪些附加功能。Spring 爲這些類創建動態代理對象,並在 JVM 中替代原始類對象。原本在代碼中執行的原始類的方法,被換作執行代理類的方法,也就實現了給原始類添加附加功能的目的。
代理模式的應用場景
代理模式的應用場景非常多,我這裏列舉一些比較常見的用法,希望你能舉一反三地應用在你的項目開發中。
1. 業務系統的非功能性需求開發
代理模式最常用的一個應用場景就是,在業務系統中開發一些非功能性需求,比如:監控、統計、鑑權、限流、事務、冪等、日誌。我們將這些附加功能與業務功能解耦,放到代理類中統一處理,讓程序員只需要關注業務方面的開發。實際上,前面舉的蒐集接口請求信息的例子,就是這個應用場景的一個典型例子。
如果你熟悉 Java 語言和 Spring 開發框架,這部分工作都是可以在 Spring AOP 切面中完成的。前面我們也提到,Spring AOP 底層的實現原理就是基於動態代理。
2. 代理模式在 RPC、緩存中的應用
實際上,RPC 框架也可以看作一種代理模式,GoF 的《設計模式》一書中把它稱作遠程代理。通過遠程代理,將網絡通信、數據編解碼等細節隱藏起來。客戶端在使用 RPC 服務的時候,就像使用本地函數一樣,無需瞭解跟服務器交互的細節。除此之外,RPC 服務的開發者也只需要開發業務邏輯,就像開發本地使用的函數一樣,不需要關注跟客戶端的交互細節。
關於遠程代理的代碼示例,我自己實現了一個簡單的 RPC 框架 Demo,放到了 GitHub中,你可以點擊這裏的鏈接查看。
我們再來看代理模式在緩存中的應用。假設我們要開發一個接口請求的緩存功能,對於某些接口請求,如果入參相同,在設定的過期時間內,直接返回緩存結果,而不用重新進行邏輯處理。比如,針對獲取用戶個人信息的需求,我們可以開發兩個接口,一個支持緩存,一個支持實時查詢。對於需要實時數據的需求,我們讓其調用實時查詢接口,對於不需要實時數據的需求,我們讓其調用支持緩存的接口。那如何來實現接口請求的緩存功能呢?
最簡單的實現方法就是剛剛我們講到的,給每個需要支持緩存的查詢需求都開發兩個不同的接口,一個支持緩存,一個支持實時查詢。但是,這樣做顯然增加了開發成本,而且會讓代碼看起來非常臃腫(接口個數成倍增加),也不方便緩存接口的集中管理(增加、刪除緩存接口)、集中配置(比如配置每個接口緩存過期時間)。
針對這些問題,代理模式就能派上用場了,確切地說,應該是動態代理。如果是基於Spring 框架來開發的話,那就可以在 AOP 切面中完成接口緩存的功能。在應用啓動的時候,我們從配置文件中加載需要支持緩存的接口,以及相應的緩存策略(比如過期時間)等。當請求到來的時候,我們在 AOP 切面中攔截請求,如果請求中帶有支持緩存的字段(比如 http://…?..&cached=true),我們便從緩存(內存緩存或者 Redis 緩存等)中獲取數據直接返回。
重點回顧
好了,今天的內容到此就講完了。我們一塊來總結回顧一下,你需要掌握的重點內容。
1. 代理模式的原理與實現
在不改變原始類(或叫被代理類)的情況下,通過引入代理類來給原始類附加功能。一般情況下,我們讓代理類和原始類實現同樣的接口。但是,如果原始類並沒有定義接口,並且原始類代碼並不是我們開發維護的。在這種情況下,我們可以通過讓代理類繼承原始類的方法來實現代理模式。
2. 動態代理的原理與實現
靜態代理需要針對每個類都創建一個代理類,並且每個代理類中的代碼都有點像模板式的“重複”代碼,增加了維護成本和開發成本。對於靜態代理存在的問題,我們可以通過動態代理來解決。我們不事先爲每個原始類編寫代理類,而是在運行的時候動態地創建原始類對應的代理類,然後在系統中用代理類替換掉原始類。
3. 代理模式的應用場景
代理模式常用在業務系統中開發一些非功能性需求,比如:監控、統計、鑑權、限流、事務、冪等、日誌。我們將這些附加功能與業務功能解耦,放到代理類統一處理,讓程序員只需要關注業務方面的開發。除此之外,代理模式還可以用在 RPC、緩存等應用場景中。
課堂討論
- 除了 Java 語言之外,在你熟悉的其他語言中,如何實現動態代理呢?
- 我們今天講了兩種代理模式的實現方法,一種是基於組合,一種基於繼承,請對比一下兩者的優缺點。