流行框架源碼分析(14)-Proxy代理設(shè)計(jì)模式

主目錄見: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類圖:


代理設(shè)計(jì)模式

角色介紹:

  • 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è)模式局蚀。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末麦锯,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子琅绅,更是在濱河造成了極大的恐慌扶欣,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,589評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件奉件,死亡現(xiàn)場離奇詭異宵蛀,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)县貌,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,615評論 3 396
  • 文/潘曉璐 我一進(jìn)店門术陶,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人煤痕,你說我怎么就攤上這事梧宫。” “怎么了摆碉?”我有些...
    開封第一講書人閱讀 165,933評論 0 356
  • 文/不壞的土叔 我叫張陵塘匣,是天一觀的道長。 經(jīng)常有香客問我巷帝,道長忌卤,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,976評論 1 295
  • 正文 為了忘掉前任楞泼,我火速辦了婚禮驰徊,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘堕阔。我一直安慰自己棍厂,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,999評論 6 393
  • 文/花漫 我一把揭開白布超陆。 她就那樣靜靜地躺著牺弹,像睡著了一般。 火紅的嫁衣襯著肌膚如雪时呀。 梳的紋絲不亂的頭發(fā)上张漂,一...
    開封第一講書人閱讀 51,775評論 1 307
  • 那天,我揣著相機(jī)與錄音谨娜,去河邊找鬼鹃锈。 笑死,一個(gè)胖子當(dāng)著我的面吹牛瞧预,可吹牛的內(nèi)容都是我干的屎债。 我是一名探鬼主播,決...
    沈念sama閱讀 40,474評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼垢油,長吁一口氣:“原來是場噩夢啊……” “哼盆驹!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起滩愁,我...
    開封第一講書人閱讀 39,359評論 0 276
  • 序言:老撾萬榮一對情侶失蹤躯喇,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后硝枉,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體廉丽,經(jīng)...
    沈念sama閱讀 45,854評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,007評論 3 338
  • 正文 我和宋清朗相戀三年妻味,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了正压。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,146評論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡责球,死狀恐怖焦履,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情雏逾,我是刑警寧澤嘉裤,帶...
    沈念sama閱讀 35,826評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站栖博,受9級特大地震影響屑宠,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜仇让,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,484評論 3 331
  • 文/蒙蒙 一典奉、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧妹孙,春花似錦秋柄、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,029評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至嚣崭,卻和暖如春笨触,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背雹舀。 一陣腳步聲響...
    開封第一講書人閱讀 33,153評論 1 272
  • 我被黑心中介騙來泰國打工芦劣, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人说榆。 一個(gè)月前我還...
    沈念sama閱讀 48,420評論 3 373
  • 正文 我出身青樓虚吟,卻偏偏與公主長得像寸认,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子串慰,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,107評論 2 356

推薦閱讀更多精彩內(nèi)容