Retrofit2.3 設計模式分析

前言

最近學校的設計模式課程設計要求我們選一個框架進行設計模式的分析,結果老師給的題目都是跟Android毫無瓜葛的。這時候我想起了Retrofit,畢竟有一段時間曾經了解過,據說是設計模式的教科書。所以秉著作死的心態向老師自定義了題目(真?刺激呀),于是乎在一頓折騰后坎坷的看出大致的模式。這篇文章是一個學生黨對框架設計模式的分析,可能有錯誤的地方,希望能得到大家的指導。

關于Retrofit

Retrofit是一個好東西,出自square公司之手,說到square公司自然不得不提一個大神,那就是jack wharton,很多現在流行的輪子都是他參與造的,比如這次的Retrofit啦,Rxjava啦,黃油刀啦,OkHttp啦等等。這里關于Retrofit的介紹就詳細講了,簡書里有很多文章,大家可以搜搜。

Retrofit的基本使用


基本使用方法


使用注解定義一個接口

筆者用的是Kotlin語言,短短主題五行代碼就可以簡單的完成一次網絡請求。與OkHttp相比呢也不用自己來寫請求體和回應體的解析。或許這就是Retrofit受歡迎的原因之一吧。

? 使用步驟描述:

1.先定義一個接口,使用@Get,@Path等注解定義,如上圖。

2.創建一個Retrofit對象,使用其內部Builder類來進行對Retrofit對象的配置

3.創建一個Call(請求體),使用Retrofit的create方法傳入定義好的接口

4.調用已創建Call的方法(接口內的方法),傳入用戶想要的參數

5.執行Call,返回一個回應體

6.對回應體進行一系列用戶需要的操作

框架設計模式分析

1.分析框架的初步運行流程

Retrofit進行配置的流程


創建一個Call的流程

總結:Retofit類負責配置,其中會涉及到一些其他的類,如工廠什么的,但是最后Call的返回邏輯在ServiceMethod類中,ServiceMethod是一個很關鍵的類,涉及到了具體運行原理和調用,這里我們只做設計模式分析,就不深入啦。

2.深入分析


我們一步一步來,最后面會放上類圖,咱們先不急。

第一步配置

第一步:配置Retrofit

從名字我們就可以看出,毫無疑問配置這一部用了個構造者模式呀(Builder),學生黨我暗自偷笑。是不是不用看啦??不急不急,我們還是進去看一看。

Retrofit類的內部屬性和部分方法

可以看到Retrofit類中包含了一個Builder類,點進去一看,是一個靜態類(這里就不放圖了),再看看上圖中若干個addXXX方法和一些其他方法均是返回Builder自身的,還有一個build()方法返回一個Retrofit的,這一羅列,哎呀媽呀果真是構造者方法,錯不了錯不了。

知道這里是使用了構造方法后,那有什么用呀?因為網絡請求要配置各種參數,而有些參數是不必要的,如果不使用構造者模式,那Retrofit就必須得寫一大串參數類型不同的構造器,用于對參數傳入,那代碼就非常的不雅,可讀性也很差,所以就用了個Builder啦。

等等!就這么完了嗎?但是你仔細看一下參數,addXXXFactory?里面竟然維護了一個叫XXFactory的列表?這難道是...抽象工廠??工廠方法??(學生黨暗自偷笑,這作業穩了)我們先點進去一探究竟


我們點進CallAdapter.Factory


驚了,一個接口里面有個抽象類,一個抽象方法
看一下這個抽象類的實現,有4個,其中有2個一樣的是因為版本不同的問題


嗯。。沒什么特別,這里就用到了一個簡單的單例..我們看下一個


這個工廠有一個內部類ExecutorCallBackCall,還實現了Call接口

經過一頓分析,可以非常確定這是一個抽象工廠和工廠方法的設計模式。CallAdapter.Factory為抽象工廠,CallAdapter為工廠的產品接口,而上圖中的ExecutorCallAdapterFactory和DefaultCallAdapterFactory為他的實現類,其中ExecutorCallAdapterFactory中的內部類ExecutorCallBackCall為該工廠的產品,實現了Call接口。

等等!!你說ExecutorCallBackCall是工廠的產品?但無論是從名字上來看還是從接口上來看都不應該啊?因為他實現了Call接口,但沒有實現產品應該實現的CallAdapter接口啊?

的確如此,但是。CallAdapter這名字不覺的很熟悉嗎?沒錯Adapter,其實這里還用了一個適配模式,而這整一個工廠最終目的是返回一個適配器,基于某種兼容目的的適配器。

匿名實現了CallAdapter接口,其中里面就返回ExecutorCallbackCall

也就是說,產品其實是他匿名實現的CallAdapter,只是里面返回了一個ExecutorCallbackCall,這里利用創建工廠實現時傳進來的一個實現了Java Executor接口的類,來進行對參數call的一個適配。

這里你會很好奇為什么ExecutorCallbackCall傳進一個實現了Java Executor接口的類和一個call做為參數。


ExecutorCallbackCall實現的Call接口結構
ExecutorCallbackCall 內部的結構

