本文首發於我的個人博客:『不羈閣』 https://bujige.net
文章鏈接:https://bujige.net/blog/iOS-Resume-Download-NSURLSession.html
目錄
- NSURLSession下載簡介
- NSURLSession下載相關
2.1 NSURLSession(block方法)
2.2 NSURLSession(代理方法)
2.3 NSURLSession(斷點下載 | 不支持離線)
2.4 NSURLSession(斷點下載 | 支持離線)
關於『文件下載、斷點下載』所有實現的Demo地址:Demo地址
iOS網絡--『文件下載、斷點下載』的實現相關文章:
- iOS網絡--『文件下載、斷點下載』的實現(一):NSURLConnection
- iOS網絡--『文件下載、斷點下載』的實現(二):NSURLSession
- iOS網絡--『文件下載、斷點下載』的實現(三):AFNetworking
1. NSURLSession下載簡介
iOS 7之後,蘋果對Foundation URL 加載系統的徹底重構。在 2013 的 WWDC 上,蘋果推出了 NSURLConnection 的繼任者:NSURLSession。相比於NSURLConnection來說,使用NSURLSession下載就要簡單多了,我們不需要分別考慮大小文件,只需要考慮使用不同的方法實現相應的功能即可。
NSURLSession提供了兩種下載方式,一種是block方法,一種是通過NSURLSessionDownloadDelegate的代理方法實現下載。
2. NSURLSession下載相關
2.1 NSURLSession(block方法)
NSURLSession的block使用方法如下:
- 先創建一個NSURLSession類。
- 再創建一個下載任務類NSURLSessionDownloadTask類,將session加入到下載任務中。
- 開啓下載任務。
其中,開啓下載任務後,NSURLSessionDownloadTask默認就會將數據一點點寫入本地沙盒的臨時文件(tmp)中。這些原本需要我們自己做的任務蘋果默認都幫助我們做好了。
但是,由於NSURLSessionDownloadTask寫入的是本地沙盒的臨時文件中,所以我們需要在臨時文件下載之後,即在NSURLSessionDownloadTask的completionHandler這個block中,將臨時文件剪切到一個永久的文件地址保存起來。
具體代碼如下:
// 創建下載路徑
NSURL *url = [NSURL URLWithString:@"http://bmob-cdn-8782.b0.upaiyun.com/2017/01/17/c6b6bb1640e9ae9e80b221c454c4e90d.jpg"];
// 創建NSURLRequest請求
NSURLRequest *request = [NSURLRequest requestWithURL:url];
// 創建NSURLSession對象
NSURLSession *session = [NSURLSession sharedSession];
// 創建下載任務,其中location爲下載的臨時文件路徑
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
// 文件將要移動到的指定目錄
NSString *documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
// 新文件路徑
NSString *newFilePath = [documentsPath stringByAppendingPathComponent:response.suggestedFilename];
// 移動文件到新路徑
[[NSFileManager defaultManager] moveItemAtPath:location.path toPath:newFilePath error:nil];
}];
// 開始下載任務
[downloadTask resume];
這樣雖然實現了文件下載,但是卻無法監聽下載進度。
2.2 NSURLSession(代理方法)
如果想要監聽下載進度,我們就需要用到NSURLSessionDownloadDelegate。
具體使用方式就是使用代理的方法創建下載任務,並且實現對應的代理方法。
具體實現代碼如下:
// 創建下載路徑
NSURL *url = [NSURL URLWithString:@"http://dldir1.qq.com/qqfile/QQforMac/QQ_V5.4.0.dmg"];
// 創建NSURLSession對象,並設計代理方法。其中NSURLSessionConfiguration爲默認配置
NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
// 創建任務
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url];
// 開始任務
[downloadTask resume];
這裏使用到了代理,所以我們要實現NSURLSessionDownloadDelegate的相關方法。主要用到以下幾個方法。
#pragma mark <NSURLSessionDownloadDelegate> 實現方法
/**
* 文件下載完畢時調用
*/
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(NSURL *)location
{
// 文件將要移動到的指定目錄
NSString *documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
// 新文件路徑
NSString *newFilePath = [documentsPath stringByAppendingPathComponent:@"QQ_V5.4.0.dmg"];
NSLog(@"File downloaded to: %@",newFilePath);
// 移動文件到新路徑
[[NSFileManager defaultManager] moveItemAtPath:location.path toPath:newFilePath error:nil];
}
/**
* 每次寫入數據到臨時文件時,就會調用一次這個方法。可在這裏獲得下載進度
*
* @param bytesWritten 這次寫入的文件大小
* @param totalBytesWritten 已經寫入沙盒的文件大小
* @param totalBytesExpectedToWrite 文件總大小
*/
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
didWriteData:(int64_t)bytesWritten
totalBytesWritten:(int64_t)totalBytesWritten
totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
// 下載進度
self.progressView.progress = 1.0 * totalBytesWritten / totalBytesExpectedToWrite;
self.progressLabel.text = [NSString stringWithFormat:@"當前下載進度:%.2f%%",100.0 * totalBytesWritten / totalBytesExpectedToWrite];
}
/**
* 恢復下載後調用
*/
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
didResumeAtOffset:(int64_t)fileOffset
expectedTotalBytes:(int64_t)expectedTotalBytes
{
}
2.3 NSURLSession(斷點下載 | 不支持離線)
NSURLSession擁有終止下載的方法:- (void)cancelByProducingResumeData:(void (^)(NSData *resumeData))completionHandler;
。
其中的參數resumeData包含了此次下載文件的請求路徑,以及下載文件的位置信息。
而且NSURLSession還有一個方法- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData;
,可以利用上次停止下載的resumeData,開啓一個新的任務繼續下載。
因爲涉及保存上次下載的resumeData,所以我們要將resumeData保存爲全局變量,以便使用。另外還有一些其他類需要保存爲全局變量。
但是使用這樣的方法進行斷點下載,如果程序被殺死,再重新啓動的話,是無法繼續下載的。只能重新開始下載。也就是說不支持離線下載。
NSURLSession斷點下載(不支持離線)實現斷點下載的步驟如下:
- 在實現斷點下載的[開始/暫停]按鈕中添加以下步驟:
- 設置一個downloadTask、session以及resumeData的全局變量
- 如果開始下載,就創建一個新的downloadTask,並啓動下載
- 如果暫停下載,調用取消下載的函數,並在block中保存本次的resumeData到全局resumeData中。
- 如果恢復下載,將上次保存的resumeData加入到任務中,並啓動下載。
具體實現過程如下:
- 定義下載文件需要用到的類和要實現的代理
@interface ViewController () <NSURLSessionDownloadDelegate>
/** 下載進度條 */
@property (weak, nonatomic) IBOutlet UIProgressView *progressView;
/** 下載進度條Label */
@property (weak, nonatomic) IBOutlet UILabel *progressLabel;
/** NSURLSession斷點下載(不支持離線)需用到的屬性 **********/
/** 下載任務 */
@property (nonatomic, strong) NSURLSessionDownloadTask *downloadTask;
/** 保存上次的下載信息 */
@property (nonatomic, strong) NSData *resumeData;
/** session */
@property (nonatomic, strong) NSURLSession *session;
@end
- 實現下面的按鈕點擊代碼,其中用到了session的懶加載。
/**
* 點擊按鈕 -- 使用NSURLSession斷點下載(不支持離線)
*/
- (IBAction)resumeDownloadBtnClicked:(UIButton *)sender {
// 按鈕狀態取反
sender.selected = !sender.isSelected;
if (nil == self.downloadTask) { // [開始下載/繼續下載]
if (self.resumeData) { // [繼續下載]
// 傳入上次暫停下載返回的數據,就可以恢復下載
self.downloadTask = [self.session downloadTaskWithResumeData:self.resumeData];
// 開始任務
[self.downloadTask resume];
self.resumeData = nil;
}else{ // [開始下載]:從0開始下載
NSURL* url = [NSURL URLWithString:@"http://dldir1.qq.com/qqfile/QQforMac/QQ_V5.4.0.dmg"];
// 創建任務
self.downloadTask = [self.session downloadTaskWithURL:url];
// 開始任務
[self.downloadTask resume];
}
}else{ // [暫停下載]
__weak typeof(self) weakSelf = self;
[self.downloadTask cancelByProducingResumeData:^(NSData *resumeData) {
// resumeData:包含了繼續下載的位置\下載的路徑
weakSelf.resumeData = resumeData;
weakSelf.downloadTask = nil;
}];
}
}
- 這裏使用到了代理,所以我們要實現NSURLSessionDownloadDelegate的相關方法。代碼和之前2.2 NSURLSession(代理方法)中實現的代理方法一致。
這裏使用了NSURLSessionDownloadTask完成離線下載。但是NSURLSessionDownloadTask會自動將文件下載到了tmp臨時文件中。我們只能在文件下載完畢的時候,將臨時下載文件轉存到永久文件路徑保存起來。這樣的話,如果程序被殺死,再次啓動的時候,之前下載的臨時文件已經消失了。我們很難拿到已經下載的文件,然後繼續下載。
不過沒關係,我們可以用NSURLSessionDataTask來實現NSURLSession的離線斷點下載。
2.4 NSURLSession(斷點下載 | 支持離線)
NSURLSessionDataTask在發送請求之後,能夠將返回的數據,作爲data一部分一部分的接受過來。這樣,我們就可以像NSURLConnection上邊那樣,創建一個NSFilehandle(文件句柄)類,在接受數據的時候,一點點寫入永久沙盒文件中。並且在下次開始的時候,設置好HTTP請求頭的Rang。我們就可以實現離線斷點下載了。
具體實現過程如下:
- 定義下載文件需要用到的類和要實現的代理
@interface ViewController () <NSURLSessionDataDelegate>
/** 下載進度條 */
@property (weak, nonatomic) IBOutlet UIProgressView *progressView;
/** 下載進度條Label */
@property (weak, nonatomic) IBOutlet UILabel *progressLabel;
/** NSURLSession斷點下載(支持離線)需用到的屬性 **********/
/** 文件的總長度 */
@property (nonatomic, assign) NSInteger fileLength;
/** 當前下載長度 */
@property (nonatomic, assign) NSInteger currentLength;
/** 文件句柄對象 */
@property (nonatomic, strong) NSFileHandle *fileHandle;
/** 下載任務 */
@property (nonatomic, strong) NSURLSessionDataTask *downloadTask;
/** session */
@property (nonatomic, strong) NSURLSession *session;
@end
- 添加支持斷點下載的[開始下載/暫停下載]按鈕,並實現相應功能的代碼
/**
* session的懶加載
*/
- (NSURLSession *)session
{
if (!_session) {
_session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
}
return _session;
}
/**
* downloadTask的懶加載,這裏設置請求頭中的Range
*/
- (NSURLSessionDataTask *)downloadTask {
if (!_downloadTask) {
// 創建下載URL
NSURL *url = [NSURL URLWithString:@"http://dldir1.qq.com/qqfile/QQforMac/QQ_V5.4.0.dmg"];
// 2.創建request請求
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
// 設置HTTP請求頭中的Range
NSString *range = [NSString stringWithFormat:@"bytes=%zd-", self.currentLength];
[request setValue:range forHTTPHeaderField:@"Range"];
// 3. 下載
_downloadTask = [self.session dataTaskWithRequest:request];
}
return _downloadTask;
}
/**
* 點擊按鈕 -- 使用NSURLSession斷點下載(支持離線)
*/
- (IBAction)OfflinResumeDownloadBtnClicked:(UIButton *)sender {
// 按鈕狀態取反
sender.selected = !sender.isSelected;
if (sender.selected) { // [開始下載/繼續下載]
// 沙盒文件路徑
NSString *path = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"QQ_V5.4.0.dmg"];
NSInteger currentLength = [self fileLengthForPath:path];
if (currentLength > 0) { // [繼續下載]
self.currentLength = currentLength;
}
[self.downloadTask resume];
} else {
[self.downloadTask suspend];
self.downloadTask = nil;
}
}
/**
* 獲取已下載的文件大小
*/
- (NSInteger)fileLengthForPath:(NSString *)path {
NSInteger fileLength = 0;
NSFileManager *fileManager = [[NSFileManager alloc] init]; // default is not thread safe
if ([fileManager fileExistsAtPath:path]) {
NSError *error = nil;
NSDictionary *fileDict = [fileManager attributesOfItemAtPath:path error:&error];
if (!error && fileDict) {
fileLength = [fileDict fileSize];
}
}
return fileLength;
}
- 最後實現相關的NSURLSessionDataDelegate方法,可參考NSURLConnection實現斷點下載的方法。
#pragma mark - <NSURLSessionDataDelegate> 實現方法
/**
* 接收到響應的時候:創建一個空的沙盒文件
*/
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler
{
// 獲得下載文件的總長度:請求下載的文件長度 + 當前已經下載的文件長度
self.fileLength = response.expectedContentLength + self.currentLength;
// 沙盒文件路徑
NSString *path = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"QQ_V5.4.0.dmg"];
NSLog(@"File downloaded to: %@",path);
// 創建一個空的文件到沙盒中
NSFileManager *manager = [NSFileManager defaultManager];
if (![manager fileExistsAtPath:path]) {
// 如果沒有下載文件的話,就創建一個文件。如果有下載文件的話,則不用重新創建(不然會覆蓋掉之前的文件)
[manager createFileAtPath:path contents:nil attributes:nil];
}
// 創建文件句柄
self.fileHandle = [NSFileHandle fileHandleForWritingAtPath:path];
// 允許處理服務器的響應,纔會繼續接收服務器返回的數據
completionHandler(NSURLSessionResponseAllow);
}
/**
* 接收到具體數據:把數據寫入沙盒文件中
*/
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
{
// 指定數據的寫入位置 -- 文件內容的最後面
[self.fileHandle seekToEndOfFile];
// 向沙盒寫入數據
[self.fileHandle writeData:data];
// 拼接文件總長度
self.currentLength += data.length;
NSLog(@"%ld",self.currentLength);
__weak typeof(self) weakSelf = self;
// 獲取主線程,不然無法正確顯示進度。
NSOperationQueue* mainQueue = [NSOperationQueue mainQueue];
[mainQueue addOperationWithBlock:^{
// 下載進度
weakSelf.progressView.progress = 1.0 * weakSelf.currentLength / weakSelf.fileLength;
weakSelf.progressLabel.text = [NSString stringWithFormat:@"當前下載進度:%.2f%%",100.0 * self.currentLength / self.fileLength];
}];
}
/**
* 下載完文件之後調用:關閉文件、清空長度
*/
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
// 關閉fileHandle
[self.fileHandle closeFile];
self.fileHandle = nil;
// 清空長度
self.currentLength = 0;
self.fileLength = 0;
}
這樣就使用NSURLSession、NSURLSessionDataTask實現了『離線斷點下載』的需求。