您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 教學 >> iOS 相關教學

iOS 網路編程:封裝支援斷點續傳的檔案下載器

編輯:iOS 相關教學

前言

下載是專案中的常見需求。小檔案(圖片、文字)一次請求拉完就好,但碰到大型音訊、影片就不可能了:使用者可能下一半就切換出去,回家接著下。這時候就需要斷點續傳——隨時可以暫停,下次能從上次的進度接著下。

本文示範如何自己封裝一個簡單的斷點續傳類,達成以下目標:

    1. 呼叫單一介面即可開始下載,同時能取得進度。

    2. 下載成功後能取得檔案的存放路徑。

    3. 失敗時能拿到失敗原因。

    4. 可隨時暫停,下次從上次進度續傳。

原理

斷點續傳的本質是:客戶端記住已下載的進度,續傳時告知伺服器要從哪個位元組開始送。HTTP/1.1(RFC2616)定義了 Range 與 Content-Range 兩個相關標頭,最簡單的流程如下:

    1. 客戶端下載一個 1024K 的檔案,已完成其中 512K。

    2. 網路中斷後請求續傳,於請求標頭帶上 Range:bytes=512000-,通知伺服器從 512K 處續傳。

    3. 伺服器從 512K 開始傳輸,並在回應標頭帶上 Content-Range:bytes 512000-/1024000,此時狀態碼應為 206 而非 200。

難點說明

1. 客戶端如何取得已下載的位元組數

做法是每次下載後記錄檔案大小。iOS 已經提供現成 API,不必自己算:

 [[[NSFileManager defaultManager] attributesOfItemAtPath: FileStorePath error:nil][NSFileSize] integerValue]

2. 如何取得檔案的總位元組數

這裡要用到 HTTP 標頭的 content-length。它的含義是「訊息主體的傳輸長度」,簡單講就是本次回應要傳的位元組數。要注意:斷點續傳時伺服器回傳的是「剩餘部分」的長度,所以檔案總大小 = 已下載位元組數 + content-length。

我們把每個檔案的總大小存進 plist(檔名為 key、總大小為 value)。檔名為避免重複,直接用下載網址的 hash 值,可以保證唯一。