經過一番查看,先看看Call接口,ExecutorCallbackCall實現的Call接口和在適配方法中傳進來的call參數實現的接口是一毛一樣的!!而從類的結構來看,看屬性delegate的調用。是的,其實該類的實現實際是交給(委托)給傳進來的call參數(delegate屬性)實現的,然后只是在使用另一個傳進來的參數(callbackExecutor)環境中運行【看紅線部分】。

也就是說。這個類是包裝用的,實現的功能都是委托給call的。裝飾器模式,不知道為何腦內浮現出這幾個大字...

到此。我們連同裝飾器,適配器整個抽象工廠,工廠方法分析完畢。這一層套一層,環環相扣,這讓人顫栗啊,這?設計的太可怕的。多種設計模式的運用巧而不顯冗雜,豈是我等能做到的!

還有一點要提,我們上課的時候喜歡把產品接口和抽象方法分開兩個文件來寫,但是這里是將抽象工廠寫在了接口中。這很巧妙,因為這樣使用的時候就非常明顯【接口.抽象工廠】,一看就知道這工廠的產品和抽象。而且合在一起寫也不用為命令感到煩惱。

總結一下:


類圖結構

我們從配置Retrofit為出發點,分析出了抽象工廠,工廠方法,單例,適配器,裝飾器五種模式。可能就要問了,在哪里開始初始化了這個工廠?有兩個地方

第一:通過Retofit中Builder的addCallAdapterFactory方法


通過Retofit中Builder的addCallAdapterFactory方法

第二:在我們調出Builder時,在無參構造器中,通過調用Platform.get()來初始化


Builder的無參構造器
Platform類內部結構

What??Platform啥玩意?不用擔心,源代碼作者命名非常好,看名字大概就知道,是平臺嘛,平臺類是干嘛?

可以看出里面有兩個內部靜態類Java8和Android,還有兩個defaultCallXXX的方法。到這里我們就可以結合適配器工廠和這里兩個內部類的類名揣測出適配器是為了適配不同平臺下的運行環境。Android有主線程(UI線程)而Java8則沒有

Android
Java8

這里框架就默認實現了兩個平臺。Platform類是可繼承的,如果沒有我們的需求就可以繼承該類并實現自己的平臺。

說要這里第一步配置就說完了,但是返回文中剛開始的地方,你會看到一個叫converterFactories的列表,這是一個converter工廠的列表,也是一個抽象工廠,這里就不詳細說了,下面只給出類圖,僅供大家參考


畫的好丑。用于解析網絡返回體結果。如Gson

第二步:使用create方法傳入接口,返回call


使用步驟的第二步

老規矩咯,點進去看看..

???

哎呀woc這什么東西。學生黨看不懂,但是我們從Proxy這個名字可以看出,或許是個代理模式。經過資料查詢后發現,這里是實現了Java中自帶的動態代理。何為動態代理?就是在創建一個實例前,你或許要對這個實例動點手腳,而我們又不能在創建實例的是時候決定要動點什么手腳,所以先創建一個代理對象給你用著先,等你動完該動的手腳,才開始真正創建實例。也就是說,這里我們調用create方法本來是要返回一個call對象的,但是!我們要在傳入需要的參數后才能真正創建call對象,也就是說在文中開始的第三步后才真正創建了一個call。

如上圖,create只是創建了個代理,當調用了代理內的方法后(接口放射后的方法)才開始創建真正的實例

這里筆者就不探究動態代理如何實現的了(因為我也不會呀..)我們繼續往下看,這動態代理內的代碼

首先是調用了自身的loadServiceMethod方法,加載(獲得)了一個ServiceMethod類,然后通過其創建了一個OkHttpCall實例,最后調用了serviceMethod實例中的一個callAdapter對象中的adapt方法,最終返回了一個call。為這個adapt方法就是之前分析中的工廠方法產品類的方法。

查看一下loadServiceMethod的代碼


非常簡單..

看來Retrofit內部保存了一個ServiceMethod的map(key是從接口中反射出來的方法),沒找到的話就通過ServiceMethod的Builder構造一個(又是一個構造者方法),然后存進map中。而ServiceMethod中就會創建callAdapter,這其中又會跳回Retrofit中,從其維護的callAdapter工廠列表中查找..挺復雜的,就不說啦,畢竟原則是設計模式分析嘛。

再看看用serviceMethod構造的OkHttpCall


其實現了call接口,就是之前在分析適配器講到的call接口一樣的。里面包含了一個另一個call接口:rawCall,這個rawCall與上面的call不同,因為他是來自okhttp3的。也就是這里的OkHttpCall其實就是包裝了okhttp3中的call,功能的調用都委托給他..又一個裝飾器。

總結

到這里,Retrofit中用到的設計模式我能發現到的,基本分析完了,里面運用了抽象工廠,工廠方法,單例,裝飾器,適配器,動態代理。光是配置這一步就用了前六種設計模式..太可怕了..

希望你們能看懂...虛心接受指導和更正..

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370

推薦閱讀更多精彩內容