最近项目中遇到了大文件下载,先用了AFNetwork去实现了一下,果然简单实用,就像官方说的那样,明明你用几行代码就能实现的东西,干嘛要去写几百行代码,所以我自己写了一个Demo,以后慢慢完善,目的是让自己记住有这么回事儿,不然转头就忘了。
本文要讲的四件事儿
1、大文件下载要了解的NSURLSession和NSURLSessionDownloadTask
2、后台下载要在大文件下载的基础上再调用一行代码
3、断点续传要在大文件下载的基础上再保存一个叫resumeData的东西,下次传的时候给带上
4、杀死进程后的断点续传就是在杀死进程后会走一个回调,在回调里保存一个叫resumeData的东西,下次传的时候给带上
一、大文件下载
大文件下载分四步
1.NSURLSessionConfiguration初始化
2.NSURLSession初始化
3.创建NSURLSessionDownloadTask
4.实现四个代理方法
1.NSURLSessionConfiguration初始化
在初始化NSURLSession之前需要配置NSURLSessionConfiguration,有三种模式可以选择。
//默认模式,使用的是持久化的硬盘缓存
defaultSessionConfiguration;
//仅使用内存缓存,不会做持久存储到磁盘等,在session被释放后,数据会被清除,一般用于浏览器的无痕浏览
ephemeralSessionConfiguration;
//后台传输模式,咱们主要用的是这个模式,
backgroundSessionConfigurationWithIdentifier
我们这里使用backgroundSessionConfigurationWithIdentifier,因为这就是NSURLSession牛逼的地方,我们要让应用压入后台以后还能继续下载。
代码如下:
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration backgroundSessionConfigurationWithIdentifier:@"BackgroundDownloadIdentifier"];
//是否允许蜂窝下载
configuration.allowsCellularAccess = NO;
2.NSURLSession初始化
NSURLSessionConfiguration配置好以后就可以设置NSURLSession了,注意,文件下载只需要有一个Session就够了,要下载多个文件可以创建多个NSURLSessionDownloadTask。
代码如下:
//默认单线程执行大文件下载
NSOperationQueue *queue = [[NSOperationQueue alloc] init];
queue.maxConcurrentOperationCount = 1;//这里可以设置它的最大并发数
//创建会话
self.session = [NSURLSession sessionWithConfiguration:configuration delegate:self delegateQueue:queue];
3.创建NSURLSessionDownloadTask
session设置完以后就可以进行下载操作了,一行代码的事儿
代码如下:
NSURLSessionDownloadTask *downloadTask = [self.session downloadTaskWithURL:[NSURL URLWithString:urlStr]];
4.实现四个代理方法
#pragma mark - NSURLSessionDownloadDelegate
/**
每次传一个包调用一次该方法,可以从中获得下载进度,速度和文件大小
@param session 当前的session会话
@param downloadTask 当前的下载任务NSURLSessionDownloadTask
@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 {
//进度
float progress = 1.0 * totalBytesWritten / totalBytesExpectedToWrite;
self.downloadProgressBlock(progress);
}
/**
下载完成后,会调用该方法
@param session 当前的session会话
@param downloadTask 当前的下载任务NSURLSessionDownloadTask
@param location 文件下载下来后系统自动保存的地址,location下的文件会被系统自动删除
*/
- (void)URLSession:(NSURLSession *)session
downloadTask:(nonnull NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(nonnull NSURL *)location {
//移动文件到自己想要保存的路径下,location下的文件会被系统自动删除
NSError *saveError = nil;
NSFileManager *fileManager = [NSFileManager defaultManager];
NSString *savePath = [self savePathWithUrl:downloadTask.taskDescription];
if ([fileManager fileExistsAtPath:savePath]) {
[fileManager removeItemAtPath:savePath error:nil];
}
BOOL success = [fileManager moveItemAtPath:location.path toPath:savePath error:&saveError];
if (success) {
NSLog(@"文件下载完成,路径为 == %@", savePath);
self.downloadSuccessBlock([NSURL URLWithString:savePath]);
//删除之前保存的用来断点续传的resumeData
[self removeDownloadTmpFileWithUrl:downloadTask.taskDescription];
} else {
NSLog(@"在转移文件时发生错误 %@", saveError);
}
}
#pragma mark - NSURLSessionTaskDelegate
/**
每次任务结束后调用,结束并不代表它下载完了,有以下几种情况
1、没错误
2、用户取消下载
3、进程在后台被杀死了
4、其他错误
偷偷说一句,这个error里面有断点续传需要的resumeData
@param session 当前的session会话
@param task 当前的下载任务NSURLSessionTask,
NSURLSessionDownloadTask继承它
@param error 错误信息
*/
-(void)URLSession:(nonnull NSURLSession *)session
task:(nonnull NSURLSessionTask *)task
didCompleteWithError:(nullable NSError *)error {
if (error) {
//用户取消下载会回调一个error,
if ([error.localizedDescription isEqualToString:@"cancelled"]) {
return;
}
//如果是在后台进程被杀死了,则保存一下resumeData
if ([error.userInfo objectForKey:NSURLErrorBackgroundTaskCancelledReasonKey]) {
[self saveDownloadTmpFileWithResumeData:[error.userInfo objectForKey:NSURLSessionDownloadTaskResumeData] url:task.taskDescription];
}
//暂时就是出任何错都让resumeData保存一下吧
[self saveDownloadTmpFileWithResumeData:[error.userInfo objectForKey:NSURLSessionDownloadTaskResumeData] url:task.taskDescription];
NSLog(@"error = %@", error);
}
}
#pragma mark - NSURLSessionDelegate
//应用处于后台,所有下载任务已经完成,且其他代理方法都调用完以后调用
- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession *)session {
NSLog(@"应用在后台该做的事儿都做完了");
}
二、后台下载
在AppDelegate中调用一行代码
- (void)applicationDidEnterBackground:(UIApplication *)application {
//调用这句,防止应用在进入后台后所有任务被终止
[[UIApplication sharedApplication] beginBackgroundTaskWithExpirationHandler:^{
}];
}
调用完这个代码以后,App即使被压入后台,应用会继续把没执行完的任务执行完,一般是3分钟,在后台中应用任务完成后会调用上面介绍的四个回调,应用被强制杀死会走下面这个回调,上面介绍过。
-(void)URLSession:(nonnull NSURLSession *)session
task:(nonnull NSURLSessionTask *)task
didCompleteWithError:(nullable NSError *)error {
//如果是在后台进程被杀死了,则保存一下resumeData,用于以后断点续传
if ([error.userInfo objectForKey:NSURLErrorBackgroundTaskCancelledReasonKey]) {
NSData *resumeData = [error.userInfo objectForKey:NSURLSessionDownloadTaskResumeData];
}
}
三、断点续传
断点续传需要在创建NSURLSessionDownloadTask的时候传入resumeData,这样任务它就知道了上次的文件已经下载到这了,那就接着下载吧,分两步
1、保存resumeData
那么一般在什么时刻保存resumeData呢
1)暂停下载
[downloadTask cancelByProducingResumeData:^(NSData * _Nullable resumeData) {
if (!isRemove) {
//将目前传递的文件数据resumeData存储到Document中
[self saveDownloadTmpFileWithResumeData:resumeData url:urlStr];
} else {
[self removeDownloadTmpFileWithUrl:urlStr];
}
}];
2)应用被强行杀死
//如果是在后台进程被杀死了,则保存一下resumeData
if ([error.userInfo objectForKey:NSURLErrorBackgroundTaskCancelledReasonKey]) {
//将目前传递的文件数据resumeData存储到Document中
[self saveDownloadTmpFileWithResumeData:[error.userInfo objectForKey:NSURLSessionDownloadTaskResumeData] url:task.taskDescription];
}
3)下载过程中出现任何错误时
代码同上。
2、在下次再下载这个文件时用resumeData创建NSURLSessionDownloadTask
NSURLSessionDownloadTask *downloadTask = nil;
//之前是否有过这个文件的下载任务
if ([self.resumeDataDic.allKeys containsObject:base64Url]) {
//到document中找找有没有之前下载过一些的resumeData文件
//有resumeData就恢复下载
downloadTask = [self.session downloadTaskWithResumeData:self.resumeDataDic[base64Url]];
} else {
//之前没下载过这个文件,就从头下载吧
downloadTask = [self.session downloadTaskWithURL:[NSURL URLWithString:urlStr]];
}
//设置任务描述标签为文件url
downloadTask.taskDescription = urlStr;
//存储downloadTask对象
self.downloadTaskDic[base64Url] = downloadTask;
//启动任务
[downloadTask resume];