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

AFNetworking 究竟做了什麼?源碼層面的答案

編輯:iOS 開發基礎

寫在開頭:

  • 作為一名 iOS 開發,你也許不知道 NSURLRequest、NSURLConnection、NSURLSession……(說不下去了,怎麼會什麼都不知道……)但你一定知道 AFNetworking。
  • 大多數人只要發網路請求就上 AF,但你真的知道 AF 做了什麼嗎?為什麼我們不用原生的 NSURLSession 而選擇 AFNetworking?
  • 本文將從原始碼出發,分析 AF 的實際作用。或許讀完這篇,你心裡會有答案。

先從最新的 AF 3.x 講起。

框架組成

把 AF 下載導入工程後可以看到,相比 2.x,3.x 的包結構變得非常簡單。

AF 程式碼結構圖

除去 Support Files,AF 分為五個功能模組:

  • 網路通信模組(AFURLSessionManager、AFHTTPSessionManager)
  • 網路狀態監聽模組(Reachability)
  • 網路通信安全策略模組(Security)
  • 網路通信資訊序列化 / 反序列化模組(Serialization)
  • 對 iOS UIKit 庫的擴展(UIKit)

核心自然是網路通信模組。AF 3.x 基於 NSURLSession 封裝,AFURLSessionManager 圍繞它做了一系列封裝;其餘四個模組都是為了配合網路通信,或對 UIKit 的擴展。

AF 架構圖

其中 AFHTTPSessionManager 是我們平時做請求最常用的類,但它本身並不「做實事」,只是把請求邏輯分發給父類 AFURLSessionManager 或其他類去執行。

初始化:一切從 manager 開始

寫一個最簡單的 GET 請求,先建立 manager:

AFHTTPSessionManager *manager = [[AFHTTPSessionManager alloc] init];

點進初始化方法,會發現一連串 init 最終都彙集到 initWithBaseURL:sessionConfiguration:。它做了幾件事:

  • 呼叫父類(AFURLSessionManager)的初始化;
  • 對傳入的 baseURL 做處理,若 path 非空且結尾沒有斜槓,則補上一個;
  • 建立請求序列化物件 AFHTTPRequestSerializer 與響應序列化物件 AFJSONResponseSerializer。

再往下走進父類 AFURLSessionManager 的初始化,這是 AF 3.x 最關鍵的一段設定:

  • 若未傳入 configuration,則預設使用 NSURLSessionConfiguration defaultSessionConfiguration;
  • 建立 operationQueue 並把 maxConcurrentOperationCount 設為 1,這個 queue 就是後續所有代理回調所在的 queue(為什麼設為 1,講完 AF 2.x 之後再分析);
  • 用該 configuration、以 self 為 delegate、以該 queue 為 delegateQueue 建立 NSURLSession——注意 delegate 的繼承關係,NSURLSession 會自行判斷你實作了哪些代理方法(包括子代理的方法)並呼叫;
  • 建立響應序列化物件與預設安全策略 AFSecurityPolicy defaultPolicy,以及網路狀態監聽 manager;
  • 建立 mutableTaskDelegatesKeyedByTaskIdentifier 字典,用來把每個 NSURLSessionTask 映射到一個自訂的 AFURLSessionManagerTaskDelegate——這是 AF 相當重要的一塊設計,後文細講;
  • 建立一把 NSLock 並命名,確保這本字典在多執行緒訪問時的執行緒安全;
  • 呼叫 getTasksWithCompletionHandler:,把 session 中可能殘留的未完成 task 所綁定的 delegate 全部清空。

關於最後這一步:理論上剛初始化的 session 裡不會有 task,下斷點驗證也確實如此,陣列都是空的。但設想一下重複初始化的極端情況——新的 session 指向了帶有未完成 task 的舊 session,為了排除這種不確定性,索性在初始化時把綁定的 delegate 全部置空。這大概算是防禦式編程的一種體現。

請求:從 GET 到 NSURLSessionDataTask

