NSURLSession下载文件
(一)NSURLSession
- 用于替代 NSURLConnection
- 支持后台运行的网络任务
- 暂停、停止、重启网络任务，不再需要 NSOperation 封装
- 请求可以使用同样的配置容器
- 直接使用系统方法可以实现文件上传和下载
- 通过代理方法可以获取文件上传和下载的进度
-
block和代理都对文件上传和下载起作用- 当文件上传时,
block和代理可以同时使用 - 当文件下载时,
block和代理不要同时使用
- 当文件上传时,
结构图
说明
- 为了方便程序员使用，苹果提供了一个全局
session. - 所有的
任务(Task)都是由session发起的. - 所有的任务默认是挂起的，需要
resume. -
session可以自定义,自定义的时候可以同时设置代理.
(二)Block监听文件下载
文件下载的点击事件
- (IBAction)downloadClick:(id)sender {
// 1.URL
NSURL *URL = [NSURL URLWithString:@"http://localhost/sogou.zip"];
// 2.发起和启动下载任务
[[[NSURLSession sharedSession] downloadTaskWithURL:URL completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
// 处理响应
if (error == nil) {
NSLog(@"%@",location);
// 保存到沙盒
[[NSFileManager defaultManager] copyItemAtPath:location.path toPath:@"/Users/zhangjie/Desktop/sogou.zip" error:NULL];
} else {
NSLog(@"%@",error);
}
}] resume];
}
小结 :
问题 : 无法检测到进度
解决 : 要检测进度就必须实现代理方法;需要自定义session,不能使用单例session
注意 : 下载任务的代理方法和回调不能同时实现,一旦同时实现,代理就无效
(三)代理监听文件下载
1.代码演示
(1)准备工作
@interface ViewController ()
@end
@implementation ViewController {
/// 全局的下载session
NSURLSession *_downloadSession;
}
(2)自定义session并设置代理
- (void)viewDidLoad {
[super viewDidLoad];
// session的配置信息
NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
// 自定义session并设置代理
_downloadSession = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:[[NSOperationQueue alloc] init]];
}
(3)自定义session的参数
参数1 : session的配置信息,一般使用默认的即可
参数2 : 设置代理对象为当前控制器
参数3 : 代理方法执行的线程.
(4)文件下载的主方法
- (IBAction)downloadFile:(id)sender
{
// 1.URL
NSURL *URL = [NSURL URLWithString:@"http://localhost/sogou.zip"];
// 2.自定义session,实现代理方法
// 3.发起下载任务
// 注意 : 文件下载时的session的代理方法和回调不能并存,一起使用的话代理就失效
NSURLSessionDownloadTask *downloadTask = [_downloadSession downloadTaskWithURL:URL];
// 4.启动任务
[downloadTask resume];
}
-
downloadSession发起的下载任务指定为NSURLSessionDownloadTask
注意 : session实现文件下载时,代理和回调不能同时实现,如果同时实现,代理方法就不会执行.
2.NSURLSessionDownloadDelegate-监听文件下载的过程
文件下载时遵守的代理协议是
NSURLSessionDownloadDelegate
- ** 监听文件下载的进度**
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
// bytesWritten : 本次下载的文件大小
// totalBytesWritten : 一共下载的文件大小
// totalBytesExpectedToWrite : 文件的总大小
// 计算进度
float progress = (float)totalBytesWritten / totalBytesExpectedToWrite;
NSLog(@"进度 %f",progress);
}
- ** 监听文件下载完成**
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(NSURL *)location
{
// location : 文件下载完成之后保存到的文件夹的路径
NSLog(@"location %@",location);
}
注意 : 文件下载完成之后,会自动删除.所以当文件下载完成之后需要立即手动的拷贝到其他沙盒文件中.
3.文件下载完成之后将文件立即拷贝到其他沙盒文件中 : 必须实现的代理方法
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location
{
// location : session在文件下载完成之后,默认给的文件保存的地址,是以本地URL返回的
// 文件下载时,是默认保存在tmp文件夹里面的,会被自动删除,下载完成之后,需要我们拷贝到其他目标文件夹
// location.path : n拿到本地文件URL中的路径
NSLog(@"文件下载完成 %@",location.path);
// 文件下载完成之后把文件拷贝到桌面或者沙盒Caches文件
[[NSFileManager defaultManager] copyItemAtPath:location.path toPath:@"/Users/zhangjie/Desktop/sogou.zip" error:NULL];
}
(四)断点续传
1.准备工作
@interface ViewController ()
@end
@implementation ViewController {
/// 全局的下载session
NSURLSession *_downloadSession;
/// 下载任务
NSURLSessionDownloadTask *_downloadTask;
/// 保存续传数据
NSData *_resumeData;
}
- (void)viewDidLoad {
[super viewDidLoad];
// 自定义session,设置代理
NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
_downloadSession = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:nil];
}
2.开始下载
- (IBAction)downloadFile:(id)sender
{
// 1. URL
NSURL *URL = [NSURL URLWithString:@"http://localhost/sogou.zip"];
// 2. 自定义session发起任务
_downloadTask = [_downloadSession downloadTaskWithURL:URL];
// 3. 启动任务
[_downloadTask resume];
}
3.暂停下载
- (IBAction)pause:(id)sender
{
// 调用取消方法后,下载任务就真的取消了;继续下载时,需要重新发起下载任务
[_downloadTask cancelByProducingResumeData:^(NSData * _Nullable resumeData) {
NSLog(@"暂停下载");
// NSLog(@"续传数据 %@",resumeData);
// 保存续传数据
_resumeData = resumeData;
// 注意点1 : 续传数据保存完之后,立即把`_downloadTask`置为nil;防止连续点击暂停resumeData为空的问题!!!
_downloadTask = nil;
}];
}
4.继续下载
- (IBAction)resume:(id)sender
{
// 注意点2 : 当续传数据为空时,不能创建续传的下载任务,会崩溃!!!
if (_resumeData != nil) {
NSLog(@"继续下载");
_downloadTask = [_downloadSession downloadTaskWithResumeData:_resumeData];
[_downloadTask resume];
// 注意点3 : 续传数据用完了之后,需要立即清空;防止连续的点击继续下载
_resumeData = nil;
}
}
5.小结
问题 : 下载一半,退出程序,在启动时就无法续传了
解决 : 把续传数据保存到沙盒 (此处使用桌面测试)
(五)沙盒保存续传数据
1.准备工作 : 懒加载NSURLSession
@interface ViewController ()
/// 全局的session
@property (nonatomic,strong) NSURLSession *downloadSession;
@end
@implementation ViewController {
/// 全局的session : 当程序再次启动,直接使用session时,session是空的.为了解决这个问题,session可以做成懒加载
// NSURLSession *_downloadSession;
/// 下载任务
NSURLSessionDownloadTask *_downloadTask;
/// 保存续传数据
NSData *_resumeData;
}
- 当程序再次启动,直接使用session时,session是空的.为了解决这个问题,session可以做成懒加载
- (NSURLSession *)downloadSession
{
if (_downloadSession == nil) {
// 自定义session,设置代理
NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
_downloadSession = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:nil];
}
return _downloadSession;
}
2.开始下载
- (IBAction)downloadFile:(id)sender
{
// 1. URL
NSURL *URL = [NSURL URLWithString:@"http://localhost/sogou.zip"];
// 2. 发起任务
_downloadTask = [self.downloadSession downloadTaskWithURL:URL];
// 3. 启动任务
[_downloadTask resume];
}
3.暂停下载
- (IBAction)pause:(id)sender
{
// 调用取消方法后,下载任务就真的取消了;继续下载时,需要重新发起下载任务
[_downloadTask cancelByProducingResumeData:^(NSData * _Nullable resumeData) {
NSLog(@"暂停下载");
// NSLog(@"续传数据 %@",resumeData);
// 保存续传数据
// _resumeData = resumeData;
// 把续传数据保存到沙盒 : 用的时候就从沙盒取
[resumeData writeToFile:@"/Users/zhangjie/Desktop/resumeData.plist" atomically:YES];
// 注意点1 : 续传数据保存完之后,立即把`_downloadTask`置为nil;防止连续点击暂停resumeData为空的问题!!!
_downloadTask = nil;
}];
}
4.继续下载
- (IBAction)resume:(id)sender
{
// 从沙盒取续传数据
NSData *resumeData = [NSData dataWithContentsOfFile:@"/Users/zhangjie/Desktop/resumeData.plist"];
// 注意点2 : 当续传数据为空时,不能创建续传的下载任务,会崩溃!!!
if (resumeData != nil) {
NSLog(@"继续下载");
_downloadTask = [self.downloadSession downloadTaskWithResumeData:resumeData];
[_downloadTask resume];
// 注意点3 : 续传数据用完了之后,需要立即清空;防止连续的点击继续下载
// _resumeData = nil;
// 续传数据用完之后,立即删除
[[NSFileManager defaultManager] removeItemAtPath:@"/Users/zhangjie/Desktop/resumeData.plist" error:NULL];
}
}
(六)NSURLSession代理的强引用
1.定义全局的session属性
@interface ViewController ()
/// 自定义session实现文件下载
@property (nonatomic,strong) NSURLSession *downloadSession;
@end
2.懒加载中自定义文件下载的session,并设置代理
- (NSURLSession *)downloadSession
{
if (_downloadSession == nil) {
// 设置session的配置信息
NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
// 解除循环引用 : 无效的方式
// __weak typeof(self) weakSelf = self;
// 自定义session并设置代理,实现文件下载
_downloadSession = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:[[NSOperationQueue alloc] init]];
}
return _downloadSession;
}
3.问题分析
4.循环引用测试
- 添加导航控制器,实现
dealloc方法,测试控制器是否能够销毁
- (void)dealloc
{
NSLog(@"%s",__FUNCTION__);
}
测试结果 : 当有下载任务时,控制器无法销毁.
5.解决办法
- 文档说明
- 解除循环引用的问题
- (void)viewWillDisappear:(BOOL)animated
{
[super viewWillDisappear:animated];
// 在控制器即将销毁时,将sessio立即置为无效
[self.downloadSession invalidateAndCancel];
// 在控制器即将销毁时,当下载任务执行结束之后再把session置为无效
// [self.downloadSession finishTasksAndInvalidate];
}
6.NSURLSession注意事项
一旦指定了 session 的代理，session会对代理进行强引用，如果不主动取消 session，会造成内存泄漏！
7.解决方案
- 解决方法1：在任务完成后取消
session - 缺点：
session一旦被取消就无法再次使用. - 解决方法2：在视图将要消失的时候取消
session - 优点：只需要一个全局的
session统一管理.