利用NSURLSession实现一个单例管理多文件断点续传

在最近的开发过程中,涉及到了一些大文件下载的断点续传问题,这里做一个归纳和总结。首先谈谈从网络上下载数据有哪里方法:

1.直接用NSData访问,即

[NSData dataWithContentsOfURL:URL];

这个方法的缺点很明显,一个是会阻塞当前线程,第二个只要下载失败数据就不会得到保存,很显然不适合断点续传的大文件下载。
2.用NSRULSession(NSURLConnection也是使用代理方法,用法和NSURLSession差不多,而且已经被废弃,因此这里不再赘述)的NSURLSessionDownloadTask,即实现NSURLSessionDownloadDelegate中的以下方法

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
    
}

但是这个方法也有缺点:第一 文件下载的位置是放在temp文件夹里,只要不及时处理就会被系统删除 第二 同时下载多个文件时会出现错乱,及时自己手动把下载好的文件从temp移动到cache中也会出现文件名重复等各种问题
3.使用AFNetworking试了一下,它也是基于task的一层封装,具体task还是需要自己手动来操作,也不能实现断点续传和网络请求统一管理,即以下方法

  [manager downloadTaskWithRequest:request progress:^(NSProgress * _Nonnull downloadProgress) {
        
    } destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) {
        
    } completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nullable filePath, NSError * _Nullable error) {
        
    }];
    [manager downloadTaskWithResumeData:resumeData progress:^(NSProgress * _Nonnull downloadProgress) {
        
    } destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) {
        
    } completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nullable filePath, NSError * _Nullable error) {
        
    }];

从这个方法可以看出,AFN还是基于NSURLSessionDownloadTask的封装,并没有想象中的好用。

这里我做了一个改进,即用NSURLSessionDataTask直接发送get请求来实现断点续传的下载,而且支持多文件,且看下文分解
  • 既然使用NSURLSession来发送网络请求,这里就在一个工具类中懒加载一个session
- (NSURLSession *)session
{
    if (!_session) {
        _session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[[NSOperationQueue alloc]init]];
    }
    return _session;
}
  • 有了session还要有task,同样是懒加载,当然这里用的是NSURLDataTask
- (NSURLSessionDataTask *)dataTask
{
    if (!_dataTask) {
        NSError *error = nil;
        NSInteger alreadyDownloadLength = XHRAlreadyDownloadLength;
        //说明已经下载完毕
        if ([self.totalDataLengthDictionary[self.fileName]integerValue] && [self.totalDataLengthDictionary[self.fileName] integerValue] == XHRAlreadyDownloadLength)
        {
            !self.completeBlock?:self.completeBlock(XHRFilePath,nil);
            return nil;
        }
        //如果已经存在的文件比目标大说明下载文件错误执行删除文件重新下载
        else if ([self.totalDataLengthDictionary[self.fileName] integerValue] < XHRAlreadyDownloadLength)
        {
            [[NSFileManager defaultManager]removeItemAtPath:XHRFilePath error:&error];
            if (!error) {
                alreadyDownloadLength = 0;
            }
            else
            {
                NSLog(@"创建任务失败请重新开始");
                return nil;
            }
        }
        //这里是已经下载的小于总文件大小执行继续下载操做

            //创建mutableRequest对象
            NSMutableURLRequest *mutableRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:self.urlString]];
            
            //设置request的请求头
            //Range:bytes=xxx-xxx
            [mutableRequest setValue:[NSString stringWithFormat:@"bytes=%ld-",alreadyDownloadLength] forHTTPHeaderField:@"Range"];
            _dataTask = [self.session dataTaskWithRequest:mutableRequest];
        
    }
    return _dataTask;
}

关于task要说明几个判断的作用:第一、判断是否下载完成,如果下载完成直接调用下载完成的block; 第二、判断本地存储的文件是否大于目标文件,如果大于就说明文件有错误就得删除旧文件重新下载; 第三、就是还未下载完成继续下载
关键的几个参数:第一、文件的总长度是第一次接受到服务器响应以后就通过url地址经过MD5加密以后形成的唯一的key存储在字典中并且写入到沙盒中;第二、通过NSFileManager以及文件名获取当前已经下载好的文件大小,代码如下:

[[[NSFileManager defaultManager]attributesOfItemAtPath:XHRFilePath error:nil][NSFileSize] integerValue];

  • 下面来看代理方法中的实现
    0.初始化的代码模仿系统,传入下载进度的block和完成是的block,以待适当时候调用
/**下载方法*/
- (void)downloadFromURL:(NSString *)urlString progress:(void(^)(CGFloat downloadProgress))downloadProgressBlock complement:(void(^)(NSString *filePath,NSError *error))completeBlock;

1.当接收到服务器响应以后:

//服务器响应以后调用的代理方法
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSHTTPURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler
{
    //接受到服务器响应
    //获取文件的全部长度
    self.totalDataLengthDictionary[self.fileName] = @([response.allHeaderFields[@"Content-Length"] integerValue] + XHRAlreadyDownloadLength);
    [self.totalDataLengthDictionary writeToFile:XHRTotalDataLengthDictionaryPath atomically:YES];
    //打开outputStream
    [self.stream open];
    
    //调用block设置允许进一步访问
    completionHandler(NSURLSessionResponseAllow);
    
}

2.接收到数据以后,一点一点写入沙盒

//接收到数据后调用的代理方法
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
{
    //把服务器传回的数据用stream写入沙盒中
    [self.stream write:data.bytes maxLength:data.length];
    self.downloadProgress = 1.0 * XHRAlreadyDownloadLength / [self.totalDataLengthDictionary[self.fileName] integerValue];
}

3.下载完成后

//任务完成后调用的代理方法
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
    if (error) {
        self.downloadError = error;
        return;
    }
    //关闭流
    [self.stream close];
    //清空task
    [self.session invalidateAndCancel];
    self.dataTask = nil;
    self.session = nil;
    //清空总长度的字典
    [self.totalDataLengthDictionary removeObjectForKey:self.fileName];
    [self.totalDataLengthDictionary writeToFile:XHRTotalDataLengthDictionaryPath atomically:YES];
    !self.completeBlock?:self.completeBlock(XHRFilePath,nil);
    
}

4.重写下载进度和错误的setter方法,以监听它们的值,一旦有值直接回调对应的block

- (void)setDownloadProgress:(CGFloat)downloadProgress
{
    _downloadProgress = downloadProgress;
    !self.downloadProgressBlock?:self.downloadProgressBlock(downloadProgress);
}
- (void)setDownloadError:(NSError *)downloadError
{
    _downloadError = downloadError;
    !self.completeBlock?:self.completeBlock(nil,downloadError);
}
实现多文件同时下载的方法

创建一个downloadManager单例类,定义一个可变字典用来存放对应URL的Session,如果没有就创建一个sessionManager对象来执行下载任务,下载完成后从字典中移除对应的任务,检测下载到什么程度是在sessionManager完成的downloadManager不需要管。另外还提供了暂停、继续、取消(可以操作单个,也可以操作全部)等方法。
demo以及源码地址:https://github.com/xuhongru/XHRDownloadManager
作者:胥鸿儒

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容