1. 程式人生 > 其它 >【設計模式】—代理設計模式

【設計模式】—代理設計模式

1. 概述
1.1 結構型模式
結構型模式描述如何將類或物件按某種佈局組成更大的結構。它分為類結構型模式和物件結構型模式,前者採用繼承機制來組織介面和類,後者釆用組合或聚合來組合物件。
由於組合關係或聚合關係比繼承關係耦合度低,滿足“合成複用原則”,所以物件結構型模式比類結構型模式具有更大的靈活性。

結構型模式分為以下 7 種:

代理模式
介面卡模式
裝飾者模式
橋接模式
外觀模式
組合模式
享元模式
1.2 代理模式
由於某些原因需要給某物件提供一個代理以控制對該物件的訪問。這時,訪問物件不適合或者不能直接引用目標物件,代理物件作為訪問物件和目標物件之間的中介。
比如代理商就是生產廠家和顧客中間的代理中介。買家想要買生產廠家生產的產品,就去代理商那兒去買,而不是直接去找生產廠家。

Java中的代理按照代理類生成時機不同又分為靜態代理 和動態代理 。
靜態代理代理類在編譯期就生成,
動態代理代理類則是在Java執行時動態生成。
動態代理又有JDK代理和CGLib代理兩種。

2. 結構
代理(Proxy)模式分為三種角色:

抽象主題(Subject)類: 通過介面或抽象類宣告真實主題和代理物件實現的業務方法。

真實主題(Real Subject)類: 實現了抽象主題中的具體業務,是代理物件所代表的真實物件,是最終要引用的物件。

代理(Proxy)類 : 提供了與真實主題相同的介面,其內部含有對真實主題的引用,它可以訪問、控制或擴充套件真實主題的功能。

3.靜態代理
通過火車站賣票的例子來感受一下靜態代理

【例】火車站賣票
如果要買火車票的話,需要去火車站買票,坐車到火車站,排隊等一系列的操作,顯然比較麻煩。而火車站在多個地方都有代售點,我們去代售點買票就方便很多了。這個例子其實就是典型的代理模式,火車站是目標物件,代售點是代理物件。類圖如下:


程式碼如下:

/**
* 賣票介面,定義賣票規則
*/
public interface SellTickets {
/**
* Sell.
*/
public void sell();
}


/**
* 火車站類,具有賣票功能,所以需要實現介面SellTickets
*/
public class TrainStation implements SellTickets{
public void sell() {
System.out.println("火車站賣票");
}
}


/**
* 代售點,將火車站賣票的功能拿到代售點來,即代售點可以賣出火車票,具有
* 賣票功能,所以需要實現SellTickets介面,同時是代理火車站賣票,即車票
* 與火車站有關聯,表現為具有屬性 “火車站”
*/
public class ProxyPoint implements SellTickets{
private TrainStation station;

public void sell() {
System.out.println("代理點代售火車票,收取一定的代理費");
station.sell();
}
}


/**
* 測試類
*/
public class Client {
public static void main(String[] args) {
ProxyPoint proxyPoint = new ProxyPoint();
proxyPoint.sell();
}
}


分析

從上面程式碼中可以看出測試類直接訪問的是ProxyPoint類物件,也就是說ProxyPoint作為訪問物件和目標物件的中介。同時也對sell方法進行了增強(代理點收取一些服務費用)。

4.JDK動態代理
現在來使用JDK實現上面的例子。Java中提供了一個動態代理類Proxy,Proxy並不是我們上述所說的代理物件的類,而是提供了一個建立代理物件的靜態方法(newProxyInstance方法)來獲取代理物件。

程式碼如下

SellTickets.java

package com.lxg.pattern.proxy.jdk_proxy;

/**
* 賣票介面,定義賣票規則
*/
public interface SellTickets {
/**
* Sell.
*/
public void sell();
}


TrainStation .java

package com.lxg.pattern.proxy.jdk_proxy;

/**
* 火車站類,具有賣票功能,所以需要實現介面SellTickets
*/
public class TrainStation implements SellTickets {
public void sell() {
System.out.println("火車站賣票");
}
}


代理工廠:ProxyFactory.java

package com.lxg.pattern.proxy.jdk_proxy;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

