十分鐘理解 Java 中的動(dòng)態(tài)代理
一、概述
1. 什么是代理
我們大家都知道微商代理,簡(jiǎn)單地說(shuō)就是代替廠家賣(mài)商品,廠家“委托”代理為其銷售商品。關(guān)于微商代理,首先我們從他們那里買(mǎi)東西時(shí)通常不知道背后的廠家究竟是誰(shuí),也就是說(shuō),“委托者”對(duì)我們來(lái)說(shuō)是不可見(jiàn)的;其次,微商代理主要以朋友圈的人為目標(biāo)客戶,這就相當(dāng)于為廠家做了一次對(duì)客戶群體的“過(guò)濾”。我們把微商代理和廠家進(jìn)一步抽象,前者可抽象為代理類,后者可抽象為委托類(被代理類)。通過(guò)使用代理,通常有兩個(gè)優(yōu)點(diǎn),并且能夠分別與我們提到的微商代理的兩個(gè)特點(diǎn)對(duì)應(yīng)起來(lái):
優(yōu)點(diǎn)一:可以隱藏委托類的實(shí)現(xiàn);
優(yōu)點(diǎn)二:可以實(shí)現(xiàn)客戶與委托類間的解耦,在不修改委托類代碼的情況下能夠做一些額外的處理。
2. 靜態(tài)代理
若代理類在程序運(yùn)行前就已經(jīng)存在,那么這種代理方式被成為 靜態(tài)代理 ,這種情況下的代理類通常都是我們?cè)贘ava代碼中定義的。 通常情況下, 靜態(tài)代理中的代理類和委托類會(huì)實(shí)現(xiàn)同一接口或是派生自相同的父類。 下面我們用Vendor類代表生產(chǎn)廠家,BusinessAgent類代表微商代理,來(lái)介紹下靜態(tài)代理的簡(jiǎn)單實(shí)現(xiàn),委托類和代理類都實(shí)現(xiàn)了Sell接口,Sell接口的定義如下:
- public interface Sell { void sell(); void ad();
- }
Vendor類的定義如下:
- public class Vendor implements Sell { public void sell() {
- System.out.println("In sell method");
- } public void ad() {
- System,out.println("ad method")
- }
- }
代理類BusinessAgent的定義如下:
- public class Vendor implements Sell { public void sell() {
- System.out.println("In sell method");
- } public void ad() {
- System,out.println("ad method")
- }
- }
從BusinessAgent類的定義我們可以了解到,靜態(tài)代理可以通過(guò)聚合來(lái)實(shí)現(xiàn),讓代理類持有一個(gè)委托類的引用即可。
下面我們考慮一下這個(gè)需求:給Vendor類增加一個(gè)過(guò)濾功能,只賣(mài)貨給大學(xué)生。通過(guò)靜態(tài)代理,我們無(wú)需修改Vendor類的代碼就可以實(shí)現(xiàn),只需在BusinessAgent類中的sell方法中添加一個(gè)判斷即可如下所示:
- public class BusinessAgent implements Sell {
- ...
- public void sell() {
- if (isCollegeStudent()) {
- vendor.sell();
- }
- }
- ...
- }
這對(duì)應(yīng)著我們上面提到的使用代理的第二個(gè)優(yōu)點(diǎn):可以實(shí)現(xiàn)客戶與委托類間的解耦,在不修改委托類代碼的情況下能夠做一些額外的處理。靜態(tài)代理的局限在于運(yùn)行前必須編寫(xiě)好代理類,下面我們重點(diǎn)來(lái)介紹下運(yùn)行時(shí)生成代理類的動(dòng)態(tài)代理方式。
二、動(dòng)態(tài)代理
1. 什么是動(dòng)態(tài)代理
代理類在程序運(yùn)行時(shí)創(chuàng)建的代理方式被成為 動(dòng)態(tài)代理。 也就是說(shuō),這種情況下,代理類并不是在Java代碼中定義的,而是在運(yùn)行時(shí)根據(jù)我們?cè)贘ava代碼中的“指示”動(dòng)態(tài)生成的。相比于靜態(tài)代理, 動(dòng)態(tài)代理的優(yōu)勢(shì)在于可以很方便的對(duì)代理類的函數(shù)進(jìn)行統(tǒng)一的處理,而不用修改每個(gè)代理類的函數(shù)。 這么說(shuō)比較抽象,下面我們結(jié)合一個(gè)實(shí)例來(lái)介紹一下動(dòng)態(tài)代理的這個(gè)優(yōu)勢(shì)是怎么體現(xiàn)的。
現(xiàn)在,假設(shè)我們要實(shí)現(xiàn)這樣一個(gè)需求:在執(zhí)行委托類中的方法之前輸出“before”,在執(zhí)行完畢后輸出“after”。我們還是以上面例子中的Vendor類作為委托類,BusinessAgent類作為代理類來(lái)進(jìn)行介紹。首先我們來(lái)使用靜態(tài)代理來(lái)實(shí)現(xiàn)這一需求,相關(guān)代碼如下:
- public class BusinessAgent implements Sell {
- private Vendor mVendor;
- public BusinessAgent(Vendor vendor) {
- this.mVendor = vendor;
- }
- public void sell() {
- System.out.println("before");
- mVendor.sell();
- System.out.println("after");
- }
- public void ad() {
- System.out.println("before");
- mVendor.ad();
- System.out.println("after");
- }
- }
從以上代碼中我們可以了解到,通過(guò)靜態(tài)代理實(shí)現(xiàn)我們的需求需要我們?cè)诿總€(gè)方法中都添加相應(yīng)的邏輯,這里只存在兩個(gè)方法所以工作量還不算大,假如Sell接口中包含上百個(gè)方法呢?這時(shí)候使用靜態(tài)代理就會(huì)編寫(xiě)許多冗余代碼。通過(guò)使用動(dòng)態(tài)代理,我們可以做一個(gè)“統(tǒng)一指示”,從而對(duì)所有代理類的方法進(jìn)行統(tǒng)一處理,而不用逐一修改每個(gè)方法。下面我們來(lái)具體介紹下如何使用動(dòng)態(tài)代理方式實(shí)現(xiàn)我們的需求。
2. 使用動(dòng)態(tài)代理
(1)InvocationHandler接口
在使用動(dòng)態(tài)代理時(shí),我們需要定義一個(gè)位于代理類與委托類之間的中介類,這個(gè)中介類被要求實(shí)現(xiàn)InvocationHandler接口,這個(gè)接口的定義如下:
- public interface InvocationHandler {
- Object invoke(Object proxy, Method method, Object[] args);
- }
從InvocationHandler這個(gè)名稱我們就可以知道,實(shí)現(xiàn)了這個(gè)接口的中介類用做“調(diào)用處理器”。當(dāng)我們調(diào)用代理類對(duì)象的方法時(shí),這個(gè)“調(diào)用”會(huì)轉(zhuǎn)送到invoke方法中,代理類對(duì)象作為proxy參數(shù)傳入,參數(shù)method標(biāo)識(shí)了我們具體調(diào)用的是代理類的哪個(gè)方法,args為這個(gè)方法的參數(shù)。這樣一來(lái),我們對(duì)代理類中的所有方法的調(diào)用都會(huì)變?yōu)閷?duì)invoke的調(diào)用,這樣我們可以在invoke方法中添加統(tǒng)一的處理邏輯(也可以根據(jù)method參數(shù)對(duì)不同的代理類方法做不同的處理)。因此我們只需在中介類的invoke方法實(shí)現(xiàn)中輸出“before”,然后調(diào)用委托類的invoke方法,再輸出“after”。下面我們來(lái)一步一步具體實(shí)現(xiàn)它。
(2)委托類的定義
動(dòng)態(tài)代理方式下,要求委托類必須實(shí)現(xiàn)某個(gè)接口,這里我們實(shí)現(xiàn)的是Sell接口。委托類Vendor類的定義如下:
- public class Vendor implements Sell {
- public void sell() {
- System.out.println("In sell method");
- }
- public void ad() {
- System,out.println("ad method")
- }
- }
(3)中介類
上面我們提到過(guò),中介類必須實(shí)現(xiàn)InvocationHandler接口,作為調(diào)用處理器”攔截“對(duì)代理類方法的調(diào)用。中介類的定義如下:
- public class DynamicProxy implements InvocationHandler {
- private Object obj; //obj為委托類對(duì)象;
- public DynamicProxy(Object obj) {
- this.obj = obj;
- }
- @Override
- public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
- System.out.println("before");
- Object result = method.invoke(obj, args);
- System.out.println("after");
- return result;
- }
- }
從以上代碼中我們可以看到,中介類持有一個(gè)委托類對(duì)象引用,在invoke方法中調(diào)用了委托類對(duì)象的相應(yīng)方法(第11行),看到這里是不是覺(jué)得似曾相識(shí)?通過(guò)聚合方式持有委托類對(duì)象引用,把外部對(duì)invoke的調(diào)用最終都轉(zhuǎn)為對(duì)委托類對(duì)象的調(diào)用。這不就是我們上面介紹的靜態(tài)代理的一種實(shí)現(xiàn)方式嗎?實(shí)際上,中介類與委托類構(gòu)成了靜態(tài)代理關(guān)系,在這個(gè)關(guān)系中,中介類是代理類,委托類就是委托類; 代理類與中介類也構(gòu)成一個(gè)靜態(tài)代理關(guān)系,在這個(gè)關(guān)系中,中介類是委托類,代理類是代理類。也就是說(shuō),動(dòng)態(tài)代理關(guān)系由兩組靜態(tài)代理關(guān)系組成,這就是動(dòng)態(tài)代理的原理。下面我們來(lái)介紹一下如何”指示“以動(dòng)態(tài)生成代理類。
(4)動(dòng)態(tài)生成代理類
動(dòng)態(tài)生成代理類的相關(guān)代碼如下:
- public class Main {
- public static void main(String[] args) {
- //創(chuàng)建中介類實(shí)例
- DynamicProxy inter = new DynamicProxy(new Vendor());
- //加上這句將會(huì)產(chǎn)生一個(gè)$Proxy0.class文件,這個(gè)文件即為動(dòng)態(tài)生成的代理類文件
- System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");
- //獲取代理類實(shí)例sell
- Sell sell = (Sell)(Proxy.newProxyInstance(Sell.class.getClassLoader(), new Class[] {Sell.class}, inter));
- //通過(guò)代理類對(duì)象調(diào)用代理類方法,實(shí)際上會(huì)轉(zhuǎn)到invoke方法調(diào)用
- sell.sell();
- sell.ad();
- }
- }
在以上代碼中,我們調(diào)用Proxy類的newProxyInstance方法來(lái)獲取一個(gè)代理類實(shí)例。這個(gè)代理類實(shí)現(xiàn)了我們指定的接口并且會(huì)把方法調(diào)用分發(fā)到指定的調(diào)用處理器。這個(gè)方法的聲明如下:
- public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) throws IllegalArgumentException
方法的三個(gè)參數(shù)含義分別如下:
loader:定義了代理類的ClassLoder;
interfaces:代理類實(shí)現(xiàn)的接口列表
h:調(diào)用處理器,也就是我們上面定義的實(shí)現(xiàn)了InvocationHandler接口的類實(shí)例
我們運(yùn)行一下,看看我們的動(dòng)態(tài)代理是否能正常工作。我這里運(yùn)行后的輸出為:
說(shuō)明我們的動(dòng)態(tài)代理確實(shí)奏效了。
上面我們已經(jīng)簡(jiǎn)單提到過(guò)動(dòng)態(tài)代理的原理,這里再簡(jiǎn)單的總結(jié)下:首先通過(guò)newProxyInstance方法獲取代理類實(shí)例,而后我們便可以通過(guò)這個(gè)代理類實(shí)例調(diào)用代理類的方法,對(duì)代理類的方法的調(diào)用實(shí)際上都會(huì)調(diào)用中介類(調(diào)用處理器)的invoke方法,在invoke方法中我們調(diào)用委托類的相應(yīng)方法,并且可以添加自己的處理邏輯。