iOS 網路層架構設計分享

前些天幫公司做了網路層的重構，當時就想做好了就分享給大家，後來接著做了新版本的需求，現在才有時間整理一下。

之前的網路層使用的是直接拖拽匯入專案的方式匯入了AF，然後還修改了大量的原始碼，時隔2年，AF已經更新換代很多次了，導致整個重構遷移非常的麻煩。不過看著前輩寫的程式碼，肯定也是一個高人，許多思路和我的一樣，但是實現方式又不同，給我很好的參考。

在做網路層架構的時候也參考了Casa大神的架構思想，但是還是有所不同。

本文沒有太多的理論，沒有太多的專業術語，一來是方便大家閱讀，二來我的基礎也沒那麼好，沒有太多華麗的詞彙，對於架構來說主要是思路，有思路在，具體的實現就沒有問題了

本文主要介紹以下幾點：
1.網路介面規範
2.多伺服器多環境設定
3.網路層資料傳遞（請求和返回）
4.業務層對接方式
5.網路請求怎麼自動取消
6.網路層錯誤處理

無Demo無文章 Demo下載

網路介面規範

demo裡面的請求示例是在網上找的，不符合我說的這套規範，僅作示例用。

規範很重要，有合理的規範就可以精簡很多程式碼邏輯，特別是介面的相容，是最底層最基礎的設計，把介面規範放在前面來說。

在做這次重構時，我提出了一些規範點，可以給大家參考

1.兩層三部分資料結構

介面返回資料第一次為字典，分為兩層三部分：code、msg、data

code：錯誤碼，可以記錄下來快速定位介面錯誤原因，可以定義一套錯誤碼，比如200正常，1重新登入…
msg：介面文案提示，包括錯誤提示，用來直接顯示給使用者，所以這一套錯誤提示就不能是什麼一串英文錯誤了
data：需要返回的資料，可以是字典，可以是陣列

介面幫我們定義了code和msg，是不是我們就不需要做錯誤處理了？當然不是，服務端的錯誤邏輯畢竟是簡單的，具體到data裡面的資料處理可能還有錯誤，所以錯誤的處理是必不可少的，下面會單獨對錯誤處理做介紹

2.網路請求引數上傳方式統一

這裡一般都能做到，也有額外的，比如我們的一個伺服器介面做的比較早，當時POST介面使用的就不規範，普通的應用資訊channelID、device_id使用的是拼接在字串後面的方式，而真正的請求引數則需要轉成json放在一個欄位裡面傳遞，就是介面GET、POST並存的方式，造成網路層需要做特殊處理

所以說標準的GET、POST請求方式是很有必要的

3.關於Null型別

大家都知道Null型別在iOS裡面是很特殊的，我的建議是放在客戶端來做，原因有很多：
1）介面的規範定義並不是每個公司都是從一開始就能定義好的，老介面如果要把Null欄位去掉的改動非常大
2）客戶端用過一個介面過濾也可以解決，一勞永逸，不用再擔心因為某天介面的問題出現崩潰，而且通過一些Model的第三方庫也可以很好的解決這個問題。這裡不得說下swift的型別檢測真是太方便了，之前一個專案用swift寫的，程式碼規範一點，根本不會出現因為引數型別問題引起崩潰

多伺服器多環境設定

這部分基本上是照搬casa大神的設計，這裡我延伸了一個多環境的設計，小的專案一般都是一個伺服器，但是像淘寶之類的專案一個伺服器顯然是不可能的，多個伺服器的設計還是非常普遍的。根據一個列舉變數通過ServerFactory單例生成獲取對應的伺服器配置

1.伺服器環境

標準的APP是有4個環境的，開發、測試、預發、正式，特別是伺服器的程式碼，不能說所有的程式碼更改都在正式環境下，應該從開發->測試->預發->正式做程式碼的更新，開發就是新需求和優化的時候的更改，測試就是提交給測試人員後的更改，這個時候更改是在一個新的分支上，完成後要和合併到測試分支上併合併到開發分支上，預發這時候的變動就比較小了，一般會在測試人員完成後釋出給全公司的人來測試，有問題了才會更改，更改後同樣合併到開發分支，正式則是線上釋出版本的緊急BUG修復，修改完後同樣合併到開發分支上。所以開發分支是一直都是最新的。在此基礎上可能會有其他的環境，比如hotfix環境，自定義的h5/後臺本地除錯的環境。
客戶端同樣存在這些環境，並且要提供切換的入口。

在我的demo中提供了兩套設定，一套是第一次安裝應用的初始化環境（巨集定義），另外是手動切換環境的設定(列舉EnvironmentType)。這裡有一個比較繞的邏輯，巨集定義的正式環境設定高於手動切換環境設定，手動切換環境設定高於巨集定義其他環境

所以當巨集定義正式環境存在的時候是不能手動切換環境的，用於普通使用者的釋出版本，但是其他巨集定義環境時是可以切換到正式環境的。

