
導語
如今市面上的 App,只要涉及影片、期刊或其他大型檔案的傳輸與瀏覽,加上「下載/緩存到本地」幾乎是必備項——它能繞開網速限制與網絡依賴,體驗提升非常明顯。而談到下載,就繞不開斷點續傳、隊列任務這些老話題。恰好我手上的項目就撞上了這樣的需求。
然而大量調研之後我發現,網上竟找不到一篇把這件事講透的文檔;能撈到的開源項目活躍度普遍不高,真要押上信任去滿足項目需求,心裡實在沒底。反覆權衡之後,只能自己動手,豐衣足食。鑽研過程中坑不少、困難也不少,個別地方真是不用不知道,一用才發現如此彆扭——難怪很少有人願意系統完整地介紹它。下面把我在實現下載模塊時用到的技術總結出來,希望這篇的乾貨不負你翻閱的時間。
廢話少說。下載離不開網絡請求,而當今 iOS 開發裡用得最廣的網絡框架無疑是 AFNetworking。簡單翻一下它就會找到最適合幹這件「小事」的組件:AFHTTPRequestOperation。
先假定需求是最常見、也最能暴露技術問題的那一種:
下載隊列在任一時刻,最多只允許一個任務處於正在下載的狀態。
節奏似乎稍快了些,那就先看實現隊列下載、斷點續傳的關鍵示例代碼:
NSError *error = nil;
// 建立下載隊列
NSOperationQueue *downloadOperationQueue = [[NSOperationQueue alloc] init];
// 規定隊列中最大可同時執行的 operation 數量為 1
downloadOperationQueue.maxConcurrentOperationCount = 1;
// 建立單個下載任務(讀取已下載檔案大小,實現斷點續傳)
NSMutableURLRequest *downloadRequest =
[NSMutableURLRequest requestWithURL:[NSURL URLWithString:DOWNLOAD_URL_STRING]];
[[NSURLCache sharedURLCache] removeCachedResponseForRequest:downloadRequest];
AFHTTPRequestOperation *downloadOperation =
[[AFHTTPRequestOperation alloc] initWithRequest:downloadRequest];
unsigned long long downloadedPartFileSize = 0;
if ([[NSFileManager defaultManager] fileExistsAtPath:DOWNLOADED_PART_FILE_PATH]) {
NSDictionary *fileAttributes =
[[NSFileManager defaultManager] attributesOfItemAtPath:DOWNLOADED_PART_FILE_PATH error:&error];
downloadedPartFileSize = [fileAttributes fileSize];
NSString *headerRangeFieldValue =
[NSString stringWithFormat:@"bytes=%llu-", downloadedPartFileSize];
[downloadRequest setValue:headerRangeFieldValue forHTTPHeaderField:@"Range"];
}
downloadOperation.outputStream =
[NSOutputStream outputStreamToFileAtPath:DOWNLOADED_PART_FILE_PATH append:YES];
[downloadOperation setDownloadProgressBlock:^(NSUInteger bytesRead, long long totalBytesRead, long long totalBytesExpectedToRead) {
NSLog(@"%lld/%lld", totalBytesRead + downloadedPartFileSize,
totalBytesExpectedToRead + downloadedPartFileSize);
}];
[downloadOperation setCompletionBlockWithSuccess:^(AFHTTPRequestOperation *operation, id responseObject) {
NSLog(@"downloadOperation completion block invoked");
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
NSLog(@"downloadOperation failure block invoked");
}];
// 將單個下載任務加入隊列
[downloadOperationQueue addOperation:downloadOperation];
// 暫停某下載任務
[downloadOperation pause];
// 繼續某下載任務
[downloadOperation resume];
// 取消某下載任務(同時應刪除已下載的檔案)
[downloadOperation cancel];
[[NSFileManager defaultManager] removeItemAtPath:DOWNLOADED_PART_FILE_PATH error:&error];
// 取消全部下載任務
[downloadOperationQueue cancelAllOperations];
// 此外還有若干一目了然的名稱用以查詢狀態
downloadOperation.isReady;
downloadOperation.isExecuting;
downloadOperation.isPaused;
downloadOperation.isCancelled;
downloadOperation.isFinished;
// 判斷某 operation 是否在隊列中
[downloadOperationQueue.operations containsObject:downloadOperation];以上代碼建立了一個 AFHTTPRequestOperation 作為單個下載任務,並把它加入 NSOperationQueue。照此模式建立多個 operation 加入隊列,就湊成了一條下載隊列。
寫到這裡,你是不是覺得已經沒有技術難點了?只要把 operation 一個個塞進 queue,任務就能一個接一個自動執行;上一個暫停、取消、自然完成或者中途失敗,下一個就會「聰明地」自動啟動,繼續下載。
錯!!!!!
接下來要說的,是本文最核心的乾貨,基本會顛覆你的想象。親手跑一遍,你就會看到這些大跌眼鏡的現象:
驚人事實 1:對隊列中前一個下載 operation 執行 pause,下一個 operation 並不會自動啟動進入執行狀態。
驚人事實 2:如果隊列中前一個下載 operation 執行失敗(可用下載中途斷網模擬),它會被自動從隊列中移除。
驚人事實 3:注意代碼裡那個 failure 回調 block——它不只在 operation 失敗時觸發,operation 被 cancel 時同樣會觸發。所以關於「什麼叫做 operation 失敗」,你需要重建世界觀。
驚人事實 4:對一個處於 pause 狀態的 operation 執行 cancel 會怎樣?答案是它仍然留在隊列裡,並保持 pause 狀態,唯一變化是 isCancelled 變成了 YES。
……未完待續,本文讓你驚訝的還有很多。
由於這些行為之間關係錯綜複雜,為了講清楚,我把實驗中觀察到的 operation 行為整理成了下表。