/**
* 代理工廠,用來建立代理物件
*/
public class ProxyFactory {
private TrainStation station = new TrainStation();

/**
* 代理工廠,動態獲取代理物件
* @return
*/
public SellTickets getProxyObject(){

/**
* 呼叫Proxy代理類中的newProxyInstance方法來動態獲取代理物件
* newProxyInstance()方法引數說明:
* ClassLoader loader : 類載入器,用於載入代理類,使用真實物件的類載入器即可
* Class<?>[] interfaces : 真實物件所實現的介面,代理模式真實物件和代理物件實現相同的介面
* InvocationHandler h : 代理物件的呼叫處理程式
*
*/
SellTickets sellTickets = (SellTickets) Proxy.newProxyInstance(
station.getClass().getClassLoader(), //類載入器,用來載入代理類
station.getClass().getInterfaces(),//真實物件實現的介面,代理物件跟真實物件實現同樣的介面
new InvocationHandler() {//匿名內部類中定義代理物件要處理的業務邏輯
/**
*
* @param proxy 代理物件
* @param method 對應於在代理物件上呼叫的介面方法的 Method 例項
* @param args 代理物件呼叫介面方法時傳遞的實際引數
* @return
* @throws Throwable
*/
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;
}
}


測試類

package com.lxg.pattern.proxy.jdk_proxy;

/**
* 測試類
*/
public class Client {
public static void main(String[] args) {
//宣告獲取代理物件的工廠
ProxyFactory factory = new ProxyFactory();
//通過工廠獲取代理物件
SellTickets proxyObject = factory.getProxyObject();
//代理物件執行業務邏輯
proxyObject.sell();
}
}


分析

ProxyFactory是代理類嗎?
ProxyFactory不是代理模式中所說的代理類,而代理類是程式在執行過程中動態的在記憶體中生成的類。通過阿里巴巴開源的 Java 診斷工具(Arthas【阿爾薩斯】)檢視代理類的結構:

package com.sun.proxy;

import com.itheima.proxy.dynamic.jdk.SellTickets;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;

public final class $Proxy0 extends Proxy implements SellTickets {
private static Method m1;
private static Method m2;
private static Method m3;
private static Method m0;

public $Proxy0(InvocationHandler invocationHandler) {
super(invocationHandler);
}

static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
m3 = Class.forName("com.itheima.proxy.dynamic.jdk.SellTickets").getMethod("sell", new Class[0]);
m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
return;
}
catch (NoSuchMethodException noSuchMethodException) {
throw new NoSuchMethodError(noSuchMethodException.getMessage());
}
catch (ClassNotFoundException classNotFoundException) {
throw new NoClassDefFoundError(classNotFoundException.getMessage());
}
}

public final boolean equals(Object object) {
try {
return (Boolean)this.h.invoke(this, m1, new Object[]{object});
}
catch (Error | RuntimeException throwable) {
throw throwable;
}
catch (Throwable throwable) {
throw new UndeclaredThrowableException(throwable);
}
}

public final String toString() {
try {
return (String)this.h.invoke(this, m2, null);
}
catch (Error | RuntimeException throwable) {
throw throwable;
}
catch (Throwable throwable) {
throw new UndeclaredThrowableException(throwable);
}
}

public final int hashCode() {
try {
return (Integer)this.h.invoke(this, m0, null);
}
catch (Error | RuntimeException throwable) {
throw throwable;
}
catch (Throwable throwable) {
throw new UndeclaredThrowableException(throwable);
}
}

public final void sell() {
try {
this.h.invoke(this, m3, null);
return;
}
catch (Error | RuntimeException throwable) {
throw throwable;
}
catch (Throwable throwable) {
throw new UndeclaredThrowableException(throwable);
}
}
}

從上面的類中,我們可以看到以下幾個資訊:

代理類($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]);
}

public final void sell() {
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() {

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();
SellTickets proxyObject = factory.getProxyObject();
proxyObject.sell();
}
}

執行流程如下:

1. 在測試類中通過代理物件呼叫sell()方法
1
2. 根據多型的特性,執行的是代理類($Proxy0)中的sell()方法
3. 代理類($Proxy0)中的sell()方法中又呼叫了InvocationHandler介面的子實現類物件的invoke方法
4. invoke方法通過反射執行了真實物件所屬類(TrainStation)中的sell()方法

5.CGLIB動態代理
現在使用CGLIB代理實現上面的例子。

