利用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
作者:胥鸿儒

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,165评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,503评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,295评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,589评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,439评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,342评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,749评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,397评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,700评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,740评论 2 313
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,523评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,364评论 3 314
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,755评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,024评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,297评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,721评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,918评论 2 336

推荐阅读更多精彩内容