半個坑
另外手動切換自定義的環境是在基類中實現的，而其他的環境配置是在協議中實現的，這就和其他環境地址的配置不統一了。
可以這樣理解，這裡的基類是為了提供已返回值，協議是為了返回值的靈活，既然自定義環境的地址配置不需要靈活性，自然是放在基類好。思路是大方向，實現是靈活的，如果非要放在協議中實現也無不可以，無非是賦值貼上幾次一樣的程式碼，但是一模一樣的程式碼是我最不喜歡看到的，所以就放在基類了。如果有更好的解決方案歡迎提供

2.擴充套件性

model提供的是高擴充套件性，針對不同的不伺服器新增更多的配置，比如加密方法，比如資料解析方法…前面提到了，統一的規範有的時候不是一時半會就能做好的，相容就成了需求，這個時候不同伺服器的個性化設定就可以在協議中宣告並實現了，基類提供返回值就好

網路層資料傳遞（請求和返回）

Client、BaseEngine/DataEngine、RequestDataModel資料傳遞

網路請求的發生在我理解中分兩步，一步是資料的整理，一步是生成Request併發起請求，基於這個思想我拆分出了Client和Engine，然後又把URLRequestGenerator從Client中拆分出來，Engine拆分出了下層的BaseEngine和麵向不同業務的DataEngine，
而從BaseEngine到Client，再到URLRequestGenerator是要做資料傳遞的，請求引數和返回引數，所以又有了RequestDataModel

RequestDataModel

可以看出來RequestDataModel屬性都是網路請求發起和返回的必要引數，這樣做的好處真的是太大了，不知道大家有沒有這樣的場景：因為請求引數的不同做了好多方法介面暴露出去，最後調起的還是同一個方法，而且一旦方法寫的多了，最後連應該呼叫哪個方法都不知道了。我就遇到過，所以現在我的網路請求調起是這樣的：

生成NSURLRequest是這樣的：

可以看到我的demo裡面的YAAPIClient類和YAAPIURLRequestGenerator類方法至少，方法少就意味著邏輯簡單明瞭，方便閱讀，兩個類的程式碼行數都是120行，120行實現了網路請求的發起和著陸，你能想象嗎

另外RequestDataModel帶來的另外一個好處就是高擴充套件性，你有沒有遇到網路層需要新增刪除一個引數導致呼叫方法修改了，然後很多地方都要修改方法？用RequestDataModel只需要新增刪除引數就行了，只需要改方法體，這個改方法體和同時改方法名方法體是完全兩個工作量。哈哈，有點賣虎皮膏藥的感覺。這個的確是我的得意創新點。

Client

Client做兩個操作，一個是生成NSURLRequest，一個是生成NSURLSessionDataTask併發起，另外還要暴露取消操作給Engine，URLRequestGenerator是生成NSURLRequest，URLRequestGenerator會對dataModel進行加工解析，生成對應伺服器的NSURLRequest
然後Client通過NSURLRequest生成NSURLSessionDataTask。

Client和URLRequestGenerator都是單例

取消介面參考了casa大神的設計，使用NSNumber *requestID來做task的繫結，就不多做介紹了

BaseEngine/DataEngine

Engine或者說是APIManager在我的設計中既不是離散的也不是集約的

casa大神的理論
集約型API呼叫其實就是所有API的呼叫只有一個類，然後這個類接收API名字，API引數，以及回撥著陸點（可以是target-action，或者block，或者delegate等各種模式的著陸點）作為引數。然後執行類似startRequest這樣的方法，它就會去根據這些引數起飛去呼叫API了，然後獲得API資料之後再根據指定的著陸點去著陸。比如這樣：

[APIRequest startRequestWithApiName:@"itemList.v1" params:params success:@selector(success:) fail:@selector(fail:) target:self];

1	[APIRequest startRequestWithApiName:@"itemList.v1" params:params success:@selector(success:) fail:@selector(fail:) target:self];

離散型API呼叫是這樣的，一個API對應於一個APIManager，然後這個APIManager只需要提供引數就能起飛，API名字、著陸方式都已經整合入APIManager中。比如這樣：

@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 3 4 5 6 7 8 9 10 11 12

@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.離散型API會造成Manager大爆炸
3.集約型會造成取消操作不方便
4.取消操作並不是每個介面必須的，如果寫成部分離散的部分集約的，程式碼的整體結構…我是個有強迫症的人，看不得這樣的程式碼

所以我的設計主要就解決了上面的這些問題

1.面向業務層的DataEngine只傳遞必要的引數進來，不使用字典,比如

control暫時先不管，是做自動取消的，後面再介紹。
searchKey就是搜尋的關鍵字

在呼叫的時候就是這樣

2.我按業務層來劃分DataEngine，比如BBSDataEngine、ShopDataEngine、UserInforDataEngine…每個DataEngine裡面包含各自業務的所有網路請求介面，這樣就不會出現DataEngine大爆炸，像我們的專案有300多個介面，拆分後有十幾個DataEngine，如果使用離散型API設計，那畫面太美我不敢看?

3.BaseEngine提供取消操作

每個介面生成一個BaseEngine例項，持有Client返回的requestID，所以就可以做取消操作，簡單的使用場景

4.返回的YABaseDataEngine例項ViewController不是必須持有的，當有需要取消操作的時候再去持有就行了