如果沒有定義SellTickets介面,只定義了TrainStation(火車站類)。很顯然JDK代理是無法使用了,因為JDK動態代理要求必須定義介面,對介面進行代理。

CGLIB是一個功能強大,高效能的程式碼生成包。它為沒有實現介面的類提供代理,為JDK的動態代理提供了很好的補充。

匯入依賴

<dependency>
<groupId>cglib</groupId>
<artifactId>cglib</artifactId>
<version>2.2.2</version>
</dependency>
TrainStation.java

package com.lxg.pattern.proxy.cglib_proxy;
/**
* 火車站類,沒有實現任何介面
*/
public class TrainStation{
public void sell() {

System.out.println("火車站賣票");
}
}

動態代理工廠類ProxyFactory .java

package com.lxg.pattern.proxy.cglib_proxy;

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

/**
* CGLIB代理工廠
*/
public class ProxyFactory implements MethodInterceptor {
private TrainStation target = new TrainStation();

public TrainStation getProxyObject() {
//建立Enhancer物件,類似於JDK動態代理的Proxy類,下一步就是設定幾個引數
Enhancer enhancer =new Enhancer();
//設定父類的位元組碼物件
enhancer.setSuperclass(target.getClass());
//設定回撥函式
enhancer.setCallback(this);
//建立代理物件
TrainStation obj = (TrainStation) enhancer.create();
return obj;
}

public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
System.out.println("代理點收取一些服務費用(CGLIB動態代理方式)");
TrainStation result = (TrainStation) methodProxy.invokeSuper(o, objects);
return result;
}
}

測試類

package com.lxg.pattern.proxy.cglib_proxy;

public class Client {
public static void main(String[] args) {
//建立代理工廠物件
ProxyFactory factory = new ProxyFactory();
//獲取代理物件
TrainStation proxyObject = factory.getProxyObject();

proxyObject.sell();
}
}

6.三種代理的對比
jdk代理和CGLIB代理

使用CGLib實現動態代理,CGLib底層採用ASM位元組碼生成框架,使用位元組碼技術生成代理類,在JDK1.6之前比使用Java反射效率要高。唯一需要注意的是,CGLib不能對宣告為final的類或者方法進行代理,因為CGLib原理是動態生成被代理類的子類。

在JDK1.6、JDK1.7、JDK1.8逐步對JDK動態代理優化之後,在呼叫次數較少的情況下,JDK代理效率高於CGLib代理效率,只有當進行大量呼叫的時候,JDK1.6和JDK1.7比CGLib代理效率低一點,但是到JDK1.8的時候,JDK代理效率高於CGLib代理。所以如果有介面使用JDK動態代理,如果沒有介面使用CGLIB代理。

動態代理和靜態代理

動態代理與靜態代理相比較,最大的好處是介面中宣告的所有方法都被轉移到呼叫處理器一個集中的方法中處理(InvocationHandler.invoke)。這樣,在介面方法數量比較多的時候,我們可以進行靈活處理,而不需要像靜態代理那樣每一個方法進行中轉。

如果介面增加一個方法,靜態代理模式除了所有實現類需要實現這個方法外,所有代理類也需要實現此方法。增加了程式碼維護的複雜度。而動態代理不會出現該問題

7.優缺點
優點:

代理模式在客戶端與目標物件之間起到一箇中介作用和保護目標物件的作用;
代理物件可以擴充套件目標物件的功能;
代理模式能將客戶端與目標物件分離,在一定程度上降低了系統的耦合度;
缺點:

增加了系統的複雜度;
8.使用場景
遠端(Remote)代理

本地服務通過網路請求遠端服務。為了實現本地到遠端的通訊,我們需要實現網路通訊,處理其中可能的異常。為良好的程式碼設計和可維護性,我們將網路通訊部分隱藏起來,只暴露給本地服務一個介面,通過該介面即可訪問遠端服務提供的功能,而不必過多關心通訊部分的細節。

防火牆(Firewall)代理

當你將瀏覽器配置成使用代理功能時,防火牆就將你的瀏覽器的請求轉給網際網路;當網際網路返回響應時,代理伺服器再把它轉給你的瀏覽器。

保護(Protect or Access)代理

控制對一個物件的訪問,如果需要,可以給不同的使用者提供不同級別的使用許可權。