您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

iOS 源碼剖析——走進 Alamofire

編輯:iOS 開發基礎

關注倉庫,及時獲得更新:iOS-Source-Code-Analyze

GitHub 主頁上是這樣描述 Alamofire 的:Elegant HTTP Networking in Swift。

為什麼這次我選擇研讀 Alamofire 而非 AFNetworking?主要有兩點原因:

  • AFNetworking 是一款歷史悠久的框架,社區強大,但正因年頭太久,難免背著一些歷史包袱;而 Alamofire 誕生於 Swift 之後,至今時間不長,源碼整體頗為「新鮮」。

  • 我最近正好在寫 Swift 項目,於是順水推舟。

動手之前,我先粗略統計了一下 Alamofire 的代碼量:

$ find Source -name "*.swift" | xargs cat |wc -l > 3363

也就是說,即便算上注釋和空行,Alamofire 僅用三千多行就實現了一個 HTTP 請求框架,描述裡的那個 Elegant 可謂名副其實。

目錄結構

先看目錄結構,了解它是如何組織各文件的:

- Source - Alamore.swift - Core - Manager.swift - ParameterEncoding.swift - Request.swift - Features - Download.swift - MultipartFromData.swift - ResponseSeriallization.swift - Upload.swift - Validation.swift

其中最核心、最值得關注的是 Alamofire.swift、Manager.swift 和 Request.swift 這三個文件,本文也主要圍繞它們展開。

Alamofire

有意思的是,代碼裡並找不到名為 Alamofire 的類——它只是一個命名空間。Alamofire.swift 中並沒有 class Alamofire 這樣的聲明,這麼做只是為了讓方法名更簡潔。

我們使用時通常這樣調用:

Alamofire.request(.GET, "https://httpbin.org/get")

有了 Alamofire 這個命名空間,就再也不必擔心 request 方法與其他同名方法相互沖突了。

該文件為我們提供了三類方法:request、upload、download。它們都是通過調用 Manager 的對應操作來完成請求、上傳與下載,並返回一個 Request 實例。以 request 為例:

public func request(method: Method, URLString: URLStringConvertible, parameters: [String: AnyObject]? = nil, encoding: ParameterEncoding = .URL, headers: [String: String]? = nil) -> Request { return Manager.sharedInstance.request(method, URLString, parameters: parameters, encoding: encoding, headers: headers) }

這正是 Alamofire.request(.GET, "https://httpbin.org/get") 背後調用的方法。歸根結底,我們用的 request、download,不過是對 Manager 方法的包裝。

Manager

Alamofire 幾乎所有操作都由 Manager 掌控,它堪稱整個框架的核心,負責與 Request 交互以完成網絡任務:Responsible for creating and managing Request objects, as well as their underlying NSURLSession。

Manager.sharedInstance

Manager 地位舉足輕重,其設計中通常以 sharedInstance 獲取單例:

public static let sharedInstance: Manager = { let configuration = NSURLSessionConfiguration.defaultSessionConfiguration() configuration.HTTPAdditionalHeaders = Manager.defaultHTTPHeaders return Manager(configuration: configuration) }()

defaultHTTPHeaders 與初始化細節這裡略過,但有必要談談 SessionDelegate。Manager 的初始化過程中會調用 SessionDelegate 的初始化方法並取得其實例。

SessionDelegate

Responsible for handling all delegate callbacks for the underlying session. 它負責處理底層 session 的所有代理回調,持有兩個屬性:

private var subdelegates: [Int: Request.TaskDelegate] = [:] private let subdelegateQueue = dispatch_queue_create(nil, DISPATCH_QUEUE_CONCURRENT)

subdelegates 以 task 標識為鍵,存儲所有回調;subdelegateQueue 則是一個異步隊列,用於處理任務回調。

Manager.sharedInstace.request

Manager 有兩個返回 Request 實例的 request 方法:

  • public func request(method: Method, _ URLString: URLStringConvertible, parameters: [String: AnyObject]? = nil, encoding: ParameterEncoding = .URL, headers: [String: String]? = nil) -> Request

  • public func request(URLRequest: URLRequestConvertible) -> Request

