前言
網(wǎng)絡下載是我們在項目中經(jīng)常要用到的功能，如果是小文件的下載，比如圖片和文字之類的，我們可以直接請求源地址，然后一次下載完畢。但是如果是下載較大的音頻和視頻文件，不可能一次下載完畢，用戶可能下載一段時間，關閉程序，回家接著下載。這個時候，就需要實現(xiàn)斷點續(xù)傳的功能。讓用戶可以隨時暫停下載，下次開始下載，還能接著上次的下載的進度。
今天我們來看看如何自己簡單的封裝一個斷點續(xù)傳的類，實現(xiàn)如下功能。
1.使用者只需要調用一個接口即可以下載，同時可以獲取下載的進度。
2.下載成功，可以獲取文件存儲的位置
3.下載失敗，給出失敗的原因
4.可以暫停下載，下次開始下載，接著上次的進度繼續(xù)下載
原理講解
要實現(xiàn)斷點續(xù)傳的功能，通常都需要客戶端記錄下當前的下載進度，并在需要續(xù)傳的時候通知服務端本次需要下載的內(nèi)容片段。
在HTTP1.1協(xié)議（RFC2616）中定義了斷點續(xù)傳相關的HTTP頭的Range和Content-Range字段，一個最簡單的斷點續(xù)傳實現(xiàn)大概如下：
1.客戶端下載一個1024K的文件，已經(jīng)下載了其中512K
2.網(wǎng)絡中斷，客戶端請求續(xù)傳，因此需要在HTTP頭中申明本次需要續(xù)傳的片段：Range:bytes=512000-這個頭通知服務端從文件的512K位置開始傳輸文件
3.服務端收到斷點續(xù)傳請求，從文件的512K位置開始傳輸，并且在HTTP頭中增加：Content-Range:bytes 512000-/1024000并且此時服務端返回的HTTP狀態(tài)碼應該是206，而不是200。
難點說明
1. 客戶端如何獲取已經(jīng)下載的文件字節(jié)數(shù)
客戶端這邊，我們需要記錄下每次用戶每次下載的文件大小，然后實現(xiàn)原理講解中步驟1的功能。
那么如何記載呢？
其實我們可以直接獲取指定路徑下文件的大小，iOS已經(jīng)提供了相關的功能，實現(xiàn)代碼如下，
[[[NSFileManager defaultManager] attributesOfItemAtPath: FileStorePath error:nil][NSFileSize] integerValue]
2.如何獲取被下載文件的總字節(jié)數(shù)
上一步，我們獲取了已經(jīng)下載文件的字節(jié)數(shù)，這里我們需要獲取被下載文件的總字節(jié)數(shù)，有了這兩個值，我們就可以算出下載進度了。
那么如何獲取呢？這里我們需要用到http 頭部的conten-length字段，先來看看該字段的含義
Content-Length用于描述HTTP消息實體的傳輸長度the transfer-length of the message-body。在HTTP協(xié)議中，消息實體長度和消息實體的傳輸長度是有區(qū)別，比如說gzip壓縮下，消息實體長度是壓縮前的長度，消息實體的傳輸長度是gzip壓縮后的長度。
簡單點說，content-length表示被下載文件的字節(jié)數(shù)。
對比原理講解的第三步，我們可以看到如果要計算出文件的總字節(jié)數(shù)，那么必須把已經(jīng)下載的字節(jié)數(shù) 加上 content-length。
我們需要把每個被下載文件的總字節(jié)數(shù)存儲起來，這里我們選擇使用plist文件來記載，plist文件包含一個字典。設置文件名為鍵值，已經(jīng)下載的文件字節(jié)數(shù)為值。
文件名為了防止重復，這里我們設置文件名為下載url的hash值，可以保證不重重。
實現(xiàn)代碼如下：
- (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.封裝一個方法，實現(xiàn)下載進度，成功，失敗提示
我們可以模仿AFNetwork，把下載封裝到一個方法，然后使用不同的block來實現(xiàn)下載進度，成功，失敗后的回調。
定義如下：
-(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都采用宏定義方式，這樣看起來比較簡潔，具體代碼參考下面的完整代碼。
然后我們可以在NSURLSessionDataDelegate的對應的代理方法中去實現(xiàn)三個block的調用，然后傳入相應的參數(shù)。這樣當其他人調用我們的方法，就可以在相應的block中實現(xiàn)回調。具體代碼參考下面的完整代碼
完整代碼實現(xiàn)
下面是完整的代碼實現(xiàn)
#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哈希url生成的，這樣就能保證文件名唯一#define Filename self.downLoadUrl.md5String// 文件的存放路徑（caches）#define FileStorePath [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent: Filename]// 使用plist文件存儲已經(jīng)下載的文件大小#define TotalLengthPlist [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"totalLength.plist"]// 文件的已被下載的大小#define DownloadLength [[[NSFileManager defaultManager] attributesOfItemAtPath: FileStorePath error:nil][NSFileSize] integerValue]@implementation DownLoadManager#pragma mark - 創(chuàng)建單例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(@"######文件已經(jīng)下載過了"); return nil; } // 創(chuàng)建請求 NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString: self.downLoadUrl]]; // 設置請求頭 // Range : bytes=xxx-xxx，從已經(jīng)下載的長度開始到文件總長度的最后都要下載 NSString *range = [NSString stringWithFormat:@"bytes=%zd-", DownloadLength]; [request setValue:range forHTTPHeaderField:@"Range"]; // 創(chuàng)建一個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，大小為1000byte，那么第一次服務器返回的Content-Length = 1000， 客戶端下載到500byte，突然中斷，再次請求的range為 “bytes=500-”，那么此時服務器返回的Content-Length為500 所以對于單個文件進行多次下載的情況（斷點續(xù)傳），計算文件的總大小，必須把服務器返回的content-length加上本地存儲的已經(jīng)下載的文件大小 */ self.totalLength = [response.allHeaderFields[@"Content-Length"] integerValue] + DownloadLength; // 把此次已經(jīng)下載的文件大小存儲在plist文件 NSMutableDictionary *dict = [NSMutableDictionary dictionaryWithContentsOfFile: TotalLengthPlist]; if (dict == nil) dict = [NSMutableDictionary dictionary]; dict[ Filename] = @(self.totalLength); [dict writeToFile: TotalLengthPlist atomically:YES]; // 接收這個請求，允許接收服務器的數(shù)據(jù) completionHandler(NSURLSessionResponseAllow);}/** * 2.接收到服務器返回的數(shù)據(jù)（這個方法可能會被調用N次） */- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data{ // 寫入數(shù)據(jù) [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 = @"http://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總結
這里只能實現(xiàn)單個任務下載，大家可以自己想想辦法，看如何實現(xiàn)多任務下載，并且實現(xiàn)斷點續(xù)傳功能。并且為了更加便于操作，建議把存儲信息換成使用數(shù)據(jù)庫存儲。以上就是這篇文章的全部內(nèi)容了，希望對大家學習IOS開發(fā)有所幫助。
新聞熱點
疑難解答