實作程式碼:

 - (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSHTTPURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler { self.totalLength = [response.allHeaderFields[@"Content-Length"] integerValue] + DownloadLength; NSMutableDictionary *dict = [NSMutableDictionary dictionaryWithContentsOfFile: TotalLengthPlist]; if (dict == nil) dict = [NSMutableDictionary dictionary]; dict[ Filename] = @(self.totalLength); [dict writeToFile: TotalLengthPlist atomically:YES]; }

這個 NSSessionDelegate 方法會在請求收到回應時呼叫一次,正好可以在此取出 content-length。

3. 封裝進度、成功、失敗三種回呼

可以參考 AFNetworking 的風格,把下載收進一個方法,用不同的 block 對外回報狀態。

介面定義:

 -(void)downLoadWithURL:(NSString *)URL progress:(progressBlock)progressBlock success:(successBlock)successBlock faile:(faileBlock)faileBlock { self.successBlock = successBlock; self.failedBlock = faileBlock; self.progressBlock = progressBlock; self.downLoadUrl = URL; [self.task resume]; }

三個 block 都用 typedef 定義,呼叫端看起來會乾淨不少。接著在 NSURLSessionDataDelegate 的對應方法裡觸發它們即可。

完整實作

 #import <Foundation/Foundation.h> typedef void (^successBlock) (NSString *fileStorePath); typedef void (^faileBlock) (NSError *error); typedef void (^progressBlock) (float progress); @interface DownLoadManager : NSObject <NSURLSessionDataDelegate> @property (copy) successBlock successBlock; @property (copy) faileBlock failedBlock; @property (copy) progressBlock progressBlock; -(void)downLoadWithURL:(NSString *)URL progress:(progressBlock)progressBlock success:(successBlock)successBlock faile:(faileBlock)faileBlock; + (instancetype)sharedInstance; -(void)stopTask; @end
 #import "DownLoadManager.h" #import "NSString+Hash.h" @interface DownLoadManager () /** 下載任務 */ @property (nonatomic, strong) NSURLSessionDataTask *task; /** session */ @property (nonatomic, strong) NSURLSession *session; /** 寫檔用的流物件 */ @property (nonatomic, strong) NSOutputStream *stream; /** 檔案總大小 */ @property (nonatomic, assign) NSInteger totalLength; @property(nonatomic,strong)NSString *downLoadUrl; @end // 檔名(沙盒中的檔名),用 md5 雜湊網址產生,可確保唯一 #define Filename self.downLoadUrl.md5String // 檔案存放路徑(caches) #define FileStorePath [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent: Filename] // 用 plist 記錄檔案總大小 #define TotalLengthPlist [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"totalLength.plist"] // 檔案已下載的大小 #define DownloadLength [[[NSFileManager defaultManager] attributesOfItemAtPath: FileStorePath error:nil][NSFileSize] integerValue] @implementation DownLoadManager #pragma mark - 建立單例 static id _instance; + (instancetype)allocWithZone:(struct _NSZone *)zone { static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ _instance = [super allocWithZone:zone]; }); return _instance; } + (instancetype)sharedInstance { static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ _instance = [[self alloc] init]; }); return _instance; } - (id)copyWithZone:(NSZone *)zone { return _instance; } - (id)mutableCopyWithZone:(NSZone *)zone { return _instance; } #pragma mark - 公開方法 -(void)downLoadWithURL:(NSString *)URL progress:(progressBlock)progressBlock success:(successBlock)successBlock faile:(faileBlock)faileBlock { self.successBlock = successBlock; self.failedBlock = faileBlock; self.progressBlock = progressBlock; self.downLoadUrl = URL; [self.task resume]; } -(void)stopTask{ [self.task suspend ]; } #pragma mark - getter 方法 - (NSURLSession *)session { if (!_session) { _session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[[NSOperationQueue alloc] init]]; } return _session; } - (NSOutputStream *)stream { if (!_stream) { _stream = [NSOutputStream outputStreamToFileAtPath: FileStorePath append:YES]; } return _stream; } - (NSURLSessionDataTask *)task { if (!_task) { NSInteger totalLength = [[NSDictionary dictionaryWithContentsOfFile: TotalLengthPlist][ Filename] integerValue]; if (totalLength && DownloadLength == totalLength) { NSLog(@"######檔案已經下載過了"); return nil; } // 建立請求 NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString: self.downLoadUrl]]; // 設定請求標頭 // Range : bytes=xxx-xxx,從已下載長度一路要到底 NSString *range = [NSString stringWithFormat:@"bytes=%zd-", DownloadLength]; [request setValue:range forHTTPHeaderField:@"Range"]; // 建立 Data 任務 _task = [self.session dataTaskWithRequest:request]; } return _task; } #pragma mark - <NSURLSessionDataDelegate> /** * 1.收到回應 */ - (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSHTTPURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler { // 開啟流 [self.stream open]; /* (Content-Length 回傳的是伺服器針對本次請求要傳的大小) 例如首次請求檔案 A 大小 1000 byte,第一次 Content-Length = 1000; 客戶端下到 500 byte 時中斷,再次請求的 range 為 "bytes=500-", 此時伺服器回傳的 Content-Length 為 500。 所以斷點續傳時要算檔案總大小,必須把 Content-Length 加上本地已下載的大小 */ self.totalLength = [response.allHeaderFields[@"Content-Length"] integerValue] + DownloadLength; // 把檔案總大小存進 plist NSMutableDictionary *dict = [NSMutableDictionary dictionaryWithContentsOfFile: TotalLengthPlist]; if (dict == nil) dict = [NSMutableDictionary dictionary]; dict[ Filename] = @(self.totalLength); [dict writeToFile: TotalLengthPlist atomically:YES]; // 接受回應,允許接收伺服器資料 completionHandler(NSURLSessionResponseAllow); } /** * 2.收到伺服器資料(這個方法可能被呼叫多次) */ - (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data { // 寫入資料 [self.stream write:data.bytes maxLength:data.length]; float progress = 1.0 * DownloadLength / self.totalLength; if (self.progressBlock) { self.progressBlock(progress); } // 回報下載進度 } /** * 3.請求結束(成功或失敗) */ - (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error { if (error) { if (self.failedBlock) { self.failedBlock(error); } self.stream = nil; self.task = nil; }else{ if (self.successBlock) { self.successBlock(FileStorePath); } // 關閉流 [self.stream close]; self.stream = nil; // 清除任務 self.task = nil; } } @end

呼叫方式

 @interface ViewController () @end @implementation ViewController /** * 開始下載 */ - (IBAction)start:(id)sender { // 啟動任務 NSString * downLoadUrl = @"https://audio.xmcdn.com/group11/M01/93/AF/wKgDa1dzzJLBL0gCAPUzeJqK84Y539.m4a"; [[DownLoadManager sharedInstance]downLoadWithURL:downLoadUrl progress:^(float progress) { NSLog(@"###%f",progress); } success:^(NSString *fileStorePath) { NSLog(@"###%@",fileStorePath); } faile:^(NSError *error) { NSLog(@"###%@",error.userInfo[NSLocalizedDescriptionKey]); }]; } /** * 暫停下載 */ - (IBAction)pause:(id)sender { [[DownLoadManager sharedInstance]stopTask]; } @end

總結

目前這版只支援單一任務,想擴充成多任務並行下載,需要把 task、stream 都改成以 url 為 key 的字典管理,並把暫停/恢復的狀態記下來。另外建議把進度資訊從 plist 換成資料庫儲存,讀寫更穩定也更好查詢。以上就是這篇的全部內容,希望對學習 iOS 網路編程的朋友有所幫助。

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