目錄
- NSURLSession下載簡介
- NSURLSession下載相關(guān)
2.1 NSURLSession(block方法)
2.2 NSURLSession(代理方法)
2.3 NSURLSession(斷點(diǎn)下載 | 不支持離線)
2.4 NSURLSession(斷點(diǎn)下載 | 支持離線)
關(guān)于『文件下載吹榴、斷點(diǎn)下載』所有實(shí)現(xiàn)的Demo地址:Demo地址
iOS網(wǎng)絡(luò)--『文件下載黄娘、斷點(diǎn)下載』的實(shí)現(xiàn)相關(guān)文章:
- iOS網(wǎng)絡(luò)--『文件下載碑定、斷點(diǎn)下載』的實(shí)現(xiàn)(一):NSURLConnection
- iOS網(wǎng)絡(luò)--『文件下載、斷點(diǎn)下載』的實(shí)現(xiàn)(二):NSURLSession
- iOS網(wǎng)絡(luò)--『文件下載咱旱、斷點(diǎn)下載』的實(shí)現(xiàn)(三):AFNetworking
1. NSURLSession下載簡介
iOS 7之后叶骨,蘋果對(duì)Foundation URL 加載系統(tǒng)的徹底重構(gòu)茫多。在 2013 的 WWDC 上,蘋果推出了 NSURLConnection 的繼任者:NSURLSession忽刽。相比于NSURLConnection來說天揖,使用NSURLSession下載就要簡單多了,我們不需要分別考慮大小文件跪帝,只需要考慮使用不同的方法實(shí)現(xiàn)相應(yīng)的功能即可今膊。
NSURLSession提供了兩種下載方式,一種是block方法伞剑,一種是通過NSURLSessionDownloadDelegate的代理方法實(shí)現(xiàn)下載万细。
2. NSURLSession下載相關(guān)
2.1 NSURLSession(block方法)
NSURLSession的block使用方法如下:
- 先創(chuàng)建一個(gè)NSURLSession類。
- 再創(chuàng)建一個(gè)下載任務(wù)類NSURLSessionDownloadTask類纸泄,將session加入到下載任務(wù)中。
- 開啟下載任務(wù)腰素。
其中聘裁,開啟下載任務(wù)后,NSURLSessionDownloadTask默認(rèn)就會(huì)將數(shù)據(jù)一點(diǎn)點(diǎn)寫入本地沙盒的臨時(shí)文件(tmp)中弓千。這些原本需要我們自己做的任務(wù)蘋果默認(rèn)都幫助我們做好了衡便。
但是,由于NSURLSessionDownloadTask寫入的是本地沙盒的臨時(shí)文件中,所以我們需要在臨時(shí)文件下載之后镣陕,即在NSURLSessionDownloadTask的completionHandler這個(gè)block中谴餐,將臨時(shí)文件剪切到一個(gè)永久的文件地址保存起來。
具體代碼如下:
// 創(chuàng)建下載路徑
NSURL *url = [NSURL URLWithString:@"http://bmob-cdn-8782.b0.upaiyun.com/2017/01/17/c6b6bb1640e9ae9e80b221c454c4e90d.jpg"];
// 創(chuàng)建NSURLRequest請(qǐng)求
NSURLRequest *request = [NSURLRequest requestWithURL:url];
// 創(chuàng)建NSURLSession對(duì)象
NSURLSession *session = [NSURLSession sharedSession];
// 創(chuàng)建下載任務(wù),其中l(wèi)ocation為下載的臨時(shí)文件路徑
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
// 文件將要移動(dòng)到的指定目錄
NSString *documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
// 新文件路徑
NSString *newFilePath = [documentsPath stringByAppendingPathComponent:response.suggestedFilename];
// 移動(dòng)文件到新路徑
[[NSFileManager defaultManager] moveItemAtPath:location.path toPath:newFilePath error:nil];
}];
// 開始下載任務(wù)
[downloadTask resume];
這樣雖然實(shí)現(xiàn)了文件下載呆抑,但是卻無法監(jiān)聽下載進(jìn)度岂嗓。
2.2 NSURLSession(代理方法)
如果想要監(jiān)聽下載進(jìn)度,我們就需要用到NSURLSessionDownloadDelegate鹊碍。
具體使用方式就是使用代理的方法創(chuàng)建下載任務(wù)厌殉,并且實(shí)現(xiàn)對(duì)應(yīng)的代理方法。
具體實(shí)現(xiàn)代碼如下:
// 創(chuàng)建下載路徑
NSURL *url = [NSURL URLWithString:@"http://dldir1.qq.com/qqfile/QQforMac/QQ_V5.4.0.dmg"];
// 創(chuàng)建NSURLSession對(duì)象侈咕,并設(shè)計(jì)代理方法公罕。其中NSURLSessionConfiguration為默認(rèn)配置
NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
// 創(chuàng)建任務(wù)
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url];
// 開始任務(wù)
[downloadTask resume];
這里使用到了代理,所以我們要實(shí)現(xiàn)NSURLSessionDownloadDelegate的相關(guān)方法耀销。主要用到以下幾個(gè)方法楼眷。
#pragma mark <NSURLSessionDownloadDelegate> 實(shí)現(xiàn)方法
/**
* 文件下載完畢時(shí)調(diào)用
*/
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(NSURL *)location
{
// 文件將要移動(dòng)到的指定目錄
NSString *documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
// 新文件路徑
NSString *newFilePath = [documentsPath stringByAppendingPathComponent:@"QQ_V5.4.0.dmg"];
NSLog(@"File downloaded to: %@",newFilePath);
// 移動(dòng)文件到新路徑
[[NSFileManager defaultManager] moveItemAtPath:location.path toPath:newFilePath error:nil];
}
/**
* 每次寫入數(shù)據(jù)到臨時(shí)文件時(shí),就會(huì)調(diào)用一次這個(gè)方法熊尉」蘖可在這里獲得下載進(jìn)度
*
* @param bytesWritten 這次寫入的文件大小
* @param totalBytesWritten 已經(jīng)寫入沙盒的文件大小
* @param totalBytesExpectedToWrite 文件總大小
*/
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
didWriteData:(int64_t)bytesWritten
totalBytesWritten:(int64_t)totalBytesWritten
totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
// 下載進(jìn)度
self.progressView.progress = 1.0 * totalBytesWritten / totalBytesExpectedToWrite;
self.progressLabel.text = [NSString stringWithFormat:@"當(dāng)前下載進(jìn)度:%.2f%%",100.0 * totalBytesWritten / totalBytesExpectedToWrite];
}
/**
* 恢復(fù)下載后調(diào)用
*/
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
didResumeAtOffset:(int64_t)fileOffset
expectedTotalBytes:(int64_t)expectedTotalBytes
{
}
2.3 NSURLSession(斷點(diǎn)下載 | 不支持離線)
NSURLSession擁有終止下載的方法:- (void)cancelByProducingResumeData:(void (^)(NSData *resumeData))completionHandler;
。
其中的參數(shù)resumeData包含了此次下載文件的請(qǐng)求路徑帽揪,以及下載文件的位置信息硝清。
而且NSURLSession還有一個(gè)方法- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData;
,可以利用上次停止下載的resumeData转晰,開啟一個(gè)新的任務(wù)繼續(xù)下載芦拿。
因?yàn)樯婕氨4嫔洗蜗螺d的resumeData,所以我們要將resumeData保存為全局變量查邢,以便使用蔗崎。另外還有一些其他類需要保存為全局變量。
但是使用這樣的方法進(jìn)行斷點(diǎn)下載扰藕,如果程序被殺死缓苛,再重新啟動(dòng)的話,是無法繼續(xù)下載的邓深。只能重新開始下載未桥。也就是說不支持離線下載。
NSURLSession斷點(diǎn)下載(不支持離線)實(shí)現(xiàn)斷點(diǎn)下載的步驟如下:
- 在實(shí)現(xiàn)斷點(diǎn)下載的[開始/暫停]按鈕中添加以下步驟:
- 設(shè)置一個(gè)downloadTask芥备、session以及resumeData的全局變量
- 如果開始下載冬耿,就創(chuàng)建一個(gè)新的downloadTask,并啟動(dòng)下載
- 如果暫停下載萌壳,調(diào)用取消下載的函數(shù)亦镶,并在block中保存本次的resumeData到全局resumeData中日月。
- 如果恢復(fù)下載,將上次保存的resumeData加入到任務(wù)中缤骨,并啟動(dòng)下載爱咬。
具體實(shí)現(xiàn)過程如下:
- 定義下載文件需要用到的類和要實(shí)現(xiàn)的代理
@interface ViewController () <NSURLSessionDownloadDelegate>
/** 下載進(jìn)度條 */
@property (weak, nonatomic) IBOutlet UIProgressView *progressView;
/** 下載進(jìn)度條Label */
@property (weak, nonatomic) IBOutlet UILabel *progressLabel;
/** NSURLSession斷點(diǎn)下載(不支持離線)需用到的屬性 **********/
/** 下載任務(wù) */
@property (nonatomic, strong) NSURLSessionDownloadTask *downloadTask;
/** 保存上次的下載信息 */
@property (nonatomic, strong) NSData *resumeData;
/** session */
@property (nonatomic, strong) NSURLSession *session;
@end
- 實(shí)現(xiàn)下面的按鈕點(diǎn)擊代碼,其中用到了session的懶加載绊起。
/**
* 點(diǎn)擊按鈕 -- 使用NSURLSession斷點(diǎn)下載(不支持離線)
*/
- (IBAction)resumeDownloadBtnClicked:(UIButton *)sender {
// 按鈕狀態(tài)取反
sender.selected = !sender.isSelected;
if (nil == self.downloadTask) { // [開始下載/繼續(xù)下載]
if (self.resumeData) { // [繼續(xù)下載]
// 傳入上次暫停下載返回的數(shù)據(jù)精拟,就可以恢復(fù)下載
self.downloadTask = [self.session downloadTaskWithResumeData:self.resumeData];
// 開始任務(wù)
[self.downloadTask resume];
self.resumeData = nil;
}else{ // [開始下載]:從0開始下載
NSURL* url = [NSURL URLWithString:@"http://dldir1.qq.com/qqfile/QQforMac/QQ_V5.4.0.dmg"];
// 創(chuàng)建任務(wù)
self.downloadTask = [self.session downloadTaskWithURL:url];
// 開始任務(wù)
[self.downloadTask resume];
}
}else{ // [暫停下載]
__weak typeof(self) weakSelf = self;
[self.downloadTask cancelByProducingResumeData:^(NSData *resumeData) {
// resumeData:包含了繼續(xù)下載的位置\下載的路徑
weakSelf.resumeData = resumeData;
weakSelf.downloadTask = nil;
}];
}
}
- 這里使用到了代理,所以我們要實(shí)現(xiàn)NSURLSessionDownloadDelegate的相關(guān)方法勒庄。代碼和之前2.2 NSURLSession(代理方法)中實(shí)現(xiàn)的代理方法一致串前。
這里使用了NSURLSessionDownloadTask完成離線下載。但是NSURLSessionDownloadTask會(huì)自動(dòng)將文件下載到了tmp臨時(shí)文件中实蔽。我們只能在文件下載完畢的時(shí)候荡碾,將臨時(shí)下載文件轉(zhuǎn)存到永久文件路徑保存起來。這樣的話局装,如果程序被殺死坛吁,再次啟動(dòng)的時(shí)候,之前下載的臨時(shí)文件已經(jīng)消失了铐尚。我們很難拿到已經(jīng)下載的文件拨脉,然后繼續(xù)下載。
不過沒關(guān)系宣增,我們可以用NSURLSessionDataTask來實(shí)現(xiàn)NSURLSession的離線斷點(diǎn)下載玫膀。
2.4 NSURLSession(斷點(diǎn)下載 | 支持離線)
NSURLSessionDataTask在發(fā)送請(qǐng)求之后,能夠?qū)⒎祷氐臄?shù)據(jù)爹脾,作為data一部分一部分的接受過來帖旨。這樣,我們就可以像NSURLConnection上邊那樣灵妨,創(chuàng)建一個(gè)NSFilehandle(文件句柄)類解阅,在接受數(shù)據(jù)的時(shí)候,一點(diǎn)點(diǎn)寫入永久沙盒文件中泌霍。并且在下次開始的時(shí)候货抄,設(shè)置好HTTP請(qǐng)求頭的Rang。我們就可以實(shí)現(xiàn)離線斷點(diǎn)下載了朱转。
具體實(shí)現(xiàn)過程如下:
- 定義下載文件需要用到的類和要實(shí)現(xiàn)的代理
@interface ViewController () <NSURLSessionDataDelegate>
/** 下載進(jìn)度條 */
@property (weak, nonatomic) IBOutlet UIProgressView *progressView;
/** 下載進(jìn)度條Label */
@property (weak, nonatomic) IBOutlet UILabel *progressLabel;
/** NSURLSession斷點(diǎn)下載(支持離線)需用到的屬性 **********/
/** 文件的總長度 */
@property (nonatomic, assign) NSInteger fileLength;
/** 當(dāng)前下載長度 */
@property (nonatomic, assign) NSInteger currentLength;
/** 文件句柄對(duì)象 */
@property (nonatomic, strong) NSFileHandle *fileHandle;
/** 下載任務(wù) */
@property (nonatomic, strong) NSURLSessionDataTask *downloadTask;
/** session */
@property (nonatomic, strong) NSURLSession *session;
@end
- 添加支持?jǐn)帱c(diǎn)下載的[開始下載/暫停下載]按鈕蟹地,并實(shí)現(xiàn)相應(yīng)功能的代碼
/**
* session的懶加載
*/
- (NSURLSession *)session
{
if (!_session) {
_session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
}
return _session;
}
/**
* downloadTask的懶加載,這里設(shè)置請(qǐng)求頭中的Range
*/
- (NSURLSessionDataTask *)downloadTask {
if (!_downloadTask) {
// 創(chuàng)建下載URL
NSURL *url = [NSURL URLWithString:@"http://dldir1.qq.com/qqfile/QQforMac/QQ_V5.4.0.dmg"];
// 2.創(chuàng)建request請(qǐng)求
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
// 設(shè)置HTTP請(qǐng)求頭中的Range
NSString *range = [NSString stringWithFormat:@"bytes=%zd-", self.currentLength];
[request setValue:range forHTTPHeaderField:@"Range"];
// 3. 下載
_downloadTask = [self.session dataTaskWithRequest:request];
}
return _downloadTask;
}
/**
* 點(diǎn)擊按鈕 -- 使用NSURLSession斷點(diǎn)下載(支持離線)
*/
- (IBAction)OfflinResumeDownloadBtnClicked:(UIButton *)sender {
// 按鈕狀態(tài)取反
sender.selected = !sender.isSelected;
if (sender.selected) { // [開始下載/繼續(xù)下載]
// 沙盒文件路徑
NSString *path = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"QQ_V5.4.0.dmg"];
NSInteger currentLength = [self fileLengthForPath:path];
if (currentLength > 0) { // [繼續(xù)下載]
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;
}
- 最后實(shí)現(xiàn)相關(guān)的NSURLSessionDataDelegate方法藤为,可參考NSURLConnection實(shí)現(xiàn)斷點(diǎn)下載的方法锈津。
- 相關(guān)文章鏈接:iOS網(wǎng)絡(luò)--『文件下載、斷點(diǎn)下載』(一):NSURLConnection凉蜂。
#pragma mark - <NSURLSessionDataDelegate> 實(shí)現(xiàn)方法
/**
* 接收到響應(yīng)的時(shí)候:創(chuàng)建一個(gè)空的沙盒文件
*/
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler
{
// 獲得下載文件的總長度:請(qǐng)求下載的文件長度 + 當(dāng)前已經(jīng)下載的文件長度
self.fileLength = response.expectedContentLength + self.currentLength;
// 沙盒文件路徑
NSString *path = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"QQ_V5.4.0.dmg"];
NSLog(@"File downloaded to: %@",path);
// 創(chuàng)建一個(gè)空的文件到沙盒中
NSFileManager *manager = [NSFileManager defaultManager];
if (![manager fileExistsAtPath:path]) {
// 如果沒有下載文件的話,就創(chuàng)建一個(gè)文件。如果有下載文件的話窿吩,則不用重新創(chuàng)建(不然會(huì)覆蓋掉之前的文件)
[manager createFileAtPath:path contents:nil attributes:nil];
}
// 創(chuàng)建文件句柄
self.fileHandle = [NSFileHandle fileHandleForWritingAtPath:path];
// 允許處理服務(wù)器的響應(yīng)茎杂,才會(huì)繼續(xù)接收服務(wù)器返回的數(shù)據(jù)
completionHandler(NSURLSessionResponseAllow);
}
/**
* 接收到具體數(shù)據(jù):把數(shù)據(jù)寫入沙盒文件中
*/
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
{
// 指定數(shù)據(jù)的寫入位置 -- 文件內(nèi)容的最后面
[self.fileHandle seekToEndOfFile];
// 向沙盒寫入數(shù)據(jù)
[self.fileHandle writeData:data];
// 拼接文件總長度
self.currentLength += data.length;
NSLog(@"%ld",self.currentLength);
__weak typeof(self) weakSelf = self;
// 獲取主線程,不然無法正確顯示進(jìn)度纫雁。
NSOperationQueue* mainQueue = [NSOperationQueue mainQueue];
[mainQueue addOperationWithBlock:^{
// 下載進(jìn)度
weakSelf.progressView.progress = 1.0 * weakSelf.currentLength / weakSelf.fileLength;
weakSelf.progressLabel.text = [NSString stringWithFormat:@"當(dāng)前下載進(jìn)度:%.2f%%",100.0 * self.currentLength / self.fileLength];
}];
}
/**
* 下載完文件之后調(diào)用:關(guān)閉文件煌往、清空長度
*/
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
// 關(guān)閉fileHandle
[self.fileHandle closeFile];
self.fileHandle = nil;
// 清空長度
self.currentLength = 0;
self.fileLength = 0;
}
這樣就使用NSURLSession、NSURLSessionDataTask實(shí)現(xiàn)了『離線斷點(diǎn)下載』的需求轧邪。