這樣的設計就整合了集約型和離散型的有點，又解決了集約型和離散型的缺點

網路請求怎麼自動取消

當一個頁面的請求正在天上飛的時候，使用者等了好久不耐煩了，小手點了個back，然後ViewController被pop被回收。此時請求的著陸點就沒了。這是很危險的情況，著陸點要是沒了，就很容易crash的。

casa大神說在BaseDataEngine的dealloc裡面做取消網路請求操作，我也是這樣想的，但是casa大神說要把BaseDataEngine繫結給ViewController，當ViewController銷燬時BaseDataEngine也就跟著銷燬了，這樣我也是同意的，但是要讓我不管什麼情況都要給ViewController新增BaseDataEngine變數來儲存BaseDataEngine這是我萬萬不能接受的，而且有的ViewController會發起兩三種網路請求，難道要我新增兩三個變數？程式碼入侵太大，所以這裡偷偷使用了一個巧，使用了runtime，給ViewController新增一個字典，來儲存requestID和BaseDataEngine，這樣對於ViewController來說就不是必須要寫變數來持有BaseDataEngine了，所以就出現了上面的DataEngine裡面要把control傳遞進來的樣子

在發起請求的時候進行繫結

在請求完成的時候進行刪除

公司上個大神的做法

雖然使用control的做法很方便，但是如果說要把現在已有的介面都新增一個control欄位的工作量也是很大的，如果已有的介面是使用字典傳遞給DataEngine的，這裡給大家一個公司上個大神的做法，使用記憶體地址，將記憶體地址新增到字典中去，用記憶體地址做key繫結，也是可以的。如果是像我這樣直接把關鍵引數傳遞過來的，不是用的字典，就不行了。

網路層錯誤處理

說實話，錯誤處理該放在按個地方我也是糾結了好久，也和公司同事討論了好久，最終定下來了一套方案，僅供大家參考。
我們將錯誤處理分為兩個步驟，一個是錯誤解析，一個是錯誤的UI展示。

大家可以看到我設計的介面返回資料是標準的id data, NSError *error,所以我的想法是Client就把error處理好，不管你是網路超時錯誤也好，或者是資料格式不正確也好，都error解析完整，把code錯誤碼定義好，上層根據需要通過code來做具體的UI展示，因為有的介面的錯誤需要使用者的點選確認，有的頁面的錯誤只是一閃而過的提示框，把error交給BaseEngine或者DataEngine來處理errorUI，所以我定義了一套errorUI的列舉，當BaseEngine拿到error的時候就去做錯誤的展示

結

架構的設計更多的是思路，我希望的是大家能通過我們提供的思路取其精華去其糟粕，總會設計會最適合你的專案的架構的

另外我的這套設計存在的爭議的點可能會有很多，有一部分我已經在文中提到了，如果大家有什麼其他的想法我們再討論

1.關於block

對於block和delegate的選擇，我更傾向於block，只有一個原因，因為block的結構更方便閱讀，這一個優點我覺得足以秒殺他所有的缺點，可以這樣說，我現在的專案基本上很少用到delegate了。

什麼時候自定義delegate？就是當你的不同時期的回撥超過2次的時候(不包含2次)，3次回撥就看情況了，如果要處理的邏輯比較少就使用block，多的話就使用delegat，一旦超過3次，基本上就不會考慮block，希望大家也不要對block存在偏見，延遲生命週期什麼的都是可以解決的，一個巨集定義就解決了,順便給出strongSelf，如果這麼方便的巨集都不願意使用，那是真的不適合用block了，誰也救不了你

2.交付什麼樣的資料給ViewController？是model還是data

這個有什麼好爭議的嗎？有DataEngine在，交付什麼樣的資料還不是你說了算。

底層的BaseEngine和Client當然還是data比較合適，到了DataEngine層，你想交付什麼樣的資料就交什麼樣的資料，可以看業務層的需求，有的介面根本就不包含model，你非要統一所有的介面都返回model這不是扯淡嗎，所以我的建議是根據介面的實際情況來，統一規範，我們的設計因為有些介面是不需要model的，以後就統一返回data

3.優化

我的這套設計只是基本思路，還有很多優化的點，我知道。

這部分就是各顯神通的地方了，不是我藏私，而是現在的專案對於網路層沒有太多的優化點，所以我也沒做太多，做的部分敏感程式碼太多，實在是沒辦法拆出來，不過可以告訴大家一個小的優化點，errorUI的處理可以考慮做成佇列，比如需要使用者點選確定的彈出框，而且內容都是一樣的，放在佇列裡面只顯示一次就好

4.為什麼業務層沒有使用RequestDataModel

model就是物件，下層主要是用來做資料傳遞的，用model沒有問題；而向上到業務層的時候，更多的理念是方法的呼叫，而且方法的定義更有針對性，這個時候用model就不合適了。就好像超市一樣，進貨的時候是使用集裝箱拉貨的，所有的東西都裝在一起，當到櫃檯的時候就會一個個的分類擺好。

打賞支援我寫出更多好文章，謝謝！

打賞作者