AFNetworking 3 批量上傳圖片的 3 種方法

發表於2016-05-31

AFNetworking 在去年年底升級到了 3.0。這個版本更新想必有很多好處，然而讓我吃驚的是，它並沒有 batch request 介面。之前的 1.x 版本、2.x 版本都實現了這個很常見的需求，不知道作者為何選擇在 3.x 中去掉它。

在 AFNetworking 2 中，我們只需一行程式碼就能解決批量上傳的問題：

但 AFNetworking 3 用的是NSURLSession，而不是用NSOperation來包裝NSURLConnection，所以把整個AFURLConnectionOperation類都幹掉了。上面的方法不能再用，並且也沒有給出替代品。因此，我們只能自己動手了。

實現這個功能，有幾個要點：

  1. 非同步上傳。批量請求裡的每個請求都應該在不同執行緒，可以同時上傳。
  2. 在所有請求都完成之後，再通知回撥。
  3. 儘管非同步請求的返回先後順序沒有一定，很可能後發出的請求先返回；但是最後回撥的時候，請求返回的結果必須要按請求發出的順序排列。比如，一個很常見的處理是，上傳圖片的介面返回該圖片的 url；那麼回撥結果裡的 url 順序顯然需要跟上傳的圖片順序一一對應上。
  4. 最好傳完每張圖片也能有一個回撥，方便我們告訴使用者上傳的進度。

同時滿足以上要點，主要有3種思路：GCD、NSOperation 以及 promise。這個需求也是示例多執行緒用法的一個很好的例子，所以我寫了這篇比較詳細的文章供大家參考。

下面的程式碼以圖片上傳為例。測試資料配置了 3 張圖片，其中第 2 張圖片尺寸最小，往往先上傳完畢，用來測試請求發出順序與返回順序不一致的情況。

227290-49c6bd2c7d2a877f測試圖片之一

方法一：GCD dispatch group

我們知道，GCD dispatch 是多執行緒處理最簡單的方法。全部請求完成後再通知回撥的需求，很適合利用 dispatch group 來完成。至於保證返回結果的順序，我們只好自己來做了。

首先需要一個方法，對於每張圖片生成一個上傳請求。

在這個方法裡，我們首先用UIImageJPEGRepresentation把UIImage變為NSData。然後用AFHTTPRequestSerializer來生成NSMutableURLRequest，[self uploadUrl]是上傳介面的地址。為安全考慮，一般上傳的介面都有身份驗證的需求，比如在請求 header 中加入 auth 資訊，可以在此配置NSMutableURLRequest的 header。最後，我們用 AFURLSessionManager 把 NSURLRequest 和回撥 block 包裝成一個NSURLSessionUploadTask。

有了生成請求的方法，批量發出請求的方法如下：

可以看到，我們把所有請求放在一個 dispatch_group 裡。首先用dispatch_group_create()來建立這個 group。然後，對於每一個 uploadTask，在建立之前先執行dispatch_group_enter(group)，在結束回撥的 block裡執行dispatch_group_leave(group)。結束回撥的程式碼放在dispatch_group_notify裡即可。

實際執行中，首先是所有 task 都進入 group，同時開始上傳；上傳完成之後依次離開 group；最後 group 空了會自動呼叫傳入group_notify的回撥，整個過程完成。

那麼如何把回撥資料排成正確的順序呢？藉助 block 會儲存自動變數的特點，我們讓每個 task 的回撥 block 都自動帶上標誌請求次序的變數 i，只需把返回結果填入陣列的第 i 位即可。所以在開始請求之前，先建立好儲存返回結果的陣列，元素個數與請求個數相等，每個位置上用[NSNull null]佔位。每個請求返回之後，把自己那個位置上的[NSNull null]替換成返回結果。全部請求返回之後，陣列裡儲存的自然是按請求順序排列的回撥資料。

這裡注意，因為 NSMutableArray 是執行緒不安全的，而每個請求返回時是在不同執行緒操作同一個陣列，所以我用@synchronized把運算元組的程式碼鎖住了，鎖的物件就用這個陣列即可。這樣保證所有執行緒執行到這一句都得序列，避免執行緒安全問題。

一次測試結果如下：

可以看到，儘管第 2 張圖片尺寸最小、最先傳完，第 1 張圖片後傳完，但最後的結果順序還是正確的。

方法二：NSOperationQueue

能用 dispatch 實現的功能，自然也可以用NSOperationQueue。NSOperation 這一套比 dispatch 寫起來要麻煩一些，不過有幾個優點：

  1. NSOperation是物件，不像 dispatch 是 c 函式。這就意味著你可以繼承它，可以給它加 category，在執行過程中也可以始終管理它，訪問到它，檢視它的狀態等，不像 dispatch 是一撒手就夠不著了。
  2. 用NSOperation執行的任務，執行過程中可以隨時取消。dispatch 一經發出是無法取消的。
  3. NSOperationQueue可以限制最大併發數。假如佇列裡真有 100 個檔案要傳，開出 100 個執行緒反而會嚴重影響效能。NSOperationQueue可以很方便地設定maxConcurrentOperationCount。dispatch 也可以限制最大併發數（參考蘋果的文件）不過寫起來麻煩很多。