GET 方法本身很直白:呼叫父類的 dataTaskWithHTTPMethod:... 生成一個系統的 NSURLSessionDataTask,然後 resume 開始請求。

進入 dataTaskWithHTTPMethod:...,它做了兩件事:

  1. 用 requestSerializer 把 method、URL、parameters 等組裝成一個 NSMutableURLRequest;若序列化出錯,直接透過 completionQueue(未設置則為主佇列)回呼 failure 並返回 nil;
  2. 呼叫 dataTaskWithRequest:... 取得最終的 dataTask,並在 completionHandler 中把結果分發到外部傳入的 success / failure。

順帶一提,這裡常見的 #pragma clang diagnostic push / ignored "-Wgnu" / pop 組合,是用來屏蔽三元運算子相關的編譯器警告。

注意,這個方法仍然沒「做實事」,真正的 request 組裝在 AFURLRequestSerialization 裡。

請求序列化:request 是怎麼拼出來的

requestWithMethod:URLString:parameters:error: 做了三件事:

1. 設置請求方法。先用 NSParameterAssert 對 method、URLString、url 做断言(debug 下缺參數直接 crash),建立 mutableRequest 並指定 HTTPMethod。

2. 把序列化器上被改過的屬性同步到 request。這裡有個頗有意思的設計:AFHTTPRequestSerializerObservedKeyPaths() 回傳一個包含 allowsCellularAccess、cachePolicy、HTTPShouldHandleCookies、HTTPShouldUsePipelining、networkServiceType、timeoutInterval 等 keyPath 的陣列;初始化時遍歷這些 keyPath,對自己 addObserver,並在 KVO 回調中把「被改動過且值不為 NSNull」的 keyPath 記到 mutableObservedChangedKeyPaths 集合裡。組裝 request 時再遍歷該集合,用 KVC 把這些值搬到 request 上。這樣使用者對序列化器屬性的設置,就能精確同步到每個 request。

3. 編碼參數並寫入 request。呼叫 requestBySerializingRequest:withParameters:error::先把 HTTPRequestHeaders 中的自訂 header 逐個補上(request 已有值則跳過);再把 array / dictionary / set 等容器類型的 parameters 轉成 query 字串——可以自訂 queryStringSerialization,也可以用預設實作。

預設實作由三個 C 函數配合完成:AFQueryStringFromParameters 負責把 key-value pair 逐個 URL 編碼後用 & 拼接;AFQueryStringPairsFromKeyAndValue 則遞迴處理嵌套結構:遇到 NSDictionary 就把 key 拼成 key[nestedKey] 的形式(並按 description 排序以保證輸出順序穩定),遇到 NSArray 就拼成 key[],遇到 NSSet 則排序後逐一處理,直到剝出普通值為止。最終結果類似:

原始字典 → name=bang&phone[mobile]=xx&phone[home]=xx&families[]=father&families[]=mother&nums=1&nums=2

最後依請求方法決定 query 放哪:GET / HEAD / DELETE 會把 query 拼到 URL 後面;POST / PUT 則寫進 HTTPBody,並補上預設的 Content-Type: application/x-www-form-urlencoded(空字串也是合法的 payload)。至此,一個完整的 request 就誕生了。

分割圖

分割圖

任務創建與 iOS 8 的坑

回到 dataTaskWithRequest:...,它做的事出乎意料地簡單:呼叫一個包裝過的 C 函數創建 dataTask,然後呼叫 addDelegateForDataTask:... 掛上 delegate。

值得注意的是 url_session_manager_create_task_safely():它會判斷 Foundation 版本,在存在某個已知 bug 的 iOS 8 早期版本上,用 dispatch_sync 把 [self.session dataTaskWithRequest:request] 放到一條串行佇列中執行;其他版本則直接執行。

原因很有趣:iOS 8 以下版本中,NSURLSession 內部建立 task 是並發的,偶爾會導致 taskIdentifier 不唯一——而 taskIdentifier 正是後續映射 delegate 的字典 key,必須唯一。用串行佇列同步創建即可規避。這裡也順帶說明了一件事:很多同學抱怨 dispatch_sync 用不到,其實很多東西不是沒用,只是你還想不到怎麼用。

