
本文由 CocoaChina——BYB_1132(論壇 ID)翻譯
原文:Thoughts On AlamoFire — Swift's AFNetworking Implementation
HTTP 協議幾乎就是現代開發的同義詞,對有經驗的 iOS 開發者來說,熟悉並善用這些流行協議是日常工作的基礎。
不出意料,iOS 應用在這點上別無二致——成千上萬的 app 和工程師都依賴廣受歡迎的 AFNetworking 庫來實現與服務器的交互、JSON 解析、加載占位圖片等多項功能。
簡言之,做到這些並不容易。而本文要聊的是 Alamofire 庫。
基礎
Alamofire 的核心,是試圖簡化 iOS 中的 HTTP 網絡連接。它通過使用 NSURLSession 以及 Foundation URL Loading System,創建了一個 Swift 原生的網絡訪問接口,從而實現了極高的效率。
Swift 放棄了代理模式,改用回調。對我而言,我喜歡這個選擇。不過基於 Promise 的模式也能發揮作用,只是它們隱藏了一些「壞代碼味道」,對一些人來說顯得過於神奇。
進一步看,它是異步實現的。你也許聽說過,在主線程上執行網絡調用並不是好主意,而 Alamofire 採用了許多富有創造性的優化手段。例如通過 NSURLCache 處理緩存來阻止不必要的請求;此外,若 HTTP 狀態碼在可接受范圍內(200–300),就能利用其豐富的鏈式模式,用少量代碼完成大量有意義的工作。
歷史總在重復
Alamofire 也承續了 AFNetworking 使用者所熟悉的模式,只是部分處理方式不同於前身,主要因為它是為 Swift 而生的。
例如,AFNetworking 通過調用子類 AFHTTPSessionManager 來使用每個 API(也有例外,比如用 NSURLSession 替換 NSURLConnection)。而 Alamofire 則通過遵守 URLRequestConvertible 協議創建一個路由 Router 來實現類似做法;在底層,Alamofire 使用單例模式來創建基於 NSURLSessionConfiguration 的頂層對象。
初體驗
我們開始吧:
Alamofire.request(.GET, "https://www.telize.com/jsonip?callback=getip").response { (request, response, data, error) in
println(request + response + error)
}像 AFNetworking 和其他 HTTP 網絡庫一樣,Alamofire 提供了簡單易用的方法來快速發起網絡請求。這種特定的 GET 請求會返回一個請求對象,這個對象可以掛接實現整個 HTTP 過程的方法。
在 Alamofire 中,默認行為是把服務器響應積累到 NSData(數據),我通過一個閉包鏈接響應處理程序來解析響應,但願任何錯誤都不會發生在請求過程中。
響應
響應通過 HTTP 以不同形式呈現,最受青睞的毫無疑問是 JSON。JSON 是 XML 的衍生品,相對更年輕、更健壯,Alamofire 對 JSON 數據非常友好:
Alamofire.request(.GET, "https://httpbin.org/get").responseJSON { (request, response, JSON, error) in
println(JSON)
}我們繼續。在 Alamofire 中,鏈式調用是其框架使用中的一大特色,每當想到在 OC 中用方括號調用方法,總讓人既高興又無奈。Swift 像其他大多數高級語言一樣,通過簡單的「.」來調用函數。Alamofire 可以掛接很多響應處理程序,而且一旦服務器返回響應,它們都會異步執行。和往常一樣,看示例最可靠:
Alamofire.request(.GET, "https://httpbin.org/get")
.authenticate(HTTPBasic: user, password: password)
.progress { (bytesRead, totalBytesRead, totalBytesExpectedToRead) in
println(totalBytesRead)
}.responseJSON { (request, response, JSON, error) in
println(JSON)
}.responseString { (request, response, string, error) in
println(string)
}參數
當然,如果 HTTP 網絡請求缺少了 POST 請求或指定查詢參數的能力,那就沒那麼令人期待了:
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["key": "value"])
在 Alamofire 中需要內嵌一個包含參數的字典,若不指定特定參數,則傳 nil。編碼方式也一樣,是網絡請求函數的第四個參數。
枚舉
用過 Swift 的人可能會發現枚舉在 Swift 中是多麼好用。在 Objective-C 中,即使有現代化的 NS_ENUM,它本質上仍只是允許定義整數聲明。而 Swift 提供了更多技巧。
Alamofire 充分利用了這些技巧:在一個 HTTP 通信中,所有編碼參數的邏輯都用 ParameterEncoding 枚舉實現,所有 HTTP 動詞則按 RFC 2616 §9 定義:
public enum Method: String {
case OPTIONS = "OPTIONS"
case GET = "GET"
case HEAD = "HEAD"
case POST = "POST"
case PUT = "PUT"
case PATCH = "PATCH"
case DELETE = "DELETE"
case TRACE = "TRACE"
case CONNECT = "CONNECT"
}順帶一提,如果你好奇 Swift 枚舉的強大功能,可以免費下載 Swift Starter Guide(請原諒我這個小廣告)。
路由
創建網絡訪問路由是實現的關鍵。在這裡,我們會定義一些共用於同一個 API 的端點,通過一個遵循 URLRequestConvertible 的枚舉來創建路由。
當一個枚舉遵循 URLRequestConvertible 時,它需要包含一個名為 URLRequest 的變量,且必須是 NSURLRequest 類型。
對於 HTTP 網絡庫的通常做法發生在這裡:使用者極有可能定義一個靜態字符串代表基礎 URL 以及 API key/consumer secret。記住,現實世界中最好不要把這些內容散落在源代碼裡,我個人選擇放在 plist 文件中。
無論如何,工作流如下:
定義一個基本 URL
通過枚舉中的 case 語句定義端口(如 Users、Comments 等)
URLRequest 初始化並通過一個跟蹤閉包設置;在閉包中增加參數並構造端點
URL、URLRequest 和編碼共同構成一個完整的網絡請求發送到服務器
多讀幾遍——首先,我認為這一點有些不合理:一個函數實現了過多功能。但在實踐中,它運作得很好:
enum APIRouter: URLRequestConvertible {
static let BASE_URL = // base url
static let API_KEY = // api key, consumer secret for OAuth, etc
case User(Int)
case ProfilePicture(Int, Size)
case Likes(Int, Int)
var URLRequest: NSURLRequest {
let (path: String, parameters: [String: AnyObject]) =
{
switch self {
case .User (let page):
let params = [] // Provide params
return ("/user", params)
case .ProfilePicture(let id, let size):
var params = []
return ("/profilepictures/\(id)", params)
case .Likes(let id, let commentsPage):
var params = []
return ("/likes/\(id)/user", params)
}
}()
let URL = NSURL(string: APIRouter.BASE_URL)
let URLRequest = NSURLRequest(URL: URL!.URLByAppendingPathComponent(path))
let encoding = Alamofire.ParameterEncoding.URL
return encoding.encode(URLRequest, parameters: parameters).0
}
}一個很有力的例子,但我更傾向於把代碼寫得更形象一些。
豐富的功能
Alamofire 有許多讓程序員願意使用它的理由。在 iOS 開發中,NSURLSession 是 HTTP 網絡的未來趨勢,相比 NSURLConnection 功能更加豐富:
支持後台上傳和下載
可暫停並重新開始網絡操作
可配置的容器(Container)
子類和私有存儲
改進的認證處理
對每個基礎連接進行身份驗證
多種代理模式——NSURLConnection 擁有異步代碼塊的基本方法,但不能用它們的代理;NSURLSession 則提供了一種混合型方法。
我想大家都同意這是正確的選擇。如果有人關心 AFNetworking 能做而 Alamofire 不能做的事,那麼有以下幾點:
UIKit 擴展
TLS 驗證
NSOperation / NSURLConnection / AFURLConnectionOperation 調用
可達性(Reachability)
多重 HTTP 網絡請求構架
是否使用取決於具體場景——需要這些特性的,要麼是破壞規則的人,要麼是毫不在意的人。
總結
在這一點上,部分工程師爭論認為 NSURLSession 讓 AFNetworking 變成了一個華麗的封裝。這在某種程度上可能沒錯,但即便如此——這是一件壞事嗎?
它在簡化和抽象方面做得很好,雖然並不包含 AFNetworking 能做的所有功能,但這是 Swift 中 HTTP 網絡的一個良好開端。