就我們的需求而言，用 NSOperation 有一個很方便的特點：dispatch 裡的任務各自為政，而NSOperation之前是可以有依賴關係的。我們就可以利用這一點，來發起所有任務上傳完成後的回撥：把這個完成回撥也做成一個NSOperation，讓這個NSOperation前置依賴所有上傳的NSOperation，這樣等到所有上傳的NSOperation完成之後，這個回撥NSOperation才會開始執行。

然而，用NSOperation也有一個很不方便的特點：NSOperationQueue是用 KVO 觀察NSOperation狀態來判斷任務是否已結束的。而我們請求用的NSURLSessionTask，它長得很像一個NSOperation，但卻並不是NSOperation的子類。所以，這一套方法最麻煩的地方就在於我們需要寫一個自定義的NSOperation子類，只是為了跟蹤NSURLSessionTask的狀態。

自定義的NSOperation程式碼如下：

HAMURLSessionWrapperOperation.h

HAMURLSessionWrapperOperation.m

程式碼有點長，但沒辦法。我們的目標是對每個NSURLSessionTask都包裝出一個HAMURLSessionWrapperOperation，這個NSOperation完全隨著NSURLSessionTask的狀態而動，在 Task 結束之後發出 KVO 的通知，通知NSOperationQueue這個任務結束。

系統NSOperation的finished屬性是隻讀的，不能修改；為了記錄值和發出 KVO 的通知，我們只能在旁再定義一個finished的成員變數，通過重寫- (BOOL)isFinished等 getter 方法，蓋掉原來的finished屬性。現在幾乎全用 property，這種成員變數的寫法好久沒看見過了，沒想到還有這種用處，這種特殊的寫法還是從蘋果文件學來的（參考這裡）。

這裡 start 方法照抄蘋果文件，在新執行緒調起 main 方法。main 方法裡就兩件事：開始 KVO 觀察上傳 task 的 state 屬性，然後啟動 task。一旦 task 完成（或失敗），接到 KVO 的通知，我們停止對 task 的觀察，然後發出自己的 KVO 通知去通知NSOperationQueue。這裡我們手動調起了[self willChangeValueForKey:@"isFinished"];和[self didChangeValueForKey:@"isFinished"];，又重寫了- (BOOL)isFinished方法，就把只讀的finished屬性偷天換日變成我們自己定義的finished成員變數了。

自定義NSOperation說完了，下面我們來看看怎麼使用這個類。我們同樣要利用上面 dispatch 一節寫的那個uploadTaskWithImage:completion方法，根據圖片生成請求。發出請求的程式碼如下：

保持結果順序的方法與 dispatch 相同，都是我們自己完成的。我們把maxConcurrentOperationCount定成 5，避免併發過多競爭資源。先建立結束回撥的 operation，再讓它依賴後面建立的每一個上傳 operation。因為一般回撥都要涉及到更新 UI，所以讓它回到主執行緒執行。後面根據每張圖片逐一建立 task、包裝成 operation。建立好之後，加進 operationQueue 裡就開始跑了。

一次測試結果如下：

結果也是正確的。

方法三：promise

上面的兩種方法，我們都是自己用陣列、佔位、逐位替換的方法，自己寫程式碼保證返回資料順序正確的。其實這種需要多個執行緒執行、全部結束後回撥、結果順序保證正確的需求，一般最適合用 promise 來做。各個語言都有自己的 promise 實現，iOS 也有好幾種。這裡我們試用一下 iOS 最著名的實現 PromiseKit。

在 github 上 5000 多個 star，這個 lib 是 Objective-C 、Swift 通用的，兩套程式碼都有。在網路請求方面，它要依賴同一個作者寫的另一個庫 OMGHTTPURLRQ，匯入的時候小費周折。PromiseKit 這一套方法與 AFNetworking 庫就沒關係了，可能有些離題，但是用起來是最為方便的。

這裡我們不再需要上面那個生成NSURLSessionTask的方法了，現在我們需要把NSURLRequest包裝成AnyPromise：

這裡可以看到 promise 的.then語法。它是一個 C 函式，傳進的引數是這項 promise 完成之後下一步需要執行的 block，返回值仍然是AnyPromise，所以可以一直.then().then()……這樣鏈式呼叫下去。我們在這裡讓它上傳完單張圖片之後執行單張圖片的回撥，把回撥 block『附身』在上傳的 promise 之後。

上面就是建立 promise 的過程。那麼執行 promise 的程式碼怎麼寫呢？

可以看到程式碼非常簡潔，可讀性又好，比前兩種方法都省去不少程式碼，這是 promise 的一大優勢。我們只需把針對每張圖片建立一個 promise ，放進一個 promises 陣列，然後PMKWhen(promises).then()就能幫我們搞定一切了——是不是很神奇呢？每個任務單開執行緒、等待全部任務執行完、結果正確排序等諸多工序，全都由這一行程式碼搞定了。看看測試結果：

同樣是正確的。

所以看起來用 promise 還是非常方便的。不過這是我第一次嘗試用它，還不知道在工程中實際應用會有什麼缺點。

以上就是多執行緒批量上傳圖片的 3 種方法。思路最初來自 stackoverflow 的這個問題How to send batch request by using AFNetworking 3.0，感謝這位回答的大神~

相關文章