iOS應用架構談(三):網絡層設計方案(上)
編者按:iOS客戶端應用架構看似簡單,但實際上要考慮的事情不少。本文作者將以系列文章的形式來討論iOS應用架構中的種種問題,本文是其中的第三篇,主要講網絡層設計以及安全機制和優化方案。
前言
網絡層在一個App中也是一個不可缺少的部分,工程師們在網絡層能夠發揮的空間也比較大。另外,蘋果對網絡請求部分已經做了很好的封裝,業界的 AFNetworking也被廣泛使用。其它的ASIHttpRequest,MKNetworkKit啥的其實也都還不錯,但前者已經棄坑,后者也在棄 坑的邊緣。在實際的App開發中,Afnetworking已經成為了事實上各大App的標準配置。
網絡層在一個App中承載了API調用,用戶操作日志記錄,甚至是即時通訊等任務。我接觸過一些App(開源的和不開源的)的代碼,在看到 網絡層這一塊時,尤其是在看到各位架構師各顯神通展示了各種技巧,我非常為之感到興奮。但有的時候,往往也對于其中的一些缺陷感到失望。
關于網絡層的設計方案會有很多,需要權衡的地方也會有很多,甚至于爭議的地方都會有很多。但無論如何,我都不會對這些問題做出任何逃避,我會在這篇文章中給出我對它們的看法和解決方案,觀點絕不中立,不會跟大家打太極。
這篇文章就主要會講這些方面:
- 網絡層跟業務對接部分的設計
- 網絡層的安全機制實現
- 網絡層的優化方案
網絡層跟業務對接部分的設計
在安居客App的架構更新換代的時候,我深深地感覺到網絡層跟業務對接部分的設計有多么重要,因此我對它做的最大改變就是針對網絡層跟業務對接部分的改變。網絡層跟業務層對接部分設計的好壞,會直接影響到業務工程師實現功能時的心情。
在正式開始講設計之前,我們要先討論幾個問題:
- 使用哪種交互模式來跟業務層做對接?
- 是否有必要將API返回的數據封裝成對象然后再交付給業務層?
- 使用集約化調用方式還是離散型調用方式去調用API?
這些問題討論完畢之后,我會給出一個完整的設計方案來給大家做參考,設計方案是魚,討論的這些問題是漁,我什么都授了,大家各取所需。
使用哪種交互模式來跟業務層做對接?
這里其實有兩個問題:一,以什么方式將數據交付給業務層?二,交付什么樣的數據給業務層?
以什么方式將數據交付給業務層?
iOS開發領域有很多對象間數據的傳遞方式,我看到的大多數App在網絡層所采用的方案主要集中于這三種:Delegate,Notification,Block。KVO和Target-Action我目前還沒有看到有使用的。
目前我知道邊鋒主要是采用的block,大智慧主要采用的是Notification,安居客早期以Block為主,后面改成了以 Delegate為主,阿里沒發現有通過Notification來做數據傳遞的地方(可能有),Delegate、Block以及target- action都有,阿里iOS App網絡層的作者說這是為了方便業務層選擇自己合適的方法去使用。這里大家都是各顯神通,每次我看到這部分的時候,我都喜歡問作者為什么采用這種交互方 案,但很少有作者能夠說出個條條框框來。
然而在我這邊,我的意見是以Delegate為主,Notification為輔。原因如下:
- 盡可能減少跨層數據交流的可能,限制耦合
- 統一回調方法,便于調試和維護
- 在跟業務層對接的部分只采用一種對接手段(在我這兒就是只采用delegate這一個手段)限制靈活性,以此來交換應用的可維護性
盡可能減少跨層數據交流的可能,限制耦合
什么叫跨層數據交流?就是某一層(或模塊)跟另外的與之沒有直接對接關系的層(或模塊)產生了數據交換。為什么這種情況不好?嚴格來說應該 是大部分情況都不好,有的時候跨層數據交流確實也是一種需求。之所以說不好的地方在于,它會導致代碼混亂,破壞模塊的封裝性。我們在做分層架構的目的其中 之一就在于下層對上層有一次抽象,讓上層可以不必關心下層細節而執行自己的業務。
所以,如果下層細節被跨層暴露,一方面你很容易因此失去鄰層對這個暴露細節的保護;另一方面,你又不可能不去處理這個細節,所以處理細節的相關代碼就會散落各地,最終難以維護。
說得具象一點就是,我們考慮這樣一種情況:A<-B<-C。當C有什么事件,通過某種方式告知B,然后B執行相應的邏輯。一旦 告知方式不合理,讓A有了跨層知道C的事件的可能,你 就很難保證A層業務工程師在將來不會對這個細節作處理。一旦業務工程師在A層產生處理操作,有可能是補充邏輯,也有可能是執行業務,那么這個細節的相關處 理代碼就會有一部分散落在A層。然而前者是不應該散落在A層的,后者有可能是需求。另外,因為B層是對A層抽象的,執行補充邏輯的時候,有可能和B層針對 這個事件的處理邏輯產生沖突,這是我們很不希望看到的。
那么什么情況跨層數據交流會成為需求?在網絡層這邊,信號從2G變成3G變成4G變成Wi-Fi,這個是跨層數據交流的其中一個需求。不過其他的跨層數據交流需求我暫時也想不到了,哈哈,應該也就這一個吧。
嚴格來說,使用Notification來進行網絡層和業務層之間數據的交換,并不代表這一定就是跨層數據交流,但是使用 Notification給跨層數據交流開了一道口子,因為Notification的影響面不可控制,只要存在實例就存在被影響的可能。另外,這也會導 致誰都不能保證相關處理代碼就在唯一的那個地方,進而帶來維護災難。作為架構師,在這里給業務工程師限制其操作的靈活性是必要的。另 外,Notification也支持一對多的情況,這也給代碼散落提供了條件。同時,Notification所對應的響應方法很難在編譯層面作限制,不 同的業務工程師會給他取不同的名字,這也會給代碼的可維護性帶來災難。
手機淘寶架構組的俠武同學曾經給我分享過一個問題,在這里我也分享給大家:曾經有一個工程師在監聽Notification之后,沒有寫釋 放監聽的代碼,當然,找到這個原因又是很漫長的一段故事,現在找到原因了,然而監聽這個Notification的對象有那么多,不知道具體是哪個 Notificaiton,也不知道那個沒釋放監聽的對象是誰。后來折騰了很久大家都沒辦法的時候,有一個經驗豐富的工程師提出用hook(Method Swizzling)的方式,最終找到了那個沒釋放監聽的對象,bug修復了。
我分享這個問題的目的并不是想強調Notification多么多么不好,Notification本身就是一種設計模式,在屬于它的問題 領域內,Notification是非常好的一種解決方案。但我想強調的是,對于網絡層這個問題領域內來看,架構師首先一定要限制代碼的影響范圍,在能用 影響范圍小的方案的時候就盡量采用這種小的方案,否則將來要是有什么奇怪需求或者出了什么小問題,維護起來就非常麻煩。因此Notification這個 方案不能作為首選方案,只能作為備選。
那么Notification也不是完全不能使用,當需求要求跨層時,我們就可以使用Notification,比如前面提到的網絡條件切換,而且這個需求也是需要滿足一對多的。
所以,為了符合前面所說的這些要求,使用Delegate能夠很好地避免跨層訪問,同時限制了響應代碼的形式,相比Notification而言有更好的可維護性。
然后我們順便來說說為什么盡量不要用block
1. block很難追蹤,難以維護
我們在調試的時候經常會單步追蹤到某一個地方之后,發現尼瑪這里有個block,如果想知道這個block里面都做了些什么事情,這時候就比較蛋疼了。
- (void)someFunctionWithBlock:(SomeBlock *)block { ... ... -> block(); //當你單步走到這兒的時候,要想知道block里面都做了哪些事情的話,就很麻煩。 ... ... }
2. block會延長相關對象的生命周期
block會給內部所有的對象引用計數加一,這一方面會帶來潛在的retain cycle,不過我們可以通過Weak Self的手段解決。另一方面比較重要就是,它會延長對象的生命周期。
在網絡回調中使用block,是block導致對象生命周期被延長的其中一個場合,當ViewController從window中卸下 時,如果尚有請求帶著block在外面飛,然后block里面引用了ViewController(這種場合非常常見),那么 ViewController是不能被及時回收的,即便你已經取消了請求,那也還是必須得等到請求著陸之后才能被回收。
然而使用delegate就不會有這樣的問題,delegate是弱引用,哪怕請求仍然在外面飛,,ViewController還是能夠及時被回收的,回收之后指針自動被置為了nil,無傷大雅。
所以平時盡量不要濫用block,尤其是在網絡層這里。
3. 統一回調方法,便于調試和維護
前面講的是跨層問題,區分了Delegate和Notification,順帶談了一下Block。然后現在談到的這個情況,就是另一個采 用Block方案不是很合適的情況。首先,Block本身無好壞對錯之分,只有合適不合適。在這一節要講的情況里,Block無法做到回調方法的統一,調 試和維護的時候也很難在調用棧上顯示出來,找的時候會很蛋疼。
在網絡請求和網絡層接受請求的地方時,使用Block沒問題。但是在獲得數據交給業務方時,最好還是通過Delegate去通知到業務方。 因為Block所包含的回調代碼跟調用邏輯放在同一個地方,會導致那部分代碼變得很長,因為這里面包括了調用前和調用后的邏輯。從另一個角度說,這在一定 程度上違背了single function,single task的原則,在需要調用API的地方,就只要寫API調用相關的代碼,在回調的地方,寫回調的代碼。
然后我看到大部分App里,當業務工程師寫代碼寫到這邊的時候,也意識到了這個問題。因此他們會在block里面寫個一句話的方法接收參數,然后做轉發,然后就可以把這個方法放在其他地方了,繞過了Block的回調著陸點不統一的情況。比如這樣:
[API callApiWithParam:param successed:^(Response *response){ [self successedWithResponse:response]; } failed:^(Request *request, NSError *error){ [self failedWithRequest:request error:error]; }];
這實質上跟使用Delegate的手段沒有什么區別,只是繞了一下,不過還是沒有解決統一回調方法的問題,因為block里面寫的方法名字可能在不 同的ViewController對象中都會不一樣,畢竟業務工程師也是很多人,各人有各人的想法。所以架構師在這邊不要貪圖方便,還是使用 delegate的手段吧,業務工程師那邊就能不用那么繞了。Block是目前大部分第三方網絡庫都采用的方式,因為在發送請求的那一部分,使用 Block能夠比較簡潔,因此在請求那一層是沒有問題的,只是在交換數據之后,還是轉變成delegate比較好,比如AFNetworking里面:
[AFNetworkingAPI callApiWithParam:self.param successed:^(Response *response){ if ([self.delegate respondsToSelector:@selector(successWithResponse:)]) { [self.delegate successedWithResponse:response]; } } failed:^(Request *request, NSError *error){ if ([self.delegate respondsToSelector:@selector(failedWithResponse:)]) { [self failedWithRequest:request error:error]; } }];
這樣在業務方這邊回調函數就能夠比較統一,便于維護。
綜上,對于以什么方式將數據交付給業務層?這個問題的回答是這樣:
盡可能通過Delegate的回調方式交付數據,這樣可以避免不必要的跨層訪問。當出現跨層訪問的需求時(比如信號類型切換),通過Notification的方式交付數據。正常情況下應該是避免使用Block的。
交付什么樣的數據給業務層?
我見過非常多的App的網絡層在拿到JSON數據之后,會將數據轉變成對應的對象原型。注意,我這里指的不是NSDictionary,而 是類似Item這樣的對象。這種做法是能夠提高后續操作代碼的可讀性的。在比較直覺的思路里面,是需要這部分轉化過程的,但這部分轉化過程的成本是很大 的,主要成本在于:
- 數組內容的轉化成本較高:數組里面每項都要轉化成Item對象,如果Item對象中還有類似數組,就很頭疼。
- 轉化之后的數據在大部分情況是不能直接被展示的,為了能夠被展示,還需要第二次轉化。
- 只有在API返回的數據高度標準化時,這些對象原型(Item)的可復用程度才高,否則容易出現類型爆炸,提高維護成本。
- 調試時通過對象原型查看數據內容不如直接通過NSDictionary/NSArray直觀。
- 同一API的數據被不同View展示時,難以控制數據轉化的代碼,它們有可能會散落在任何需要的地方。
其實我們的理想情況是希望API的數據下發之后就能夠直接被View所展示。首先要說的是,這種情況非常少。另外,這種做法使得View和API聯系緊密,也是我們不希望發生的。
在設計安居客的網絡層數據交付這部分時,我添加了reformer(名字而已,叫什么都好)這個對象用于封裝數據轉化的邏輯,這個對象是一 個獨立對象,事實上,它是作為Adaptor模式存在的。我們可以這么理解:想象一下我們洗澡時候使用的蓮蓬頭,水管里出來的水是API下發的原始數據。 reformer就是蓮蓬頭上的不同水流擋板,需要什么模式,就撥到什么模式。
在實際使用時,代碼觀感是這樣的:
先定義一個protocol: @protocol ReformerProtocol - (NSDictionary)reformDataWithManager:(APIManager *)manager; @end 在Controller里是這樣: @property (nonatomic, strong) id<ReformerProtocol> XXXReformer; @property (nonatomic, strong) id<ReformerProtocol> YYYReformer; #pragma mark - APIManagerDelegate - (void)apiManagerDidSuccess:(APIManager *)manager { NSDictionary *reformedXXXData = [manager fetchDataWithReformer:self.XXXReformer]; [self.XXXView configWithData:reformedXXXData]; NSDictionary *reformedYYYData = [manager fetchDataWithReformer:self.YYYReformer]; [self.YYYView configWithData:reformedYYYData]; } 在APIManager里面,fetchDataWithReformer是這樣: - (NSDictionary)fetchDataWithReformer:(id)reformer { if (reformer == nil) { return self.rawData; } else { return [reformer reformDataWithManager:self]; } }
- 要點1:reformer是一個符合ReformerProtocol的對象,它提供了通用的方法供Manager使用。
- 要點2:API的原始數據(JSON對象)由Manager實例保管,reformer方法里面取Manager的原始數據 (manager.rawData)做轉換,然后交付出去。蓮蓬頭的水管部分是Manager,負責提供原始水流(數據流),reformer就是不同的 模式,換什么reformer就能出來什么水流。
- 要點3:例子中舉的場景是一個API數據被多個View使用的情況,體現了reformer的一個特點:可以根據需要改變同一數據來源 的展示方式。比如API數據展示的是“附近的小區”,那么這個數據可以被列表(XXXView)和地圖(YYYView)共用,不同的view使用的數據 的轉化方式不一樣,這就通過不同的reformer解決了。
- 要點4:在一個view用來同一展示不同API數據的情況,reformer是絕佳利器。比如安居客的列表view的數據來源可能有三 個:二手房列表API,租房列表API,新房列表API。這些API返回來的數據的value可能一致,但是key都是不一致的。這時候就可以通過同一個 reformer來做數據的標準化輸出,這樣就使得view代碼復用成為可能。這體現了reformer另外一個特點:同一個reformer出來的數據 是高度標準化的。形象點說就是:只要蓮蓬頭不換,哪怕水管的水變成海水或者污水了,也依舊能夠輸出符合洗澡要求的淡水水流。舉個例子:
- (void)apiManagerDidSuccess:(APIManager *)manager { // 這個回調方法有可能是來自二手房列表APIManager的回調,也有可能是 租房,也有可能是新房。但是在Controller層面我們不需要對它做額外區分, 只要是同一個reformer出來的數據,我們就能保證是一定能被self.XXXView使 用的。這樣的保證由reformer的實現者來提供。 NSDictionary *reformedXXXData = [manager fetchDataWithReformer:self.XXXReformer]; [self.XXXView configWithData:reformedXXXData]; }
- 要點5:有沒有發現,使用reformer之后,Controller的代碼簡潔了很多?而且,數據原型在這種情況下就沒有必要存在了,隨之而來的成本也就被我們繞過了。
reformer本質上就是一個符合某個protocol的對象,在controller需要從api manager中獲得數據的時候,順便把reformer傳進去,于是就能獲得經過reformer重新洗過的數據,然后就可以直接使用了。
更抽象地說,reformer其實是對數據轉化邏輯的一個封裝。在controller從manager中取數據之后,并且把數據交給 view之前,這期間或多或少都是要做一次數據轉化的,有的時候不同的view,對應的轉化邏輯還不一樣,但是展示的數據是一樣的。而且往往這一部分代碼 都非常復雜,且跟業務強相關,直接上代碼,將來就會很難維護。所以我們可以考慮采用不同的reformer封裝不同的轉化邏輯,然后讓 controller根據需要選擇一個合適的reformer裝上,就像洗澡的蓮蓬頭,需要什么樣的水流(數據的表現形式)就換什么樣的頭,然而水(數 據)都是一樣的。這種做法能夠大大提高代碼的可維護性,以及減少ViewController的體積。
總結一下,reformer事實上是把轉化的代碼封裝之后再從主體業務中拆分了出來,拆分出來之后不光降低了原有業務的復雜度,更重要的 是,它提高了數據交付的靈活性。另外,由于Controller負責調度Manager和View,因此它是知道Manager和View之間的關系 的,Controller知道了這個關系之后,就有了充要條件來為不同的View選擇不同的Reformer,并用這個Reformer去改造 Mananger的數據,然后ViewController獲得了經過reformer處理過的數據之后,就可以直接交付給view去使用。 Controller因此得到瘦身,負責業務數據轉化的這部分代碼也不用寫在Controller里面,提高了可維護性。
所以reformer機制能夠帶來以下好處:
- 好處1:繞開了API數據原型的轉換,避免了相關成本。
- 好處2:在處理單View對多API,以及在單API對多View的情況時,reformer提供了非常優雅的手段來響應這種需求,隔離了轉化邏輯和主體業務邏輯,避免了維護災難。
- 好處3:轉化邏輯集中,且將轉化次數轉為只有一次。使用數據原型的轉化邏輯至少有兩次,第一次是把JSON映射成對應的原型,第二次是 把原型轉變成能被View處理的數據。reformer一步到位。另外,轉化邏輯在reformer里面,將來如果API數據有變,就只要去找到對應 reformer然后改掉就好了。
- 好處4:Controller因此可以省去非常多的代碼,降低了代碼復雜度,同時提高了靈活性,任何時候切換reformer而不必切換業務邏輯就可以應對不同View對數據的需要。
- 好處5:業務數據和業務有了適當的隔離。這么做的話,將來如果業務邏輯有修改,換一個reformer就好了。如果其他業務也有相同的 數據轉化邏輯,其他業務直接拿這個reformer就可以用了,不用重寫。另外,如果controller有修改(比如UI交互方式改變),可以放心換 controller,完全不用擔心業務數據的處理。
在不使用特定對象表征數據的情況下,如何保持數據可讀性?
不使用對象來表征數據的時候,事實上就是使用NSDictionary的時候。事實上,這個問題就是,如何在NSDictionary表征數據的情況下保持良好的可讀性?
蘋果已經給出了非常好的做法,用固定字符串做key,比如你在接收到KeyBoardWillShow的Notification時,帶了 一個userInfo,他的key就都是類似UIKeyboardAnimationCurveUserInfoKey這樣的,所以我們采用這樣的方案來 維持可讀性。下面我舉一個例子:
PropertyListReformerKeys.h extern NSString * const kPropertyListDataKeyID; extern NSString * const kPropertyListDataKeyName; extern NSString * const kPropertyListDataKeyTitle; extern NSString * const kPropertyListDataKeyImage; PropertyListReformer.h #import "PropertyListReformerKeys.h" ... ... PropertyListReformer.m NSString * const kPropertyListDataKeyID = @"kPropertyListDataKeyID"; NSString * const kPropertyListDataKeyName = @"kPropertyListDataKeyName"; NSString * const kPropertyListDataKeyTitle = @"kPropertyListDataKeyTitle"; NSString * const kPropertyListDataKeyImage = @"kPropertyListDataKeyImage"; - (NSDictionary *)reformData:(NSDictionary *)originData fromManager:(APIManager *)manager { ... ... ... ... NSDictionary *resultData = nil; if ([manager isKindOfClass:[ZuFangListAPIManager class]]) { resultData = @{ kPropertyListDataKeyID:originData[@"id"], kPropertyListDataKeyName:originData[@"name"], kPropertyListDataKeyTitle:originData[@"title"], kPropertyListDataKeyImage:[UIImage imageWithUrlString:originData[@"imageUrl"]] }; } if ([manager isKindOfClass:[XinFangListAPIManager class]]) { resultData = @{ kPropertyListDataKeyID:originData[@"xinfang_id"], kPropertyListDataKeyName:originData[@"xinfang_name"], kPropertyListDataKeyTitle:originData[@"xinfang_title"], kPropertyListDataKeyImage:[UIImage imageWithUrlString:originData[@"xinfang_imageUrl"]] }; } if ([manager isKindOfClass:[ErShouFangListAPIManager class]]) { resultData = @{ kPropertyListDataKeyID:originData[@"esf_id"], kPropertyListDataKeyName:originData[@"esf_name"], kPropertyListDataKeyTitle:originData[@"esf_title"], kPropertyListDataKeyImage:[UIImage imageWithUrlString:originData[@"esf_imageUrl"]] }; } return resultData; } PropertListCell.m #import "PropertyListReformerKeys.h" - (void)configWithData:(NSDictionary *)data { self.imageView.image = data[kPropertyListDataKeyImage]; self.idLabel.text = data[kPropertyListDataKeyID]; self.nameLabel.text = data[kPropertyListDataKeyName]; self.titleLabel.text = data[kPropertyListDataKeyTitle]; }
這一大段代碼看下來,我如果不說一下要點,那基本上就白寫了哈:
我們先看一下結構:
來自:http://www.infoq.com/cn/articles/ios-app-arch-3-1