
前些天幫公司把網絡層重構了一遍,當時就想做完來分享,後來接著趕新版本需求,拖到現在才有空整理。
舊的網絡層當初是直接拖_framework 進專案,還改動了大量源碼。兩年過去,AFNetworking 已經迭代好幾輪,整個遷移變得非常棘手。翻前輩寫的程式碼,能看出思路和我相近,但實作路徑不同,給了我不少參考。這次的架構也參考了 Casa 大神的一些想法,不過仍有差異。
本文不重理論、少用術語,一来方便閱讀,二来我的基礎也沒那麼紮實。對架構來說思路才是關鍵,思路在,實作就不難。
本文主要談:網絡接口規範、多服務器多環境設定、網絡層數據傳遞、業務層對接方式、請求自動取消、錯誤處理。
無 Demo 無文章,Demo 下載:https://github.com/SummertimSadness/NetWorkingDemo
demo 裡的請求示例是網上找的,不符合下面這套規範,僅供參考。
規範很重要,合理的規範能省掉大量程式碼邏輯,特別是接口兼容——這是最底層的設計,所以放在最前面講。這次重構我提了幾點,給大家參考。
接口返回的第一層是字典,分兩層三部分:code、msg、data。
"code": 0, "msg": "", "data": { "upload_log": true, "has_update": false, "admin_id": "529ecfd64" }code:錯誤碼,便於快速定位問題,可以自訂一套,例如 200 正常、1 重新登入
msg:接口文案提示,直接用來顯示給使用者,所以不能是一串英文錯誤
data:真正要返回的資料,可以是字典也可以是陣列
接口已經幫我們定義了 code 與 msg,是不是就不用做錯誤處理了?當然不是。服務端的錯誤邏輯畢竟簡單,data 裡的資料處理仍可能出錯,錯誤處理必不可少,後面會單獨談。
這一點通常都能做到,但也有例外。我們有個早期接口就不太規範:channelID、device_id 這類通用資訊直接拼在字串後面,真正的請求參數則要轉成 JSON 塞進某個欄位,變成 GET 與 POST 混用的形式,網絡層被迫要做特殊處理。可見標準的 GET、POST 用法多麼有必要。
Null 在 iOS 裡是個特殊存在。我的建議是放在客戶端處理,理由有幾個:
1)接口規範並不是每家公司都能一開始就定義好,老接口要把 Null 欄位移除改動太大;
2)客戶端統一過濾一次即可一勞永逸,不必日後因為接口問題而崩潰,而且不少 Model 第三方庫也能很好地解決這件事。這裡要說一句,Swift 的類型檢測實在太方便了,之前用 Swift 寫的專案只要規範一點,根本不會出現參數類型導致的崩潰。
這部分大致沿用 Casa 大神的設計,我另外延伸了多環境的處理。小專案通常只有一個服務器,但像淘寶那種量級顯然不可能,多服務器設計其實相當普遍。做法是透過一個枚舉變數,由 ServerFactory 單例產生對應的服務器配置。
標準的 App 有四套環境:開發、測試、預發、正式。服務端程式碼不該所有改動都直接進正式環境,而應按 開發 → 測試 → 預發 → 正式 推進。開發階段處理新需求與優化;提交測試後的改動在新分支上進行,完成後合回測試分支與開發分支;預發階段的變動通常很小,一般在測試人員驗證後發給全公司試用,有問題才改,改完同樣合回開發分支;正式則是線上版本的緊急修復,修完也合回開發分支。所以開發分支永遠保持最新。在此之上可能還有 hotfix 環境、自訂的 H5/後台本地除錯環境等。
客戶端也要有對應環境,並提供切換入口。我的 demo 給了兩套設定:一套是首次安裝時的初始化環境(巨集定義),一套是手動切換(枚舉 EnvironmentType)。這裡有個稍微繞的優先級邏輯:巨集定義的正式環境優先級最高,其次才是手動切換,最後是巨集的其他環境。
//宏定義環境設置 #if !defined YA_BUILD_FOR_DEVELOP && !defined YA_BUILD_FOR_TEST && !defined YA_BUILD_FOR_RELEASE && !defined YA_BUILD_FOR_PRERELEASE #define YA_BUILD_FOR_DEVELOP //#define YA_BUILD_FOR_TEST //#define YA_BUILD_FOR_PRERELEASE //#define YA_BUILD_FOR_HOTFIX //#define YA_BUILD_FOR_RELEASE //該環境的優先級最高 #endif //手動環境切換設置 #ifdef YA_BUILD_FOR_RELEASE //優先宏定義正式環境 self.environmentType = EnvironmentTypeRelease; #else //手動切換環境後會把設置保存 NSNumber *type = [[NSUserDefaults standardUserDefaults] objectForKey:@"environmentType"]; if (type) { //優先讀取手動切換設置 self.environmentType = (EnvironmentType)[type integerValue]; } else { #ifdef YA_BUILD_FOR_DEVELOP self.environmentType = EnvironmentTypeDevelop; #elif defined YA_BUILD_FOR_TEST self.environmentType = EnvironmentTypeTest; #elif defined YA_BUILD_FOR_PRERELEASE self.environmentType = EnvironmentTypePreRelease; #elif defined YA_BUILD_FOR_HOTFIX self.environmentType = EnvironmentTypeHotFix; #endif } #endif也就是說,巨集定義為正式環境時無法手動切換,這對應一般使用者的發行版本;其他巨集環境下則可以切到正式環境。
半個坑
另外,手動切換自訂環境是在基類中實作的,其他環境配置卻在協議裡,這就顯得不統一了。可以這樣理解:基類負責提供既定回傳值,協議負責回傳值的靈活性;自訂環境位址不需要靈活性,放基類自然更合適。思路是大方向,實作可以變通,硬要放協議裡也行,只是得多複製幾次一樣的程式碼——而我個人最討厭看到一模一樣的程式碼,所以就放基類了。若有更好的方案歡迎提供。
model 提供的是高擴展性:針對不同服務器補上更多配置,比如加密方式、數據解析方式。前面提過,統一規範往往不是短期能做完的,兼容就成了需求,這時各服務器的個性化設定就可以在協議中宣告並實作,基類只負責回傳值。