第一個方法實現起來非常簡單:

public func request(method: Method, _ URLString: URLStringConvertible, parameters: [String: AnyObject]? = nil, encoding: ParameterEncoding = .URL, headers: [String: String]? = nil) -> Request { let mutableURLRequest = URLRequest(method, URLString, headers: headers) let encodedURLRequest = encoding.encode(mutableURLRequest, parameters: parameters).0 return request(encodedURLRequest) }

它先調用 URLRequest 方法:

func URLRequest(method: Method, URLString: URLStringConvertible, headers: [String: String]? = nil) -> NSMutableURLRequest { let mutableURLRequest = NSMutableURLRequest(URL: NSURL(string: URLString.URLString)!) mutableURLRequest.HTTPMethod = method.rawValue if let headers = headers { for (headerField, headerValue) in headers { mutableURLRequest.setValue(headerValue, forHTTPHeaderField: headerField) } } return mutableURLRequest }

先創建一個 NSMutableURLRequest,設置 HTTP 方法與 header 後返回。請求返回後,便進入編碼環節:

let encodedURLRequest = encoding.encode(mutableURLRequest, parameters: parameters).0

ParameterEncoding.encoding

ParameterEncoding 用來決定一組參數以何種方式「添加」到 URL 請求上:Used to specify the way in which a set of parameters are applied to a URL request. 它內含四種編碼方式:URL、JSON、PropertyList、Custom。encode 方法會依類型不同返回不同的 NSMutableURLRequest。若類型為 URL,則參數會以 foo[]=1&foo[]=2 這樣的形式拼接到 URL 上。編碼完成後,再調用另一個同名的 request 方法:

request(encodedURLRequest)

Manager.sharedInstace.request(URLRequestConvertible)

request 方法依指定的 URL 請求返回一個 Request:Creates a request for the specified URL request. 它用 dispatch_sync 把 NSURLRequest 同步加入一個串行隊列,取得 NSURLSessionDataTask,再憑 session 與 dataTask 生成 Request 實例:

public func request(URLRequest: URLRequestConvertible) -> Request { var dataTask: NSURLSessionDataTask! dispatch_sync(queue) { dataTask = self.session.dataTaskWithRequest(URLRequest.URLRequest) } let request = Request(session: session, task: dataTask) delegate[request.delegate.task] = request.delegate if startRequestsImmediately { request.resume() } return request }

這段代碼相當直觀,作用就是創建 Request 實例並發送請求。

Request.init

Request 的 init 方法會依傳入 task 的類型,生成不同種類的 TaskDelegate,可謂 Swift 中對反射的一次巧妙運用:

init(session: NSURLSession, task: NSURLSessionTask) { self.session = session switch task { case is NSURLSessionUploadTask: self.delegate = UploadTaskDelegate(task: task) case is NSURLSessionDataTask: self.delegate = DataTaskDelegate(task: task) case is NSURLSessionDownloadTask: self.delegate = DownloadTaskDelegate(task: task) default: self.delegate = TaskDelegate(task: task) } }

UploadTaskDelegate、DataTaskDelegate、DownloadTaskDelegate 與 TaskDelegate 各自負責處理對應任務的回調。Request 實例初始化後,會把相應的 delegate 加入 manager 持有的 delegate 數組,方便在合適的時機通知代理事件。返回 request 後,一次網絡請求便基本完成了。

ResponseSerialization

ResponseSerialization 是一個用於把 Response 返回值序列化展示的 extension,設計十分巧妙,能同時處理 Data、String 與 JSON 格式的數據。

ResponseSerializer 協議

文件開頭定義了所有 responseSerializer 都必須遵循的 protocol,其中最關鍵的是:

var serializeResponse: (NSURLRequest?, NSHTTPURLResponse?, NSData?) -> Result { get }