另外,dataTaskWithHTTPMethod:... 中的 completionQueue 也值得一說:它是自訂的 GCD queue,設置了就在該佇列回調結果,否則回主佇列。對於有自研加解密解析流程的團隊很有用——可以在子執行緒完成資料解析,再自行切回主執行緒刷新 UI。

AF 自訂 delegate:task 與代理的映射

addDelegateForDataTask:... 會建立一個 AFURLSessionManagerTaskDelegate(AF 自訂的代理),把 manager 與 completionHandler 掛上去,為 dataTask 設置 taskDescription(用於發送開始與掛起通知時的對應),然後呼叫 setDelegate:forTask: 建立映射,最後設置上傳 / 下載進度 block。

setDelegate:forTask: 的關鍵動作是:加鎖,把 delegate 存進以 task.taskIdentifier 為 key 的字典(同一個 NSURLSession 內 taskIdentifier 唯一),然後為 delegate 配置進度監聽並註冊 task 的開始 / 暫停通知,最後解鎖。加鎖的原因很直接——這本字典是可變的、非執行緒安全,而相關呼叫確實可能發生在複雜的多執行緒環境中。

setupProgressForTask: 做的事也很清晰:

  • 用 task 的 countOfBytesExpectedToSend / countOfBytesExpectedToReceive 初始化 uploadProgress 與 downloadProgress 的 totalUnitCount;
  • 把兩個 NSProgress 與 task 的生命週期綁定:cancel / suspend / resume 進度物件時,會同步對 task 執行 cancel / suspend / resume;
  • 對 task 的 countOfBytesReceived、countOfBytesExpectedToReceive、countOfBytesSent、countOfBytesExpectedToSend 以及兩個 progress 的 fractionCompleted 添加 KVO 監聽。

KVO 回調做的事非常直白:task 的字節數變化時,把新值賦給對應的 progress;而賦值又會觸發 progress 的 KVO,於是呼叫外部傳入的 downloadProgressBlock / uploadProgressBlock,實現進度的即時傳遞。這種「task → progress → block」的解耦方式頗值得品味。

還有一點需要留意:這套進度監聽都在 AF 自訂 delegate 內部,一個 task 對應一個 delegate,因此每個 task 都在各自的 delegate 裡獨立監聽自己的屬性。

代理方法的轉發機制

初始化時,AFURLSessionManager 把自己設成了 session 的 delegate。發起請求後,一大票 NSURLSession 相關代理方法都會落到它身上。

NSURLSession 的代理

AF 實作了這麼多代理,但只把其中三條轉發到 AF 自訂的 delegate,由其負責把每個 task 的資料回調出去;剩下的則由 manager 做公共處理。

AF 自訂 delegate

有同學會問:我們設的代理不是 NSURLSessionDelegate 嗎,怎麼能響應這麼多代理?看類的聲明就明白了——它同時採用了 NSURLSessionDelegate、NSURLSessionTaskDelegate、NSURLSessionDataDelegate、NSURLSessionDownloadDelegate、NSURLSessionStreamDelegate 一系列協議,而 NSURLSession 會自行判斷是否 respondsToSelector 並呼叫。

AF 還重寫了 respondsToSelector::對於 taskWillPerformHTTPRedirection、dataTaskDidReceiveResponse、dataTaskWillCacheResponse、didFinishEventsForBackgroundURLSession 這幾個方法,如果對應的自訂 Block 沒有賦值就回傳 NO,相當於「沒有實作」。因為這些代理本身只執行對應的 Block,Block 都沒賦值時,呼叫代理毫無意義。

說到這裡,順帶看一個設計巧思:AF 把一大堆 Block 屬性在 .m 文件中聲明並重寫 setter,同時在 .h 中只暴露 setter 方法。繞這麼一圈,是為了讓使用者呼叫 set 方法時能清楚看到 Block 的各個參數與返回值——對於參數眾多的 Block,這比直接賦值友善得多。