網絡層數據傳遞
在我看來網絡請求分兩步:先整理數據,再生成 Request 並發起。基於這個想法我拆出了 Client 與 Engine,又把 URLRequestGenerator 從 Client 中獨立出來,Engine 則拆成下層的 BaseEngine 與面向不同業務的 DataEngine。而 BaseEngine → Client → URLRequestGenerator 這條鏈路上需要傳遞請求參數與返回參數,於是又有了 RequestDataModel。
RequestDataModel
@interface YAAPIBaseRequestDataModel : NSObject /** * 網絡請求參數 */ @property (nonatomic, strong) NSString *apiMethodPath; //網絡請求地址 @property (nonatomic, assign) YAServiceType serviceType; //服務器標識 @property (nonatomic, strong) NSDictionary *parameters; //請求參數 @property (nonatomic, assign) YAAPIManagerRequestType requestType; //網絡請求方式 @property (nonatomic, copy) CompletionDataBlock responseBlock; //請求著陸回調 // upload // upload file @property (nonatomic, strong) NSString *dataFilePath; @property (nonatomic, strong) NSString *dataName; @property (nonatomic, strong) NSString *fileName; @property (nonatomic, strong) NSString *mimeType; // download // download file // progressBlock @property (nonatomic, copy) ProgressBlock uploadProgressBlock; @property (nonatomic, copy) ProgressBlock downloadProgressBlock; @end
可以看到這些屬性全是發起請求與接收回調所必需的參數。這樣做的好處很大:不知道大家有沒有遇過那種場景——因為參數不同而寫了一堆對外方法,最後呼叫的其實是同一個;方法一多,連自己都不確定該調哪個了。我就遇過,所以現在我的調用方式變成:
//沒有回調,沒有其他的參數,只有一個dataModel,節省了你所有的方法 [[YAAPIClient sharedInstance] callRequestWithRequestModel:dataModel];
生成 NSURLRequest 也是一行:
NSURLRequest *request = [[YAAPIURLRequestGenerator sharedInstance] generateWithYAAPIRequestWithRequestDataModel:requestModel];
demo 裡的 YAAPIClient 與 YAAPIURLRequestGenerator 方法極少,方法少意味著邏輯簡單明瞭、易讀;兩個類都只有 120 行,就完成了請求的發起與著陸。
RequestDataModel 帶來的另外一個好處是高擴展性。你有沒有遇過網絡層要加減一個參數,結果得改方法、然後所有調用處跟著改?用 RequestDataModel 只需增減屬性、改方法體即可,不必動方法名。老實說這是我蠻得意的一個設計。
Client
Client 做兩件事:生成 NSURLRequest、生成 NSURLSessionDataTask 並發起,另外對 Engine 暴露取消操作。URLRequestGenerator 負責把 dataModel 加工解析成對應服務器的 NSURLRequest,Client 再依它建立 dataTask。Client 與 URLRequestGenerator 都是單例。
- (void)callRequestWithRequestModel:(YAAPIBaseRequestDataModel *)requestModel{ NSURLRequest *request = [[YAAPIURLRequestGenerator sharedInstance] generateWithRequestDataModel:requestModel]; AFURLSessionManager *sessionManager = self.sessionManager; NSURLSessionDataTask *task = [sessionManager dataTaskWithRequest:request uploadProgress:requestModel.uploadProgressBlock downloadProgress:requestModel.downloadProgressBlock completionHandler:^(NSURLResponse * _Nonnull response, id _Nullable responseObject, NSError * _Nullable error) { //請求著陸 }]; [task resume]; }取消接口參考了 Casa 大神的思路,用 NSNumber *requestID 與 task 做綁定,這裡不再展開。
BaseEngine/DataEngine
Engine(或說 APIManager)在我的設計裡既不是純離散也不是純集約。
Casa 大神的理論
集約型調用是所有 API 共用一個類,這個類接收 API 名稱、參數以及著陸點(target-action、block、delegate 皆可),然後執行類似 startRequest 的方法起飛,拿到數據後再依指定著陸點回來。例如:
[APIRequest startRequestWithApiName:@"itemList.v1" params:params success:@selector(success:) fail:@selector(fail:) target:self];
離散型則是一個 API 對應一個 APIManager,API 名稱與著陸方式都已內建,只要傳參數就能起飛。例如:
@property (nonatomic, strong) ItemListAPIManager *itemListAPIManager; // getter -(ItemListAPIManager *)itemListAPIManager { if (_itemListAPIManager == nil) { _itemListAPIManager = [[ItemListAPIManager alloc] init]; _itemListAPIManager.delegate = self; } return _itemListAPIManager; } // 使用的時候就這麼寫: [self.itemListAPIManager loadDataWithParams:params];各自的優點就不多說,但由此延伸出幾個問題:
1. 用字典傳參數對網絡層是不可知的,而業務層還得去關注接口欄位的變化,其實沒必要;
2. 離散型會造成 Manager 爆炸;
3. 集約型讓取消操作變得不便;
4. 取消並非每個接口都需要,若做成部分離散部分集約,整體結構會很難看——我有點強迫症,受不了那種程式碼。
我的設計主要就是解掉上面幾點。
1. 面向業務層的 DataEngine 只接收必要參數,不用字典
@interface SearchDataEngine : NSObject + (YABaseDataEngine *)control:(NSObject *)control searchKey:(NSString *)searchKey complete:(CompletionDataBlock)responseBlock; @end
control 先放著不管,它是給自動取消用的,後面再說;searchKey 就是搜尋關鍵字。調用方式:
self.searchDataEngine = [SearchDataEngine control:self searchKey:@"關鍵字" complete:^(id data, NSError *error) { if (error) { NSLog(@"%@",error.localizedDescription); } else { NSLog(@"%@",data); } }];2. 依業務劃分 DataEngine,例如 BBSDataEngine、ShopDataEngine、UserInforDataEngine,每個 DataEngine 收攏該業務的所有接口。這樣就不會出現 DataEngine 爆炸——我們專案有三百多個接口,拆完約十幾個 DataEngine;若用離散型設計,那畫面太美我不敢看。
3. BaseEngine 提供取消操作
每個接口產生一個 BaseEngine 實例,持有 Client 回傳的 requestID,取消自然就能做。常見用法:
#import "ViewController.h" #import "SearchDataEngine.h" @interface ViewController () @property (nonatomic, strong) YABaseDataEngine *searchDataEngine; @end @implementation ViewController - (void)viewDidLoad { [super viewDidLoad]; // Do any additional setup after loading the view, typically from a nib. [self.searchDataEngine cancelRequest]; self.searchDataEngine = [SearchDataEngine control:self searchKey:@"關鍵字" complete:^(id data, NSError *error) { if (error) { NSLog(@"%@",error.localizedDescription); } else { NSLog(@"%@",data); } }]; } @end4. 回傳的 YABaseDataEngine 實例並非一定要持有,只有需要取消時才去持有即可。
這樣就兼收了集約型與離散型的優點,又避開了兩者的缺點。
一個頁面的請求還在天上飛,使用者等得不耐煩點了 back,ViewController 被 pop 回收,此時請求的著陸點就消失了。這是相當危險的情況,著陸點沒了很容易 crash。
Casa 大神主張在 BaseDataEngine 的 dealloc 裡取消請求,這我也贊同;他還建議把 BaseDataEngine 綁定給 ViewController,跟著一起銷毀,這我也同意。但「任何情況都要在 ViewController 加一個變數來持有 BaseEngine」這點我實在無法接受,何況有些 ViewController 會發起兩三種請求,難不成要加兩三個變數?代碼入侵太大。所以這裡我用了個小技巧:透過 runtime 給 ViewController 掛一個字典,用來保存 requestID 與 BaseEngine,這樣 ViewController 就不必強迫宣告變數——這也是上面 DataEngine 要把 control 傳進來的原因。
發起請求時綁定:
[control.networkingAutoCancelRequests setEngine:self requestID:self.requestID];
請求完成時移除:
[weakControl.networkingAutoCancelRequests removeEngineWithRequestID:engine.requestID];
公司另一位同事的做法
control 這種寫法很方便,但若要把現有接口全部補上 control 欄位,改動量也不小。如果既有接口是用字典傳參給 DataEngine,可以借用記憶體位址當 key 來綁定:
NSString *memoryAddress = [NSString stringWithFormat:@"%p", self];
若像我這樣直接傳關鍵參數而非字典,這招就用不上了。
老實說,錯誤處理該放在哪一層,我糾結了很久,也和同事討論過好幾輪,最後定了一套方案,僅供參考。
我們把錯誤處理拆成兩步:錯誤解析與錯誤的 UI 展示。
我設計的接口回傳是標準的 id data, NSError *error,所以想法是讓 Client 就把 error 處理完整——不管是網絡超時還是數據格式錯誤,都統一解析好、把 code 定義清楚;上層依需要透過 code 決定具體的 UI 呈現。因為有的界面錯誤需要用戶點擊確認,有的只是一閃而過的提示框。把 error 的 UI 展示交給 BaseEngine 或 DataEngine 去做,所以我另外定義了一套 errorUI 枚舉,BaseEngine 拿到 error 後就依此呈現。
架構設計重在思路,希望大家能從中取精華去糟粕,最後收斂出最適合自己專案的方案。
這套設計應該还有不少可爭議之處,部分我已寫在文中,若有其他想法歡迎一起討論。
1. 關於 block
block 與 delegate 之間我毫不猶豫選 block,理由只有一個:block 的結構更好讀。光是這點我認為就足以蓋過它所有缺點,我現在的專案幾乎不太用 delegate 了。
什麼時候該自訂 delegate?當不同階段的回調超過 2 次(不含 2 次)時。3 次則看情況,要處理的邏輯少就用 block,多就用 delegate;一旦超過 3 次基本就不考慮 block 了。也希望大家別對 block 抱有成見,循環引用什麼的都是能解的,一個巨集就搞定,順手附上 strongSelf。這麼方便的巨集都不肯用,那是真的不適合 block。
#define WEAKSELF typeof(self) __weak weakSelf = self; #define STRONGSELF typeof(weakSelf) __strong strongSelf = weakSelf;
2. 交付給 ViewController 的是 model 還是 data?
這有什麼好爭的?有 DataEngine 在,交付什麼由你決定。底層的 BaseEngine 與 Client 用 data 比較合適;到了 DataEngine 層,看業務需求給什麼都行。有些接口本來就不含 model,你非要全部統一回傳 model,這不是扯淡嗎。所以我的建議是依接口實際情況來——我們專案因為有些接口不需要 model,日後就統一回傳 data。
3. 優化
這套設計只是基本思路,優化空間還很多,這部分就各顯神通了。不是藏私,而是目前專案對網絡層沒有太多優化訴求,我能做的部分又涉及敏感代碼,實在不好拆出來。不過可以給個小優化點:errorUI 的處理可以考慮做成隊列,比如需要用戶點擊確認、內容又都一樣的彈窗,放進隊列只顯示一次就好。
4. 為什麼業務層沒有用 RequestDataModel?
model 就是物件,下層主要做數據傳遞,用 model 沒問題;往上是業務層,那裡更強調方法調用,而且方法定義更有針對性,這時用 model 反而不合適。就像超市進貨用貨櫃一次拉貨,所有東西裝在一起;到了櫃台則要一件件分類擺好。