斷點續傳指的是從文件傳輸中斷的位置重新開始下載或上傳,而不是從頭開始。下載大文件時,如果沒有這個能力,每次出現異常或用戶主動暫停,都得從頭再來,既浪費時間又浪費流量。因此項目中做下載功能時,斷點續傳基本是標配。
這裡還有一種更嚴苛的場景:應用被用戶強制結束或者 crash 之後,重啟還能繼續下載。這才是真正需要重點解決的問題。
要實現斷點續傳,服務端必須支持。常見方式有 FTP 和 HTTP 兩種,下面重點說 HTTP。
HTTP 之所以能便捷地實現斷點續傳,關鍵在於請求頭中定義的 Range。客戶端可以要求服務端只返回資源的某一部分,從而恢復下載。
需要注意的是,並非所有服務器都支持 Range,不支持的場景不在我們討論範圍內。Range 以字節為單位計算,請求時不必給出結尾字節數,因為請求方並不一定知道資源總大小。例如:
· bytes=500-999 表示第 500 到 第 999 字節;
· bytes=500- 表示從第 500 字節開始一直到結尾的所有字節。
拿到服務端返回的部分數據後,把它拼接(append)到本地已有文件末尾,斷點續傳就完成了。
項目通常部署在 HTTP 服務器上,因此以下方案基於 HTTP 實現。先看最簡單的做法——直接使用 AFNetworking 提供的能力:
// 1. 指定下載文件的地址 URLString
// 2. 獲取保存的文件路徑 filePath
// 3. 獲得 NSURLRequest
NSString *URLString = @"";
NSString *filePath = @"";
NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:URLString]];
signed long long downloadBytes = 0;
if ([[NSFileManager defaultManager] fileExistsAtPath:filePath]) {
// 3.1 若之前下載過,則在 HTTP 請求頭部加入 Range
// 獲取已下載文件的大小
downloadBytes = [self fileSizeForPath:filePath];
// 驗證是否下載過文件
if (downloadBytes > 0) {
// 若下載過,斷點續傳時修改 HTTP 頭部的 Range 字段
NSMutableURLRequest *mutableURLRequest = [request mutableCopy];
NSString *requestRange = [NSString stringWithFormat:@"bytes=%llu-", downloadBytes];
[mutableURLRequest setValue:requestRange forHTTPHeaderField:@"Range"];
request = mutableURLRequest;
}
}
// 4. 創建 AFHTTPRequestOperation
AFHTTPRequestOperation *operation = [[AFHTTPRequestOperation alloc] initWithRequest:request];
// 5. 設置輸出流,追加寫入第 2 步的文件
operation.outputStream = [NSOutputStream outputStreamToFileAtPath:filePath append:YES];
// 6. 設置下載進度回調
[operation setDownloadProgressBlock:^(NSUInteger bytesRead,
long long totalBytesRead,
long long totalBytesExpectedToRead) {
// bytesRead:當前這次讀取的字節數
// totalBytesRead:累計讀取總字節數,包含斷點之前的
// totalBytesExpectedToRead:文件總大小
}];
// 7. 設置成功與失敗回調
[operation setCompletionBlockWithSuccess:^(AFHTTPRequestOperation *operation, id responseObject) {
// 下載完成
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
// 下載失敗
}];
// 8. 啟動
[operation start];
這段代碼的重點在於:把已下載的數據持久化到磁盤,並在下次請求時通過 Range 告知服務端從哪裡繼續。
那麼 AFNetworking 內部是怎麼做的?查看源碼可知,AFHTTPRequestOperation 繼承自 AFURLConnectionOperation,後者實現了 NSURLConnectionDataDelegate 協議。
值得注意的一個設計細節:AFNetworking 採取在子線程調用異步接口的方式,而非直接在主線程調用。原因是主線程調用 [[NSURLConnection alloc] initWithRequest:request delegate:self startImmediately:YES] 後,監聽任務會被加進主線程的 RunLoop,而 RunLoop 的默認 mode 是 NSDefaultRunLoopMode。當用戶正在滾動 UITableView 或 UIScrollView 時,主線程 RunLoop 處於 NSEventTrackingRunLoopMode,處於 Default mode 的任務就不會被執行,導致數據回調被阻塞。
另外,由於採用子線程調用,DownloadProgressBlock、success 和 failure 這些回調都需要自行切回主線程處理 UI。
這個類從 iOS 9 起已被蘋果標記為廢棄,這裡不再展開。
蘋果從 iOS 7 開始推出 NSURLSession,具備 NSURLConnection 的能力且更強大,推薦使用它來實現下載與續傳。關鍵是實現 NSURLSessionDataDelegate 與 NSURLSessionTaskDelegate 相關方法。
使用 NSURLSessionDownloadTask 下載時,系統會在 cache 文件夾下創建臨時路徑,裡面有一個以 "CFNetworking" 開頭的 .tmp 文件,這就是正在下載的文件。
當調用 cancelByProducingResumeData: 之後,會得到一個 Data 對象。把它轉成字符串觀察,會發現其實是一個 plist(XML)結構,裡面記錄了 .tmp 文件的關鍵信息,包括 Range、key、下載文件的路徑等。同時,原本位於 download 文件夾下的下載文件會被移動到系統 tmp 目錄;再次執行 resume 時,它又會被移回 download 文件夾。
基於上述觀察,可以總結出幾條結論:
因此完整方案可以這樣設計:
1)設置一個布爾變量標記當前是否正在下載;
2)用定時器每隔一段時間主動暫停一次,拿到 resumeData;
3)把 resumeData 保存起來,同時把 tmp 文件夾下的下載文件拷貝一份到安全目錄(因為 tmp 目錄隨時可能被系統清空);
4)再次下載時,先從安全目錄取出下載文件,刪除 tmp 文件夾中的同名文件,再把文件 copy 回 tmp 目錄;
5)最後用保存的 resumeData 調用 downloadTaskWithResumeData:,即可完成續傳。
這樣即使應用被系統或用戶終止,重新啟動後依然能從上次的位置繼續下載。