幾個關鍵代理方法

didBecomeInvalidWithError: 在 session 失效時呼叫。若用 finishTasksAndInvalidate 使 session 失效,session 會先完成最後一個 task 再觸發該代理;若用 invalidateAndCancel,則立即觸發。AF 在這裡呼叫自訂 Block 並發出一個 AFSessionDidInvalidateNotification 通知——這個通知 AF 自己並未使用,純粹留給接入方靈活使用。AF 的大部分通知都是如此,另一部分則會配合 UIKit 擴展使用。

didReceiveChallenge:completionHandler:(https 認證):當伺服器要求客戶端提供憑證或進行 NTLM 認證,或首次與伺服器建立 SSL/TLS 連線需要驗證伺服器憑證鏈時呼叫。AF 的處理邏輯是:有自訂 Block 就用自訂的,否則判斷認證方式是否為 NSURLAuthenticationMethodServerTrust,若是則用 securityPolicy 評估伺服器信任——通過則建立 credential 並以 UseCredential 方式回應,不通過則取消挑戰;其他認證方式一律走預設處理。最後呼叫 completionHandler 完成挑戰。

URLSessionDidFinishEventsForBackgroundURLSession:在後台 session 中所有已入隊的任務都轉發完畢時呼叫。在 iOS 中,後台傳輸完成或需要憑證時,若 App 正在後台掛起會被自動喚醒,此時應該先存好 completionHandler,再用相同 identifier 建立 background configuration 與新 session 重新關聯後台任務;待收到這個代理,意味著之前入隊的所有事件都已轉發完畢,此時呼叫先前存取的 completionHandler 才是安全的。AF 在這裡會切主執行緒呼叫自訂 Block。

willPerformHTTPRedirection:newRequest:completionHandler::伺服器重定向時呼叫。AF 先判斷是否有 taskWillPerformHTTPRedirection,有則用自訂實作回傳一個新的 request,然後交給 completionHandler 繼續請求。需要注意兩點:一是它只在伺服器主動重定向時觸發,並不能像 NSURLProtocol 那樣由客戶端主動改寫 request;二是它只在 default session 或 ephemeral session 中呼叫,background session 的 task 會自動重定向。這裡也順帶說明了 defaultSessionConfiguration 的由來——它與 NSURLConnection 的網路堆棧一致,共享 NSHTTPCookieStorage、NSURLCache 與 NSURLCredentialStorage;而 ephemeral 配置不對快取、Cookie 與憑證做持久化(適合類無痕模式),background 配置則能在 App 掛起、退出甚至崩潰後繼續執行上傳下載。

task:didReceiveChallenge:completionHandler::邏輯與 session 級別的 https 認證完全一致,唯一差別是多了一個 task 參數,並在呼叫自訂 Block 時回傳它——這樣就能按 task 粒度自訂認證方式。

needNewBodyStream::當 session task 需要重新傳送 request body stream 時呼叫,兩種典型場景是:task 由 uploadTaskWithStreamedRequest: 建立、需提供初始 body stream 時;以及因認證挑戰或可恢復的伺服器錯誤需要重送含 body stream 的請求時。AF 的實作是:有自訂 Block 就用自訂的,否則嘗試 copy task 原始 request 的 HTTPBodyStream。

didSendBodyData:totalBytesSent:totalBytesExpectedToSend::週期性通知已發送 / 待發送的位元組數。AF 在這裡做了一處防禦:若 totalBytesExpectedToSend 為未知(NSURLSessionTransferSizeUnknown),則退回讀取原始 request 的 Content-Length header 作為總量,然後呼叫自訂 Block。

未完待續

寫了這麼多,其實還沒講到真正重要的部分,但篇幅所限,只能先在此收個尾。如果能看到這裡,說明你是個非常有耐心、非常好學的 iOS 開發——為你點個讚。後續還會繼續拆解響應序列化、Reachability、Security 以及 UIKit 擴展等模組的實作細節。

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