
轉自:標哥的技術博客
概述
馬上要動手做一個稍有技術含量的項目,其中一個技術點就是視頻的上傳與下載。開工前需要做一些技術調研,並寫出相應的 demo。本文正是圍繞這個 demo 而寫,只包含下載功能。這個 demo 是最簡單的版本,暫不考慮耦合性,重點在於「能不能實現」。高手不妨也看看,讀完後歡迎在評論區分享你的封裝思路,互相交流;就算是新手,跟著走一遍相信也會有所收穫。
目錄
第一節:功能說明;第二節:設計理念;第三節:如何設計整個下載管理器;第四節:子類化 NSOperation;第五節:反饋到 UI 展示進度及狀態提示;第六節:設計管理下載類;第七節:小結;第八節:下載 demo。
效果圖
沒有效果圖,怕是沒多少人能讀到最後,先給大家打打氣:

第一節:功能說明
本文要帶大家寫一個最簡單的下載管理器,不含上傳管理器——不過上傳與下載思路相通,後文會拋磚引玉,大家可以自行嘗試。這個下載管理器具備以下功能:
開始下載某個視頻
掛起某個視頻下載(暫停)
恢復某個視頻下載(繼續)
可設置最大並發下載量
添加到下載隊列
以上是最基本的功能,下面就依此實現。至於後台下載、退出 App 後再次進入自動恢復上次狀態等,不在本 demo 範圍之內。一切從簡!
第二節:設計理念
追求簡單易用、易擴展、易維護
與具體下載類型無關——無論視頻、音頻還是普通文件,都能通用
單個下載類保持功能單一,專心做好一件事
第三節:如何設計整個下載管理器
由於需要記錄進度與狀態,且整個 App 生命週期內都存在,可考慮單例,也可考慮非單例(但非單例同樣要保證只創建一次並交由 appDelegate 持有,本質與單例相當)。為簡化,這裡採用單例設計。
為處理並發下載,使用 NSOperationQueue。
為保證下載類功能單一,採用子類化 NSOperation。
由於下載與文件類型無關,可定義協議並要求 model 遵守(豆瓣開源的 DOUAudioStreamer 便是此種做法)。為簡化,本 demo 未定義協議,直接用 model;實際項目中建議改用協議,以支持任意類型文件(視頻、音頻等)的下載與上傳。
本 demo 主要設計三個類:
HYBVideoOperation:子類化的 NSOperation,專門負責下載
HYBVideoModel:視頻數據模型,含下載地址、存儲地址、進度、狀態等,並持有 HYBVideoOperation 以便管理
HYBVideoManager:下載管理器,管理所有 HYBVideoModel
此外還需與 UI 交互,因此 cell 中也要持有 model,HYBVideoCell 強引用 model。整體交互關係如下:
HYBVideoManager 管理所有 HYBVideoModel
每個 HYBVideoModel 持有一個 HYBVideoOperation
HYBVideoOperation 弱持有一個 HYBVideoModel
HYBVideoCell 持有一個 HYBVideoModel,進度或狀態變化時更新 UI
所有回調都放在 HYBVideoModel 中,當其進度或狀態變化時,便反饋到 UI 上。
第四節:子類化 NSOperation
子類化 NSOperation 時,建議先讀讀我之前寫的 NSOperation/Queue 一文,這裡也列出幾個要點:
重寫 start 時,要做好 isCancelled 的判斷
重寫 isExecuting、isFinished、isConcurrent
重寫 cancel,並處理好 isCancelled 的 KVO
我們用 NSURLSession 實現下載,通過控制 NSURLSessionDownloadTask 來實現下載、暫停與斷點續傳。頭文件設計如下:
@class HYBVideoModel; @interface NSURLSessionTask (VideoModel) // 為方便直接提取、免去遍歷,採用擴展方式關聯模型 @property (nonatomic, weak) HYBVideoModel *hyb_videoModel; @end @interface HYBVideoOperation : NSOperation - (instancetype)initWithModel:(HYBVideoModel *)model session:(NSURLSession *)session; @property (nonatomic, weak) HYBVideoModel *model; // 可以不公開此屬性 @property (nonatomic, strong, readonly) NSURLSessionDownloadTask *downloadTask; - (void)suspend; - (void)resume; - (void)downloadFinished; @end
這裡還擴展了 NSURLSessionTask,把模型與之關聯(注意用弱引用)。我個人認為這樣做接口簡單、與外部無直接耦合,session 來源於下載管理類,便於統一管理。下載完成後一定要回調 downloadFinished,目的是讓任務退隊——而任務能否退隊,取決於 isFinished 是否為 YES:
[self willChangeValueForKey:@"isFinished"]; [self willChangeValueForKey:@"isExecuting"]; _executing = NO; _finished = YES; [self didChangeValueForKey:@"isExecuting"]; [self didChangeValueForKey:@"isFinished"];
由於任務完成後通常還可重新下載,一般不會自動退隊。
第五節:反饋到 UI 展示進度及狀態提示
我們通過模型把變化反饋到 UI,在進度與狀態變化時回調更新界面。先把下載的各類狀態定義成枚舉:
typedef NS_ENUM(NSInteger, HYBVideoStatus) { kHYBVideoStatusNone = 0, // 初始狀態 kHYBVideoStatusRunning = 1, // 下載中 kHYBVideoStatusSuspended = 2, // 下載暫停 kHYBVideoStatusCompleted = 3, // 下載完成 kHYBVideoStatusFailed = 4, // 下載失敗 kHYBVideoStatusWaiting = 5 // 等待下載 };再設計相應屬性:
typedef void(^HYBVideoStatusChanged)(HYBVideoModel *model); typedef void(^HYBVideoProgressChanged)(HYBVideoModel *model); @interface HYBVideoModel : NSObject @property (nonatomic, copy) NSString *videoId; @property (nonatomic, copy) NSString *videoUrl; @property (nonatomic, copy) NSString *imageUrl; @property (nonatomic, copy) NSString *title; // 用於斷點下載記錄,正式項目應存儲到文件並記錄路徑,demo 從簡 @property (nonatomic, strong) NSData *resumeData; // 下載後存儲到此處 @property (nonatomic, copy) NSString *localPath; @property (nonatomic, copy) NSString *progressText; // 關鍵屬性,進度變化會自動回調 onProgressChanged @property (nonatomic, assign) CGFloat progress; // 狀態變化會自動回調 onStatusChanged @property (nonatomic, assign) HYBVideoStatus status; // 管理器直接管理 model,真正執行下載的是 operation,故在此強引用 @property (nonatomic, strong) HYBVideoOperation *operation; @property (nonatomic, copy) HYBVideoStatusChanged onStatusChanged; @property (nonatomic, copy) HYBVideoProgressChanged onProgressChanged; @property (nonatomic, readonly, copy) NSString *statusText; @end
不同人設計或有不同方式,但綜合比較下,這種設計最為簡潔。當進度或狀態變化時,自動回調:
- (void)setProgress:(CGFloat)progress { if (_progress != progress) { _progress = progress; if (self.onProgressChanged) { self.onProgressChanged(self); } else { NSLog(@"progress changed block is empty"); } } } - (void)setStatus:(HYBVideoStatus)status { if (_status != status) { _status = status; if (self.onStatusChanged) { self.onStatusChanged(self); } } }如此一來,回調便與下載管理類、下載類都無直接關聯,而 model 的回調直接反饋到了 UI 層。配置 cell 時,這樣就能實時展示進度與狀態:
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath { HYBVideoCell *cell = [tableView dequeueReusableCellWithIdentifier:kCellIdentifier forIndexPath:indexPath]; HYBVideoModel *model = [HYBVideoManager shared].videoModels[indexPath.row]; cell.model = model; model.onStatusChanged = ^(HYBVideoModel *changedModel) { cell.model = changedModel; }; model.onProgressChanged = ^(HYBVideoModel *changedModel) { cell.model = changedModel; }; return cell; }而點擊某個 cell 進行下載或暫停時:
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath { HYBVideoModel *model = [HYBVideoManager shared].videoModels[indexPath.row]; switch (model.status) { case kHYBVideoStatusNone: { [[HYBVideoManager shared] startWithVideoModel:model]; break; } case kHYBVideoStatusRunning: { [[HYBVideoManager shared] suspendWithVideoModel:model]; break; } case kHYBVideoStatusSuspended: { [[HYBVideoManager shared] resumeWithVideoModel:model]; break; } case kHYBVideoStatusCompleted: { NSLog(@"已下載完成,可以播放了,播放路徑:%@", model.localPath); break; } case kHYBVideoStatusFailed: { [[HYBVideoManager shared] resumeWithVideoModel:model]; break; } case kHYBVideoStatusWaiting: { [[HYBVideoManager shared] startWithVideoModel:model]; break; } } }從整體看,UI 層調用起來非常簡單。
第六節:設計管理下載類
管理下載類採用單例設計,所有操作都直接關聯 model,對外部不暴露 operation。項目中最好不要直接用這樣的模型,而是採用協議方式讓 model 去遵守,從而在設計理念層面支持任意類型。頭文件如下:
@class HYBVideoModel; @interface HYBVideoManager : NSObject @property (nonatomic, readonly, strong) NSArray *videoModels; + (instancetype)shared; // 添加視頻模型,只添加不下載 - (void)addVideoModels:(NSArray*)videoModels; // 開始下載某個視頻 - (void)startWithVideoModel:(HYBVideoModel *)videoModel; // 掛起 - (void)suspendWithVideoModel:(HYBVideoModel *)videoModel; // 恢復下載 - (void)resumeWithVideoModel:(HYBVideoModel *)videoModel; // 暫未使用 - (void)stopWiethVideoModel:(HYBVideoModel *)videoModel; @end
初始化時創建隊列與 session:
self.queue = [[NSOperationQueue alloc] init]; self.queue.maxConcurrentOperationCount = 4; NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration]; // 不能傳 self.queue self.session = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:nil];
要注意 delegateQueue 不能傳 self.queue。起初我傳了,結果一旦超過設定的並發數就再也下載不動、卡在那裡——原因就是傳了 self.queue。因為我們用的是自定義 operation,而使用 session 後每個任務創建時都會自動往隊列裡加一個 NSBlockOperation,且任務完成後並不會自動退隊(狀態未進入完成),於是其他任務都被卡在並發上限,無法繼續。
開始、暫停、恢復下載的 API 如下:
- (void)startWithVideoModel:(HYBVideoModel *)videoModel { if (videoModel.status != kHYBVideoStatusCompleted) { videoModel.status = kHYBVideoStatusRunning; if (videoModel.operation == nil) { videoModel.operation = [[HYBVideoOperation alloc] initWithModel:videoModel session:self.session]; [self.queue addOperation:videoModel.operation]; [videoModel.operation start]; } else { [videoModel.operation resume]; } } } - (void)suspendWithVideoModel:(HYBVideoModel *)videoModel { if (videoModel.status != kHYBVideoStatusCompleted) { [videoModel.operation suspend]; } } - (void)resumeWithVideoModel:(HYBVideoModel *)videoModel { if (videoModel.status != kHYBVideoStatusCompleted) { [videoModel.operation resume]; } }可以看到,這裡都是先通過 model 拿到 operation,再調用對應 API,管理類因此變得相當清爽。最後處理一下代理:
// 下載完成時回調 #pragma mark - NSURLSessionDownloadDelegate - (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location { // 本地文件路徑,使用 fileURLWithPath: 創建 if (downloadTask.hyb_videoModel.localPath) { NSURL *toURL = [NSURL fileURLWithPath:downloadTask.hyb_videoModel.localPath]; NSFileManager *manager = [NSFileManager defaultManager]; [manager moveItemAtURL:location toURL:toURL error:nil]; } [downloadTask.hyb_videoModel.operation downloadFinished]; NSLog(@"path = %@", downloadTask.hyb_videoModel.localPath); } // 下載失敗或成功時回調,失敗可能是暫停所致,需做判斷 - (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error { dispatch_async(dispatch_get_main_queue(), ^{ if (error == nil) { task.hyb_videoModel.status = kHYBVideoStatusCompleted; [task.hyb_videoModel.operation downloadFinished]; } else if (task.hyb_videoModel.status == kHYBVideoStatusSuspended) { task.hyb_videoModel.status = kHYBVideoStatusSuspended; } else if ([error code] < 0) { // 網絡異常 task.hyb_videoModel.status = kHYBVideoStatusFailed; } }); } // 處理進度 - (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite{ double byts = totalBytesWritten * 1.0 / 1024 / 1024; double total = totalBytesExpectedToWrite * 1.0 / 1024 / 1024; NSString *text = [NSString stringWithFormat:@"%.1lfMB/%.1fMB",byts,total]; CGFloat progress = totalBytesWritten / (CGFloat)totalBytesExpectedToWrite; dispatch_async(dispatch_get_main_queue(), ^{ downloadTask.hyb_videoModel.progressText = text; downloadTask.hyb_videoModel.progress = progress; }); } // 通過 resume 恢復下載時會回調一次,用於更新進度 - (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didResumeAtOffset:(int64_t)fileOffset expectedTotalBytes:(int64_t)expectedTotalBytes{ double byts = fileOffset * 1.0 / 1024 / 1024; double total = expectedTotalBytes * 1.0 / 1024 / 1024; NSString *text = [NSString stringWithFormat:@"%.1lfMB/%.1fMB",byts,total]; CGFloat progress = fileOffset / (CGFloat)expectedTotalBytes; dispatch_async(dispatch_get_main_queue(), ^{ downloadTask.hyb_videoModel.progressText = text; downloadTask.hyb_videoModel.progress = progress; }); }大家發現沒有,給 task 擴展屬性後,這裡能非常直接地取到 model,而給 model 賦值進度、狀態又會自動觸發 UI 更新,是不是方便多了?內部管理代碼也比較簡單易讀。
第七節:小結
本文在教大家的同時,也希望能收到更多意見,尤其是做過類似功能的開發者,还请多多指教。文中代碼都是最簡單的版本,沒過多考慮擴展性與耦合度;不過正如設計理念所述,實際項目中最好採用協議方式設計,以支持自由擴展。看完本文,你是否有所收穫?是否與你原先所想產生了碰撞?歡迎在評論區留下寶貴意見!
第八節:下載 Demo
本文配有 demo,但出於篇幅,我把下載資源去掉了,若想測試效果需自行尋找下載鏈接。DEMO 下載:DownloadManager