每個 responseSerializer 都必須包含 serializeResponse 這個閉包,用來處理 response。

GenericResponseSerializer

為了同時應對不同類型的數據,Alamofire 用泛型創建了 GenericResponseSerializer,為處理 JSON、XML、NSData 等數據的 serializer 提供了統一骨架。它遵循 ResponseSerializer 協議,並提供了一個 init 方法:

public init(serializeResponse: (NSURLRequest?, NSHTTPURLResponse?, NSData?) -> Result) { self.serializeResponse = serializeResponse }

response 方法

當我們調用 response 方法時,會在 request 結束時掛上一個處理器來處理服務器的 response。它有兩個版本,第一個不做任何數據處理:

public func response( queue queue: dispatch_queue_t? = nil, completionHandler: (NSURLRequest?, NSHTTPURLResponse?, NSData?, NSError?) -> Void) -> Self { delegate.queue.addOperationWithBlock { dispatch_async(queue ?? dispatch_get_main_queue()) { completionHandler(self.request, self.response, self.delegate.data, self.delegate.error) } } return self }

它把一個 block 追加到 request 所在隊列,其餘部分過於簡單,不再贅述。另一個版本則負責處理多種類型的數據:

public func response( queue queue: dispatch_queue_t? = nil, responseSerializer: T, completionHandler: (NSURLRequest?, NSHTTPURLResponse?, Result) -> Void) -> Self { delegate.queue.addOperationWithBlock { var result = responseSerializer.serializeResponse(self.request, self.response, self.delegate.data) if let error = self.delegate.error { result = .Failure(self.delegate.data, error) } dispatch_async(queue ?? dispatch_get_main_queue()) { completionHandler(self.request, self.response, result) } } return self }

它會直接調用參數中 responseSerializer 持有的 serializeResponse 閉包,再返回對應數據。

多種類型的 response 數據

有了這個高層抽象的 response 方法,我們只需傳入不同的 responseSerializer,就能得到不同數據類型的 handler。以 NSData 為例:

public static func dataResponseSerializer() -> GenericResponseSerializer { return GenericResponseSerializer { _, _, data in guard let validData = data else { let failureReason = "Data could not be serialized. Input data was nil." let error = Error.errorWithCode(.DataSerializationFailed, failureReason: failureReason) return .Failure(data, error) } return .Success(validData) } } public func responseData(completionHandler: (NSURLRequest?, NSHTTPURLResponse?, Result) -> Void) -> Self { return response(responseSerializer: Request.dataResponseSerializer(), completionHandler: completionHandler) }

在 ResponseSerialization.swift 中,你還能看到針對 String、JSON、propertyList 的 responseSerializer。

URLStringConvertible

Alamofire 的實現裡還藏著不少值得學習的巧思。由於 Swift 是靜態語言,NSURL 與 String 之間的相互轉換是繞不開的坑,而 Alamofire 給出了一個相當優雅的解法。先定義一個 protocol(已省略注釋):

public protocol URLStringConvertible { var URLString: String { get } }

遵循該協議的類必須實現返回 String 的 URLString。接著,讓所有能轉化為 String 的類型都遵循它——這種手法我以前知道,卻還是頭一回在實際項目中見到,著實令人拍案:

extension String: URLStringConvertible { public var URLString: String { return self } } extension NSURL: URLStringConvertible { public var URLString: String { return absoluteString! } } extension NSURLComponents: URLStringConvertible { public var URLString: String { return URL!.URLString } } extension NSURLRequest: URLStringConvertible { public var URLString: String { return URL!.URLString } }

這樣一來,String、NSURL、NSURLComponents、NSURLRequest 都能調用 URLString,我們也就能直接在方法簽名裡使用 URLStringConvertible 類型了。

End

至此,Alamofire 這個框架大致介紹完畢。整體實現依然簡潔而優雅,這篇 post 從開筆到現在拖了挺久,寫得也不算十分細緻。如果你對它的實現有興趣,不妨親手翻翻源碼,想必會有所收獲。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved