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

iOS 斷點續傳實作:用 NSURLSessionDataTask 打造檔案下載器

編輯:iOS 開發綜合

過去我在專案裡採用 AFNetworking 2.x 的 AFHTTPRequestOperation,搭配 SQLite 資料庫控管下載狀態,實作出檔案的斷點續傳功能。後來 Apple 宣布逐步收緊對 IPv4 的限制,由於 AFNetworking 屬於高階 API 封裝,理論上不需要更動任何程式碼;不過國外開發者仍建議直接升級到 AFNetworking 3.0。

真正動手遷移時卻處處碰壁。3.0 版本移除了 HTTPOperation 這條路徑,於是我改用 NSURLSessionDownloadTask 全數替換。問題在於既有的資料庫邏輯早已定型,而且被多個模組引用,改動成本極高。更麻煩的是 DownloadTask 的運作模式:它會先把資料寫入暫存檔,下載完畢後再搬移到指定目錄,無法透過 Range 標頭指定續傳的起始位置;一旦使用者直接結束 App 程序,還得額外保存 resumeData 才能接續下載。當多個執行緒同時下載多個檔案時,這套設計與原本的控制邏輯互相牽扯,改起來可說是事倍功半。

最後我索性完全捨棄 AFNetworking,改用系統原生的 NSURLSession、NSURLSessionDataTask 以及它的代理方法來實作。這樣做的好處是不必更動既有的資料庫結構,只需要重寫「暫停/繼續」這一段控制邏輯即可。

思路上特別感謝 HSDownloadManager 專案作者的無私分享:https://github.com/HHuiHao/HSDownloadManager 。以下實作也是在該專案的基礎上,依自身專案需求調整而來。

單例架構設計

整體下載流程由一個單例類別統籌管理。要注意的是,單例本身並不儲存下載內容的實體資料,所有資料只在方法呼叫之間傳遞。

/**
 * 取得單例
 */
+ (instancetype)sharedInstance;

/**
 * 開啟下載任務
 *
 * @param model 下載參數
 * @param progressBlock 進度回呼
 * @param stateBlock 狀態回呼
 */
- (void)download:(DownloadModel *)model
        progress:(void(^)(NSInteger receivedSize, NSInteger expectedSize, CGFloat progress))progressBlock
         state:(void(^)(DownloadState state))stateBlock;

model 物件封裝了該檔案的所有下載參數,並對應 SQLite 資料表中的一筆紀錄。其中包含檔名資訊,可據此還原出「已下載長度」的 range 值,重新建立 task 後即可續傳。

此外,我在 session 模型類別中額外加上 downloadModel 的引用,方便在代理方法裡直接取得檔案路徑等參數進行比對與寫入。

@property (nonatomic, copy) NSString *fileName;
@property (nonatomic, strong) DownloadModel *model;

TTDownloadManager 介面

#import <Foundation/Foundation.h>
#import "TTSessionModel.h"
#import "DownloadModel.h"

@interface TTDownloadManager : NSObject

+ (instancetype)sharedInstance;

- (void)download:(DownloadModel *)model
        progress:(void(^)(NSInteger receivedSize, NSInteger expectedSize, CGFloat progress))progressBlock
         state:(void(^)(DownloadState state))stateBlock;

/** 查詢下載進度 */
- (CGFloat)progress:(NSString *)fileName;

/** 取得檔案總大小 */
- (NSInteger)fileTotalLength:(NSString *)url;

/** 判斷是否下載完成 */
- (BOOL)isCompletion:(NSString *)url;

/** 刪除單一資源 */
- (void)deleteFile:(NSString *)url;

/** 清空所有資源 */
- (void)deleteAllFile;

/** 暫停所有任務 */
- (void)pauseAllTask;

/** 取消指定任務 */
- (void)cancelTaskWithModel:(DownloadModel *)model;

@end

TTDownloadManager 實作

幾個關鍵設計值得說明:以檔案 URL 的 MD5 值作為任務字典的 key;以 NSOutputStream 以 append 模式開啟檔案串流,讓每次請求都從既有長度往後寫入;請求標頭帶上 bytes=已下載長度-,由伺服器回傳剩餘內容;再以時間戳產生 taskIdentifier 並寫入任務字典,以便後續對應 session 模型。

#define TTCachesDirectory [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"TTCache"]
#define TTFileKey(url) url.md5String
#define TTDownloadLength(name) [[[NSFileManager defaultManager] attributesOfItemAtPath:SAVE_MODEL_PATH(name) error:nil][NSFileSize] integerValue]
#define TTTotalLengthFullpath [TTCachesDirectory stringByAppendingPathComponent:@"totalLength.plist"]

@interface TTDownloadManager ()<NSURLSessionDelegate>
/** 所有任務,以檔案名稱為 key */
@property (nonatomic, strong) NSMutableDictionary *tasks;
/** 所有下載相關資訊 */
@property (nonatomic, strong) NSMutableDictionary *sessionModels;
@end

@implementation TTDownloadManager

static TTDownloadManager *_downloadManager;

+ (instancetype)allocWithZone:(struct _NSZone *)zone {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        _downloadManager = [super allocWithZone:zone];
    });
    return _downloadManager;
}

- (id)copyWithZone:(nullable NSZone *)zone {
    return _downloadManager;
}

+ (instancetype)sharedInstance {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        _downloadManager = [[self alloc] init];
    });
    return _downloadManager;
}

- (void)download:(DownloadModel *)model
        progress:(void (^)(NSInteger, NSInteger, CGFloat))progressBlock
         state:(void (^)(DownloadState))stateBlock {
    NSString *model_url = model.model_url;
    NSString *fileName = [NSString stringWithFormat:@"%@.%@", model.model_md5_str, model.model_format];
    if (!model_url) return;

    if ([self isCompletion:fileName]) {
        stateBlock(DownloadStateCompleted);
        return;
    }
    // 已有任務則切換暫停/繼續
    if ([self.tasks valueForKey:fileName]) {
        [self handle:fileName];
        return;
    }

    [self createCacheDirectory];

    NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]
                                                          delegate:self
                                                     delegateQueue:[[NSOperationQueue alloc] init]];
    NSString *toPath = SAVE_MODEL_PATH(fileName);
    NSOutputStream *stream = [NSOutputStream outputStreamToFileAtPath:toPath append:YES];

    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:model_url]];
    NSString *range = [NSString stringWithFormat:@"bytes=%zd-", TTDownloadLength(fileName)];
    [request setValue:range forHTTPHeaderField:@"Range"];

    NSURLSessionDataTask *task = [session dataTaskWithRequest:request];
    NSTimeInterval time = [[NSDate date] timeIntervalSince1970];
    [task setValue:@((NSUInteger)time) forKeyPath:@"taskIdentifier"];

    [self.tasks setValue:task forKey:fileName];

    TTSessionModel *sessionModel = [[TTSessionModel alloc] init];
    sessionModel.url = model_url;
    sessionModel.fileName = fileName;
    sessionModel.model = model;
    sessionModel.progressBlock = progressBlock;
    sessionModel.stateBlock = stateBlock;
    sessionModel.stream = stream;
    [self.sessionModels setValue:sessionModel forKey:@(task.taskIdentifier).stringValue];

    [self start:fileName];
}

- (void)handle:(NSString *)key {
    NSURLSessionDataTask *task = [self getTask:key];
    if (task.state == NSURLSessionTaskStateRunning) {
        [self pause:key];
    } else {
        [self start:key];
    }
}

- (void)start:(NSString *)key {
    NSURLSessionDataTask *task = [self getTask:key];
    [task resume];
    [self getSessionModel:task.taskIdentifier].stateBlock(DownloadStateStart);
}

- (void)pause:(NSString *)key {
    NSURLSessionDataTask *task = [self getTask:key];
    [task suspend];
    [self getSessionModel:task.taskIdentifier].stateBlock(DownloadStateSuspended);
}

- (NSURLSessionDataTask *)getTask:(NSString *)key {
    return [self.tasks valueForKey:key];
}

- (TTSessionModel *)getSessionModel:(NSUInteger)taskIdentifier {
    return [self.sessionModels valueForKey:@(taskIdentifier).stringValue];
}

- (BOOL)isCompletion:(NSString *)fileName {
    return ([self fileTotalLength:fileName] && TTDownloadLength(fileName) == [self fileTotalLength:fileName]);
}

- (CGFloat)progress:(NSString *)fileName {
    return [self fileTotalLength:fileName] == 0 ? 0.0 : 1.0 * TTDownloadLength(fileName) / [self fileTotalLength:fileName];
}

- (NSInteger)fileTotalLength:(NSString *)fileName {
    return [[NSDictionary dictionaryWithContentsOfFile:TTTotalLengthFullpath][fileName] integerValue];
}

@end

資料模型

TTSessionModel 負責在代理方法之間承載串流、進度與狀態回呼:

typedef enum {
    DownloadStateUnBegin = 0,  // 未下載
    DownloadStateStart,        // 下載中
    DownloadStateSuspended,    // 已暫停
    DownloadStateCompleted,    // 已完成
} DownloadState;

@interface TTSessionModel : NSObject
@property (nonatomic, strong) NSOutputStream *stream;
@property (nonatomic, copy) NSString *url;
@property (nonatomic, copy) NSString *fileName;
@property (nonatomic, strong) DownloadModel *model;
@property (nonatomic, assign) NSInteger totalLength;
@property (nonatomic, copy) void(^progressBlock)(NSInteger receivedSize, NSInteger expectedSize, CGFloat progress);
@property (nonatomic, copy) void(^stateBlock)(DownloadState state);
@end

DownloadModel 則繼承自專案內的 DBBaseModel,直接對應資料庫欄位,包含 MD5 字串、遠端下載位址、檔案大小、格式、付款標識、下載狀態與百分比等資訊,並提供查詢所有已完成下載的方法。

@interface DownloadModel : DBBaseModel
@property(nonatomic,copy) NSString *model_md5_str;      // MD5 字串
@property(nonatomic,copy) NSString *model_url;          // 遠端下載位址
@property(nonatomic,copy) NSString *model_size;         // 檔案大小
@property(nonatomic,copy) NSString *model_name;         // 名稱
@property(nonatomic,copy) NSString *model_format;       // 格式
@property(nonatomic,copy) NSString *model_path;         // 本機路徑
@property(nonatomic,copy) NSString *model_download_flag;         // 0未下載 1下載中 2暫停 3完成
@property(nonatomic,copy) NSString *model_download_percentage;   // 下載百分比
+(NSArray *)findAllDownloadFinished;
@end

以上便是完整思路。核心其實很單純:以串流 append 搭配 Range 標頭,就能在不更動資料庫結構的前提下完成真正的斷點續傳。原始專案寫得很完整,值得直接 clone 下來研究。

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