主目錄見:Android高級進(jìn)階知識(shí)(這是總目錄索引)
?今天要講這個(gè)代理設(shè)計(jì)模式,真的是印象深刻忍饰,在好多年前在學(xué)校接觸java的時(shí)候就對這個(gè)模式了解過贪嫂,當(dāng)初還想著Spring里面的AOP機(jī)制是不是就是用代理實(shí)現(xiàn)的呀。到現(xiàn)在插件化的hook大量用到代理設(shè)計(jì)模式艾蓝。包括等會(huì)要講的retrofit也是用到了代理設(shè)計(jì)模式力崇。而且Framework的AIDL里面也是用到了代理模式。這些個(gè)例子足以證明了你學(xué)這個(gè)設(shè)計(jì)模式的理由赢织,不需要我去調(diào)動(dòng)大家亮靴,我們先來看看代理模式的定義:
代理模式:為其他對象提供一種代理以控制這個(gè)對象的訪問。
這個(gè)定義簡單明顯呀于置,就是說不直接訪問對象茧吊,而是建一個(gè)代理或者說是中間人去訪問他,而且這個(gè)代理可以選擇多帶禮物,說祝福等等增強(qiáng)的行為和服務(wù)饱狂。接著我們看下UML類圖:
角色介紹:
- Subject:抽象主題曹步,聲明代理主題和真實(shí)主題的接口;
- Proxy:代理主題休讳,因?yàn)镻roxy引用了RealSubject,并且實(shí)現(xiàn)了跟RealSubject一樣的接口,所以ProxySubject可以操作RealSubject,還可以提供一些附加操作,例如before & after讲婚;
- RealSubject:真實(shí)主題,真實(shí)的對象,需要被代理主題引用俊柔。
一.目標(biāo)
今天講這個(gè)設(shè)計(jì)模式也是為了后面插件化和熱更新做個(gè)準(zhǔn)備筹麸,同時(shí)我們還能在必要時(shí)候派上用場,特別是retrofit的源碼和使用雏婶,這個(gè)待會(huì)就會(huì)講了物赶。所以今天的目標(biāo)是:
1.學(xué)會(huì)幾種代理設(shè)計(jì)模式怎么使用;
2.學(xué)會(huì)在不同的場景中應(yīng)用代理模式留晚。
二.模式講解
今天我們也來假設(shè)一個(gè)場景酵紫,比如你現(xiàn)在要去租房,但是呢错维,又不是自己去一個(gè)地方一個(gè)地方找奖地,所以你就拜托了中介幫你找,告訴了中介你的要求赋焕,然后中介就將你的要求發(fā)布在網(wǎng)上参歹,聯(lián)系了房東,最后你去看了房子隆判。首先我們看下抽象主題:
public abstract class Subject {
public abstract String houseHunting();
}
我們看到抽象主題里面有個(gè)找房子的動(dòng)作犬庇。這個(gè)是給后面代理主題和真實(shí)主題使用的,我們現(xiàn)在來看下真實(shí)主題想干嘛:
public class Hunter extends Subject{
@Override
public String houseHunting() {
String info = "我要找一間房子,房子的價(jià)格在2000-3000之間三室一廳";
return info;
}
}
我們看到我們的的真實(shí)主題是想要找一間房子侨嘀,然后說了自己的價(jià)格臭挽。接著我們代理就出現(xiàn)了:
public class Proxy extends Subject{
private Subject subject;
public void setHunter(Subject subject){
this.subject = subject;
}
@Override
public String houseHunting() {
String proxyFare = "我要額外收中介費(fèi)500塊";
String infoFromHunter = subject.houseHunting();
return infoFromHunter +", "+ proxyFare;
}
}
我們看到這里的代理也就是這個(gè)中介除了幫你找房子,還要額外再收中介費(fèi)用咬腕。所以代理可以攔截原來的方法然后再增加額外的功能埋哟。我們看下這個(gè)是怎么使用:
Subject hunter = new Hunter();
Proxy houseAgency = new Proxy();
houseAgency.setHunter(hunter);
String info = houseAgency.houseHunting();
System.out.println(info);
除了這個(gè)靜態(tài)代理,我們java還提供了動(dòng)態(tài)代理機(jī)制郎汪,我們現(xiàn)在來看看用動(dòng)態(tài)代理是怎么實(shí)現(xiàn)代理的。
1.動(dòng)態(tài)代理
同靜態(tài)代理不同的是闯狱,動(dòng)態(tài)代理是通過反射在運(yùn)行時(shí)候生成代理對象的煞赢,要實(shí)現(xiàn)動(dòng)態(tài)代理,首先我們要注意這里的動(dòng)態(tài)代理有要求就是必須被代理的對象必須是實(shí)現(xiàn)一個(gè)接口哄孤。而且代理對象必須實(shí)現(xiàn)InvocationHandler接口照筑。我們先來看看代理對象:
public class DynamicProxy implements InvocationHandler{
private Subject subject;
public DynamicProxy(Subject subject) {
this.subject = subject;
}
@Override
public String invoke(Object arg0, Method method, Object[] arg2)
throws Throwable {
String proxyFare = "我要額外收中介費(fèi)500塊";
String result = (String) method.invoke(subject,arg2);
return result +", "+ proxyFare;
}
}
我們看到這里實(shí)現(xiàn)了InvocationHandler,然后必須實(shí)現(xiàn)invoke方法。invoke方法這里包括方法和方法參數(shù)凝危。然后我們可以往在原本方法增加附加功能了波俄,比如這里的中介費(fèi)。調(diào)用變成了這樣:
Subject hunter = new Hunter();
Subject subject = (Subject) Proxy.newProxyInstance(Subject.class.getClassLoader(),
new Class<?>[]{Subject.class}, new DynamicProxy(hunter));
System.out.println(subject.houseHunting());
當(dāng)然這里的Subject必須是一個(gè)接口蛾默,不然程序會(huì)出錯(cuò)懦铺。當(dāng)然了前面的都是要實(shí)現(xiàn)一個(gè)接口的,但是有沒有不需要被代理對象實(shí)現(xiàn)一個(gè)接口呢支鸡?答案是有的大家可以使用這個(gè)庫Cglib代理
冬念。具體不會(huì)介紹這個(gè)庫,大家有興趣可以看看牧挣。
2.retrofit中的代理設(shè)計(jì)模式
如果想要了解retrofit的具體源碼可以查看[Retrofit2源碼解析]急前,我們知道我們使用retrofit的時(shí)候如下:
PhoneService service=retrofit.create(PhoneService.class);
Call<PhoneResult>call=service.getResult(etPhone.getText().toString());
我們會(huì)獲取到要調(diào)用的服務(wù)的對象PhoneService,然后調(diào)用里面的方法getResult瀑构,因?yàn)槲覀冋f到了動(dòng)態(tài)代理必須要實(shí)現(xiàn)一個(gè)接口裆针,這里的PhoneService 就是一個(gè)接口,然后調(diào)用create方法具體源碼如下:
@SuppressWarnings("unchecked") // Single-interface proxy creation guarded by parameter safety.
public <T> T create(final Class<T> service) {
Utils.validateServiceInterface(service);
if (validateEagerly) {
eagerlyValidateMethods(service);
}
return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
new InvocationHandler() {
private final Platform platform = Platform.get();
@Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
throws Throwable {
// If the method is a method from Object then defer to normal invocation.
if (method.getDeclaringClass() == Object.class) {
return method.invoke(this, args);
}
if (platform.isDefaultMethod(method)) {
return platform.invokeDefaultMethod(method, service, proxy, args);
}
ServiceMethod<Object, Object> serviceMethod =
(ServiceMethod<Object, Object>) loadServiceMethod(method);
OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);
return serviceMethod.callAdapter.adapt(okHttpCall);
}
});
}
我們看到這里應(yīng)用了動(dòng)態(tài)代理寺晌,首先service就是接口的class對象世吨。然后最后new InvocationHandler就是實(shí)現(xiàn)了代理對象。具體做了什么我們的源碼分析有說明這里就不重復(fù)說明折剃。
3.retrofit使用過程中使用到的代理設(shè)計(jì)模式
我們知道另假,我們在訪問網(wǎng)絡(luò)的時(shí)候,會(huì)出現(xiàn)當(dāng)前網(wǎng)絡(luò)環(huán)境較差怕犁,當(dāng)前沒有網(wǎng)絡(luò)边篮,服務(wù)器出錯(cuò)等等情況。所以在create返回訪問接口之后我們可以再加一個(gè)代理來處理這些情況奏甫。我們先來看看我們的代理對象:
public class ResponseErrorProxy implements InvocationHandler {
public static final String TAG = ResponseErrorProxy.class.getSimpleName();
private Object mProxyObject;
public ResponseErrorProxy(Object proxyObject) {
mProxyObject = proxyObject;
}
@Override
public Object invoke(Object proxy, final Method method, final Object[] args) {
return Observable.just(null)
.flatMap(new Func1<Object, Observable<?>>() {
@Override
public Observable<?> call(Object o) {
try {
return (Observable<?>) method.invoke(mProxyObject, args);
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
})
.retryWhen(new Func1<Observable<? extends Throwable>, Observable<?>>() {
@Override
public Observable<?> call(Observable<? extends Throwable> observable) {
return observable.flatMap(new Func1<Throwable, Observable<?>>() {
@Override
public Observable<?> call(Throwable throwable) {
ResponseError error = null;
if (throwable instanceof ConnectTimeoutException
|| throwable instanceof SocketTimeoutException
|| throwable instanceof UnknownHostException
|| throwable instanceof ConnectException) {
error = new ResponseError(HTTP_NETWORK_ERROR,
StringFetcher.getString(R.string.toast_error_network));
} else if (throwable instanceof HttpException) {
HttpException exception = (HttpException) throwable;
try {
error = GsonHelper.builderGson().fromJson(
exception.response().errorBody().string(), ResponseError.class);
} catch (Exception e) {
if (e instanceof JsonParseException) {
error = new ResponseError(HTTP_SERVER_ERROR,
StringFetcher.getString(R.string.toast_error_server));
} else {
error = new ResponseError(HTTP_UNKNOWN_ERROR,
StringFetcher.getString(R.string.toast_error_unknown));
}
}
} else if (throwable instanceof JsonParseException) {
error = new ResponseError(HTTP_SERVER_ERROR,
StringFetcher.getString(R.string.toast_error_server));
} else {
error = new ResponseError(HTTP_UNKNOWN_ERROR,
StringFetcher.getString(R.string.toast_error_unknown));
}
if (error.getStatus() == HTTP_UNAUTHORIZED) {
return refreshTokenWhenTokenInvalid();
} else {
return Observable.error(error);
}
}
});
}
});
}
private Observable<?> refreshTokenWhenTokenInvalid() {
synchronized (ResponseErrorProxy.class) {
//TODO
return null;
}
}
}
這里用了rxjava的知識(shí)戈轿,如果看不清楚只要看到動(dòng)態(tài)代理結(jié)構(gòu)就行。然后我們這個(gè)在獲取接口的時(shí)候返回代理對象:
@Provides
@Singleton
ApiService provideApiService(Retrofit retrofit){
return getByProxy(ApiService.class,retrofit);
}
ApiService getByProxy(Class<? extends ApiService> apiService, Retrofit retrofit){
ApiService api = retrofit.create(apiService);
return (ApiService) Proxy.newProxyInstance(apiService.getClassLoader(),new Class<?>[] { apiService },new ResponseErrorProxy(api));
}
我們看到在create返回ApiService 接口對象的時(shí)候我們又加了一層的代理阵子,最終provideApiService()方法是返回我們的代理對象思杯。這個(gè)方法是不是非常巧妙地處理了這些情況。想要看這段代碼的話也可以看github上面:[HospitalGroup項(xiàng)目]挠进∩可以看到如果我們一個(gè)類實(shí)現(xiàn)了一個(gè)接口,然后我們又想增加這個(gè)類的功能就可以考慮用動(dòng)態(tài)代理领突。
總結(jié):靜態(tài)代理還是動(dòng)態(tài)代理暖璧,在使用的過程中都有其適用的場景,靜態(tài)代理在之后的插件化里面用的還是比較多的君旦,以后會(huì)見到澎办。動(dòng)態(tài)代理我們這里舉了兩個(gè)例子嘲碱,這兩個(gè)都是攔截原有的方法然后來增加額外功能或者解析原來請求方法來做一個(gè)動(dòng)作。這里也希望大家遇到這種情況能想到這個(gè)模式局蚀。