最近開源了一個面向協議(POP)設計的網絡請求庫 MBNetwork,它基於 Alamofire 和 ObjectMapper 實現,目的是簡化業務層的網絡請求操作。本文就來聊聊它的設計思路。
對於大多數 App 而言,業務層做一次網絡請求通常會關心以下幾件事:
之所以用面向協議的方式來寫 MBNetwork,主要基於以下幾點考慮:
很多人說 Alamofire 是 Swift 版的 AFNetworking,但在我看來 Alamofire 更「純粹」。AFNetworking 把很多 UI 相關擴展做進框架內,而 Alamofire 則把它們拆到獨立擴展庫(如 AlamofireImage)。MBNetwork 很大程度上借鑒了 Alamofire 的接口設計規範,值得學習的地方包括:
Alamofire 的請求分為 request、upload、download 三種,MBNetwork 把它們的參數抽象成對應的協議(見 MBForm.swift)。這樣做的好處是:像 headers 這類全局一致的參數可以直接用 extension 統一指定;協議名本身就表明了表單功能,簡單明確。
例如指定全局 headers:
extension MBFormable {
public func headers() -> [String: String] {
return ["accessToken": "xxx"];
}
}
創建具體業務表單:
struct WeatherForm: MBRequestFormable {
var city = "shanghai"
public func parameters() -> [String: Any] {
return ["city": city]
}
var url = "https://raw.githubusercontent.com/tristanhimmelman/AlamofireObjectMapper/2ee8f34d21e8febfdefb2b3a403f18a43818d70a/sample_keypath_json"
var method = Alamofire.HTTPMethod.get
}
要在任意位置發送請求,常見做法有單例、全局方法、協議擴展三種。MBNetwork 選擇了協議擴展,把網絡請求抽象成 MBRequestable 協議。它本身是一個空協議:
/// Network request protocol, object conforms to this protocol can make network request
public protocol MBRequestable: class { }
然後對它做 extension,實現一系列請求接口(request、download、upload 等),內部實際調用的是 Alamofire 對應的接口,並返回 DataRequest、UploadRequest、DownloadRequest 對象以支持後續鏈式調用。使用時,只需讓某個類型遵循 MBRequestable 即可在其內部發起請求:
class LoadableViewController: UIViewController, MBRequestable {
override func viewDidLoad() {
super.viewDidLoad()
request(WeatherForm())
}
}
加載環節主要關注:開始要做什麼、結束要做什麼、是否顯示遮罩、在哪顯示、顯示什麼內容。為此 MBNetwork 劃分了幾個協議:
containerView() 返回承載遮罩的 UIView。maskId 用於區分多種遮罩。其中 UIScrollView 作為容器時有個技巧:由於直接在其上加遮罩難以控制中心點,會遞歸向上尋找第一個非 UIScrollView 的 superview 作為容器。
public override func containerView() -> UIView? {
var next = superview
while nil != next {
if let _ = next as? UIScrollView {
next = next?.superview
} else {
return next
}
}
return nil
}
為了降低使用成本,還提供了 MBLoadType 枚舉(none 表示不加載,default 傳入容器),並讓它遵循 MBLoadable,方便常見場景直接取用。
針對常見控件,MBNetwork 做了貼心的定製:比如 UIControl(如 UIButton)加載時直接在按鈕上顯示「菊花」並在開始/結束時切換 isEnabled;UIRefreshControl 則調用 beginRefreshing/endRefreshing;UITableViewCell 類似於 UIControl 的處理方式。
由於請求方法都返回了 Request 對象,只需對它們做 extension,添加一個 load 方法即可把加載與請求結合起來:
func load(load: MBLoadable = MBLoadType.none) -> Self {
load.begin()
return response { (response: DefaultDataResponse) in
load.end()
}
}
使用起來非常直觀:
// 在 UIViewController 上顯示加載遮罩 request(WeatherForm()).load(load: MBLoadType.default(container: self)) // 在 UIButton 上顯示加載遮罩 request(WeatherForm()).load(load: button)
如果默認效果不滿足需求,還可以自定義:創建一個遵循 MBLoadable 的 LoadConfig,完全掌控遮罩、邊距與容器。
let load = LoadConfig(container: view, mask: MBEyeLoading(), inset: UIEdgeInsetsMake(30+64, 15, UIScreen.main.bounds.height-64-(44*4+30+15*3), 15)) request(WeatherForm()).load(load: load)
進度展示只需一個能實時更新進度的方法。MBNetwork 定義了 MBProgressable 協議,並只對 UploadRequest 和 DownloadRequest 添加 progress 方法。值得一提的是,它讓 UIProgressView 遵循了 MBProgressable:
extension UIProgressView: MBProgressable {
public func progress(_ progress: Progress) {
self.setProgress(Float(progress.completedUnitCount).divided(by: Float(progress.totalUnitCount)), animated: true)
}
}
這樣就能直接把 UIProgressView 傳給 progress 方法:
download(ImageDownloadForm()).progress(progress: progress)
信息提示分為出錯提示與成功提示。MBNetwork 抽象了 MBMessageable 協議(提供消息容器),並在此基礎上定義:
successCodes(正常狀態碼集合)、code(當前狀態碼)、message(展示文案)。配合 MBJSONErrorable(同時遵循 ObjectMapper 的 Mappable)即可把服務端返回的 JSON 映射為錯誤對象。show(error:) 方法。show() 與 message()。定義好錯誤對象後,只需短短幾行就能把提示邏輯接入請求:
class WeatherError: MBJSONErrorable {
var successCodes: [String] = ["200"]
var code: String?
var message: String?
init() { }
required init?(map: Map) { }
func mapping(map: Map) {
code <- map["data.code"]
message <- map["data.message"]
}
}
而 MBNetwork 讓 UIAlertController 遵循了 MBWarnable 與 MBInformable,於是業務層只需定義要展示的內容,剩下的自動展示就交給框架:
let alert = UIAlertController(title: "Warning", message: "Network unavailable", preferredStyle: .alert) alert.addAction(UIAlertAction(title: "Ok", style: .cancel, handler: nil)) request(WeatherForm()).warn(error: WeatherError(), warn: alert)


可以看到,MBNetwork 通過「一切皆協議」的設計,把表單、請求、加載、進度、提示等橫切關注點全部協議化,再借助協議擴展提供默認實現。業務層只需遵循相應協議、定義差異化內容,就能獲得既簡潔又高度可配置的網絡請求體驗。這種 POP 思路頗具借鑒意義,也為我們思考如何設計易用、可擴展的基礎庫提供了很好的範本。