是不是覺得 AFHTTPRequestOperation 和 NSOperationQueue 坑得離譜?為什麼就不能按我們想象的那樣用得順手?
根源在於 AFHTTPRequestOperation 的父類 NSOperation,從設計之初就不是為下載場景而生的。它一開始只是用來處理多線程的,所以 AFNetworking 在擴展這個類時,可用的資源與接口都非常有限。下載任務的暫停/繼續、下載中途失敗等情況,很多問題幾乎無法理想解決,只能拿 NSOperation 現有的幾種狀態勉強表示,於是就出現了上表中種種詭異行為。
再補幾點乾貨,然後告訴你一個前文偷偷誤導了你的大坑。
驚人事實 5:隊列中已有一個下載 operation 正在執行,此時對另一個處於 isReady 狀態的 operation 調用 start 會怎樣?你大概會說「沒用,我設了 maxConcurrentOperationCount = 1 嘛」。事實恰好相反:這個 operation 也會立刻啟動執行,隊列裡於是出現兩個任務並行,maxConcurrentOperationCount 完全失效。
驚人事實 6:承接上一點,如果另一個 operation 的狀態不是 isReady 而是 isPaused,你對它調用 resume,它同樣會立刻啟動執行,完全不管當前隊列裡有沒有任務在跑。由此可見,maxConcurrentOperationCount 只能約束系統「自動啟動」時的數量檢查;一旦你手動 start,這條限制半點用處都沒有。
驚人事實 7:從表中可以看到,無論是自然執行完畢、中途失敗,還是被執行 cancel,operation 都會被標記為 isFinished 並從隊列移除——它認定的「完成」遠比我們想象的寬泛。問題來了:此時再對這個 operation 調用 start 會怎樣?毫無用處。所以你想讓一個失敗的 operation 從斷點處繼續下載,只能新建一個 operation 重來。
基於這些實驗,我們還能畫出一張流程圖:

頭疼、抓狂。我剛開始做下載模塊時,被這些問題坑得體無完膚,最後得出了本文最大的結論,也就是前面提到的那個「大坑」:
不要用 NSOperationQueue 來管理多下載任務!!!
理由如下:
你無法妥善實現「隊列中最多只有一個下載任務正在進行」這條產品經理臆想中會讓開發變簡單的需求。比如讓隊列中某個 operation 暫停後,下一個任務並不會自動啟動;有人說可以手動 start 下一個,姑且算可接受,但新問題又來了:我們根本沒法把一個 operation 手動置回 isReady 狀態。處於 isReady 的 operation,要麼還沒加入隊列,要麼加入了還沒輪到執行,而它一旦執行過,就再也回不到 isReady。那要怎麼讓暫停的 operation 恢復成等待下載的狀態?何況此時可能還有另一個 operation 正在執行。折騰半天,我無能為力。
下載是個需要時間的過程,要持續向服務器發請求,網絡波動導致的中途失敗永遠無法避免。可要命的是一旦失敗,operation 就毫不妥協地被移出隊列。你能接受下載任務在 UI 上憑空消失嗎?老闆顯然不會允許。有人說可以重建 operation 再加入隊列,但那样只能插到隊尾,列表順序就被打亂了——何況 operationQueue.operations 是個只讀屬性。
……剩下的自己去體會吧,坑多到無力吐槽,再堅持也是枉費心思。
不幸的是,我最後只得放棄 NSOperationQueue,轉而使用最古老原始的工具——NSMutableArray 來管理多下載任務。這樣一來,所有 operation 的啟動與移除都得手動執行。這個方案土是土了點,但起碼每個 operation 的控制權重新回到了我們手裡。有得必有失,能把項目需求恰當地實現出來,這點犧牲算不上什麼。
使用 AFHTTPRequestOperation 時還需要注意以下幾點:
對 isReady 狀態的 operation 執行 resume、pause、cancel 都毫無作用。為了保證執行正確,在調用 resume、pause、cancel 之前,都應該先執行一次 [operation start](對已 start 過的 operation 再次 start 不會有副作用)。
對處於 isPaused 的 operation 執行 cancel 得不到正確結果,所以每次 cancel 前都要先 [operation resume](對正處於 isExecuting 狀態的 operation 調用 resume 同樣沒有副作用)。
對下載模塊這種糾結場景來說,把下載記錄本地持久化同樣必不可少,理由如下:
AFHTTPRequestOperation、NSMutableArray 都是運行時的產物,App 一關就消失得無影無蹤。我們能讓下載記錄也跟著消失嗎?顯然不能接受。
本地那個檔案可能是已下載完成的,也可能只下載了一部分;而部分下載的情況又分暫停、失敗、被取消等多種類型。單憑檔案本身怎麼判斷屬於哪一種?更何況有些任務甚至還沒生成檔案,App 就被關了——這種任務能直接扔掉嗎?絕對不行。
不用 operationQueue,我們同樣無法把 operation 手動標記為隊列等待的 isReady 狀態,怎麼辦?只能把 operation 設為 paused,再用外部數據記錄把它標記為 isReady(我這裡用的是 CoreData 做本地持久化)。
用 operation 之外的數據模型記錄下載狀態,好處還有很多,但同步更新的麻煩也不少,具體留給大家自己體會。
以上就是我在實現下載模塊時總結的種種注意事項。如果各位大神有更優方案——比如用我掌握得還不夠好的 stream 來滿足上述需求——我也願意虛心聽取,把這塊打磨得更好。歡迎直言批評、不吝賜教。