代理模式(Proxy Pattern)的定義:為其他對(duì)象提供一種代理以控制對(duì)這個(gè)對(duì)象的訪問晃财。在某些情況下责球,一個(gè)對(duì)象不適合或者不能直接引用另一個(gè)對(duì)象,而代理對(duì)象可以在客戶端和目標(biāo)對(duì)象之間起到中介的作用。
舉個(gè)例子:
比如國(guó)內(nèi)網(wǎng)絡(luò)無(wú)法直接訪問google等外國(guó)網(wǎng)址雏逾,但是通過訪問可以登陸google的服務(wù)器就可以實(shí)現(xiàn)跨國(guó)訪問嘉裤,具體訪問如下:
1).本機(jī)將網(wǎng)絡(luò)請(qǐng)求發(fā)送給代理服務(wù)器
2).代理服務(wù)器轉(zhuǎn)發(fā)請(qǐng)求給web服務(wù)器
3).web服務(wù)器返回結(jié)果給代理服務(wù)器
4).代理服務(wù)器轉(zhuǎn)發(fā)返回結(jié)果給本機(jī)
從上面的流程來(lái)看,處于轉(zhuǎn)發(fā)的服務(wù)器實(shí)際上就是一個(gè)代理栖博,全權(quán)負(fù)責(zé)用戶的上網(wǎng)行為轉(zhuǎn)發(fā)到實(shí)際的委托服務(wù)器上屑宠。
Java中,代理模式的實(shí)現(xiàn)方式有2種:
- 靜態(tài)代理:代理類的具體實(shí)現(xiàn)在編譯時(shí)就已經(jīng)確定了仇让,編譯完成后是一個(gè)具體的.class文件
- 動(dòng)態(tài)代理:代理類是在JVM運(yùn)行期間才動(dòng)態(tài)生成的典奉。
靜態(tài)代理實(shí)現(xiàn):
由于代理類全權(quán)處理被委托類的方法,所以一般的寫法是通過公共接口規(guī)范代理類和被委托類的實(shí)現(xiàn)丧叽。
public interface ICrossWall {
void visitGoogle();
void visitYoutube();
}
被委托類
//被委托類:web服務(wù)器
public class WebServer implements ICrossWall {
@Override
public void visitGoogle() {
System.out.println("real subject:send http request to visit google");
}
@Override
public void visitYoutube() {
System.out.println("real subject:send http request to visit youtube");
}
}
代理類
//代理類:處于中間的轉(zhuǎn)發(fā)服務(wù)器
public class ProxyServer implements ICrossWall {
//持有具體被委托類實(shí)例
private ICrossWall subject;
public ProxyServer(ICrossWall subject) {
this.subject = subject;
}
@Override
public void visitGoogle() {
System.out.println("proxy:forward http request:google");
subject.visitGoogle();
}
@Override
public void visitYoutube() {
System.out.println("proxy:forward http request:youtube");
subject.visitYoutube();
}
}
本機(jī)訪問
public static void main(String[] args) {
//創(chuàng)建一個(gè)被委托類
ICrossWall webServer = new WebServer();
//創(chuàng)建一個(gè)代理類
ICrossWall proxyServer = new ProxyServer(webServer);
//開始翻墻
proxyServer.visitGoogle();
proxyServer.visitYoutube();
}
運(yùn)行結(jié)果
現(xiàn)在假設(shè)想測(cè)試下看web服務(wù)器訪問網(wǎng)頁(yè)所花費(fèi)的時(shí)間卫玖,那么上面的程序就要進(jìn)行如下修改:
//被委托類:web服務(wù)器
public class WebServer implements ICrossWall {
@Override
public void visitGoogle() {
long startTime = System.nanoTime();
System.out.println("real subject:send http request to visit google");
//模擬訪問時(shí)間
try {
Thread.sleep(130);
} catch (InterruptedException e) {
e.printStackTrace();
}
long endTime = System.nanoTime();
System.out.println("cost:" + (endTime - startTime)/Math.pow(10,6) + "ms");
}
@Override
public void visitYoutube() {
long startTime = System.nanoTime();
System.out.println("real subject:send http request to visit youtube");
//模擬訪問時(shí)間
try {
Thread.sleep(500);
} catch (InterruptedException e) {
e.printStackTrace();
}
long endTime = System.nanoTime();
System.out.println("cost:" + (endTime - startTime)/Math.pow(10,6) + "ms");
}
}
結(jié)果
從上面的代碼中我們可以看出,通過靜態(tài)代理實(shí)現(xiàn)同一附加需求需要在各個(gè)方法中都添加相應(yīng)的邏輯代碼踊淳,上面示例只有2個(gè)方法假瞬,手動(dòng)添加還不算太麻煩,但是如果接口中含有數(shù)十上百個(gè)方法迂尝,手動(dòng)添加的工作量就大大增加了脱茉,并且代碼冗余度也大大增加了。那么垄开,有沒有什么辦法可以優(yōu)化這個(gè)流程呢琴许?答案自然是肯定的,只需通過動(dòng)態(tài)代理動(dòng)態(tài)生成代理類溉躲,然后在該代理類內(nèi)加上相應(yīng)的計(jì)時(shí)邏輯代碼即可榜田,這樣就無(wú)需修改每一個(gè)方法了,而是在調(diào)用相應(yīng)方法的時(shí)候锻梳,會(huì)執(zhí)行這些計(jì)時(shí)邏輯代碼串慰。具體實(shí)現(xiàn)請(qǐng)看后續(xù)部分內(nèi)容。
動(dòng)態(tài)代理實(shí)現(xiàn)
1)接口類:同上
2)被委托類:同上
//被委托類:web服務(wù)器
public class WebServer implements ICrossWall {
@Override
public void visitGoogle() {
System.out.println("real subject:send http request to visit google");
//模擬訪問時(shí)間
try {
Thread.sleep(130);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
@Override
public void visitYoutube() {
System.out.println("real subject:send http request to visit youtube");
//模擬訪問時(shí)間
try {
Thread.sleep(500);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
3)中介類:InvocationHandler
//計(jì)時(shí)攔截器
public static class CostInterceptor implements InvocationHandler{
//具體被委托類
private Object target;
public CostInterceptor(Object target){
this.target = target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
long startTime = System.nanoTime();
//被委托類原始方法執(zhí)行
Object result = method.invoke(target, args);
long endTime = System.nanoTime();
System.out.println("cost:" + (endTime - startTime)/Math.pow(10,6) + "ms");
return result;
}
}
4)調(diào)用
public static void main(String[] args) {
//創(chuàng)建一個(gè)被委托類
ICrossWall webServer = new WebServer();
//創(chuàng)建一個(gè)代理類
ICrossWall dynamicProxy = (ICrossWall)Proxy.newProxyInstance(
ICrossWall.class.getClassLoader(),
webServer.getClass().getInterfaces(),
new CostInterceptor(webServer));
//開始翻墻
dynamicProxy.visitGoogle();
dynamicProxy.visitYoutube();
}
結(jié)果
從上面的動(dòng)態(tài)代理示例可以看到唱蒸,我們通過動(dòng)態(tài)生成的代理類調(diào)用接口方法時(shí)邦鲫,都會(huì)執(zhí)行InvocationHandler內(nèi)部invoke方法,從而讓我們的附加邏輯得以運(yùn)行神汹。
動(dòng)態(tài)代理實(shí)現(xiàn)原理簡(jiǎn)析:
InvocationHandler(中介類)持有一個(gè)被委托類對(duì)象引用庆捺,然后在內(nèi)部invoke方法中對(duì)被委托類相應(yīng)方法進(jìn)行調(diào)用,這個(gè)實(shí)現(xiàn)方式看起來(lái)是不是很熟悉-,這不就是我們上面靜態(tài)代理的實(shí)現(xiàn)方式嗎Fㄎ骸滔以!所以,其實(shí)動(dòng)態(tài)代理可以看成是2個(gè)靜態(tài)代理疊加實(shí)現(xiàn):
1.InvocationHandler是具體被委托類的靜態(tài)代理
2.動(dòng)態(tài)生成的代理是InvocationHandler的代理氓拼,InvocationHandler是具體的被委托類
所以你画,調(diào)用鏈?zhǔn)牵?strong>DynamicProxy.method()--->InvocationHandler.invoke()--->RealSubject.method()
動(dòng)態(tài)代理內(nèi)部實(shí)現(xiàn)原理:
我們可以通過如下方法獲取到動(dòng)態(tài)生成的代理類.class文件抵碟,然后通過反編譯.class文件就可以看到j(luò)ava為我們動(dòng)態(tài)生成的代理類代碼詳情:
/**
* 保存代理類二進(jìn)制源碼
* @param name 動(dòng)態(tài)生成的代理類名稱
* @param classes 接口類(動(dòng)態(tài)代理實(shí)現(xiàn)的接口類:dynamicProxy implements classes)
*/
public static void createProxyClassFile(String name, Class<?>[] classes) {
byte[] data = ProxyGenerator.generateProxyClass(name, classes);
try {
FileOutputStream out = new FileOutputStream(name + ".class");
out.write(data);
out.close();
} catch (Exception e) {
e.printStackTrace();
}
}
調(diào)用一下上述方法:
public static void main(String[] args) {
createProxyClassFile("ProxyICrossWall", new Class[]{ICrossWall.class});
}
生成的ICrossWall的動(dòng)態(tài)代理源碼如下所示:
public final class ProxyICrossWall extends Proxy implements ICrossWall {
private static Method m1;
private static Method m2;
private static Method m4;
private static Method m3;
private static Method m0;
public ProxyICrossWall(InvocationHandler var1) throws {
super(var1);
}
public final boolean equals(Object var1) throws {
try {
return ((Boolean)super.h.invoke(this, m1, new Object[]{var1})).booleanValue();
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
public final String toString() throws {
try {
return (String)super.h.invoke(this, m2, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final void visitYoutube() throws {
try {
super.h.invoke(this, m4, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final void visitGoogle() throws {
try {
super.h.invoke(this, m3, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final int hashCode() throws {
try {
return ((Integer)super.h.invoke(this, m0, (Object[])null)).intValue();
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[]{Class.forName("java.lang.Object")});
m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
m4 = Class.forName("com.example.ProxyDemo$ICrossWall").getMethod("visitYoutube", new Class[0]);
m3 = Class.forName("com.example.ProxyDemo$ICrossWall").getMethod("visitGoogle", new Class[0]);
m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}
可以看出:
- 動(dòng)態(tài)生成的代理類都是繼承自Proxy,并且實(shí)現(xiàn)相應(yīng)接口。
- 調(diào)用動(dòng)態(tài)代理的任何方法最終都會(huì)調(diào)用InvocationHandler.invoke()方法坏匪,包括equals(),toString(),hashCode()等等拟逮。
- 調(diào)用鏈?zhǔn)牵?strong>DynamicProxy.method()--->InvocationHandler.invoke()--->RealSubject.method()
然后,我們看下Proxy的實(shí)現(xiàn):
/**
* Prohibits instantiation.
*/
private Proxy() {
}
/**
* Constructs a new {@code Proxy} instance from a subclass
* (typically, a dynamic proxy class) with the specified value
* for its invocation handler.
*
* @param h the invocation handler for this proxy instance
*
* @throws NullPointerException if the given invocation handler, {@code h},
* is {@code null}.
*/
protected Proxy(InvocationHandler h) {
if (obj == null)
throw new NullPointerException();
this.h = h;
}
可以看到适滓,Proxy的構(gòu)造函數(shù)是private和protected的敦迄,所以Proxy是無(wú)法直接創(chuàng)建的。所以我們動(dòng)態(tài)生成的代理類都是繼承Proxy帶InvocationHandler的有參構(gòu)造函數(shù)凭迹。
public ProxyICrossWall(InvocationHandler var1) throws {
super(var1);
}
而創(chuàng)建的動(dòng)態(tài)代理是通過Proxy.newProxyInstance()方法生成的罚屋,那么我們看下newProxyInstance()源碼(經(jīng)簡(jiǎn)化,方便理解)
/** parameter types of a proxy class constructor */
private static final Class<?>[] constructorParams =
{ InvocationHandler.class };
/**
* a cache of proxy classes
*/
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
/**
* the invocation handler for this proxy instance.
* @serial
*/
protected InvocationHandler h;
/**
* Returns an instance of a proxy class for the specified interfaces
* that dispatches method invocations to the specified invocation
* handler.
**/
@CallerSensitive
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
if (h == null)
throw new NullPointerException();
final Class<?>[] intfs = interfaces.clone();
/*
* Look up or generate the designated proxy class.
*/
Class<?> cl = getProxyClass0(loader, intfs);
/*
* Invoke its constructor with the designated invocation handler.
*/
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
return cons.newInstance(new Object[]{h});
}
}
newProxyInstance會(huì)從getProxyClass0()中得到一個(gè)代理類類實(shí)例(如果代理類之前已經(jīng)創(chuàng)建過嗅绸,那么會(huì)從proxyClassCache緩存中獲取脾猛,否則,則創(chuàng)建一個(gè))鱼鸠,得到代理類類實(shí)例后猛拴,通過反射獲取帶參構(gòu)造函數(shù)對(duì)象并生成代理類實(shí)例。