MCDownloader(iOS下载器)说明书

示例

前言

很多iOS应用中都需要下载数据,并对这些下载的过程和结果进行管理,因此我才有了写这个MCDownloader的想法。在IOS 文件下载器-MCDownloadManager这篇文章中,我使用GCD和集合来实现了这个功能,基本上也能满足需求,这一部分的实现原理主要参考AFNetworking的源码,有兴趣的同学可以看看我写的AFNetworking 3.0 源码解读系列

但是本篇文章中讲的MCDownloader的实现原理和上边提到的不一样,是基于NSOperation来实现的,可以说是我对SDWebImage源码解读的一些额外的扩展,同样,有兴趣的同学可以看看我写的SDWebImage源码解读系列

MCDownloader目前的版本是1.0.0,可以在这里下载https://github.com/agelessman/MCDownloader

功能

MCDownloader1.0.0版本提供了以下几个功能:

  1. 多线程异步下载,支持自定义并发线程数。在上图的示例图中,采用的并发数为3
  2. 边下载变保存,这一条是该下载器最重要的思想,数据被实时的保存在本地,同时支持断点下载
  3. 十分方便的数据获取能力,通过MCDownloadReceipt来对下载的数据进行抽象,几乎所有的信息都能在MCDownloadReceipt中获取
  4. 提供了下载进度,可以通过接口函数的block监听下载进度和完成回调,也可以通过给MCDownloadReceipt绑定block来监听block回调
  5. 支持显示当前的下载速度
  6. 支持批量下载,批量取消功能
  7. 支持任务的暂停,取消,删除功能
  8. 支持下载顺序定制,先入先出或者后入先出
  9. 支持后台和锁屏下载

如何使用?

开启下载

每一个下载任务的唯一标识是url,因此我们使用下边的代码开始一个下载任务:

 [[MCDownloader sharedDownloader] downloadDataWithURL:[NSURL URLWithString:url] progress:^(NSInteger receivedSize, NSInteger expectedSize, NSInteger speed, NSURL * _Nullable targetURL) {
                
  } completed:^(MCDownloadReceipt * _Nullable receipt, NSError * _Nullable error, BOOL finished) {
      NSLog(@"==%@", error.description);
  }];

可以在上边的progress和completed中自定义处理方法。进度和完成的block回调都在主线程触发。

暂停或取消

MCDownloader的暂停和取消功能是一样的,由于内部下载是基于NSOperation实现的,因此每一个任务就是一个NSOperation,然后再把他们添加到队列之中。当取消或者暂停一个任务后,在重新恢复下载,实际上会重新把该任务添加到队列中,这一点一定要注意。

使用下边的代码来暂停或取消一个下载任务:

[[MCDownloader sharedDownloader] cancel:receipt completed:^{
            [self.button setTitle:@"Start" forState:UIControlStateNormal];
        }];

由于取消不是发生在主线程,所以需要一个completed来捕获取消成功事件,然后在主线程调用。

移除数据

通过下边的方法来移除保存在本地的数据:

 [[MCDownloader sharedDownloader] remove:receipt completed:^{
            [self.tableView reloadData];
        }];

获取数据信息

可以通过下边的代码来获取数据的一些信息,这些信息既可以在下载过程中获取,也可以在下载完成后获取。

MCDownloadReceipt *receipt = [[MCDownloader sharedDownloader] downloadReceiptForURLString:self.url];

通过上边的代码可以看出来,url被当做数据的唯一标识。在上图的例子中,我们是在cell中更新下载进度的,为了防止cell的复用问题,我为每个receipt绑定了progress和complete回调block:

 __weak typeof(receipt) weakReceipt = receipt;
    receipt.downloaderProgressBlock = ^(NSInteger receivedSize, NSInteger expectedSize, NSInteger speed, NSURL * _Nullable targetURL) {
        __strong typeof(weakReceipt) strongReceipt = weakReceipt;
        if ([targetURL.absoluteString isEqualToString:self.url]) {
            [self.button setTitle:@"Stop" forState:UIControlStateNormal];
            self.bytesLable.text = [NSString stringWithFormat:@"%0.1fm/%0.1fm", receivedSize/1024.0/1024,expectedSize/1024.0/1024];
            self.progressView.progress = (receivedSize/1024.0/1024) / (expectedSize/1024.0/1024);
            self.speedLable.text = [NSString stringWithFormat:@"%@/s", strongReceipt.speed ?: @"0"];
        }
        
    };
    
    receipt.downloaderCompletedBlock = ^(MCDownloadReceipt *receipt, NSError * _Nullable error, BOOL finished) {
        if (error) {
            [self.button setTitle:@"Start" forState:UIControlStateNormal];
            self.nameLabel.text = @"Download Failure";
        }else {
            [self.button setTitle:@"Play" forState:UIControlStateNormal];
            self.nameLabel.text = @"Download Finished";
        }
        
    };

取消全部下载和删除全部数据

在某种场景下需要取消全部的下载,比如说监听到网络状态变成4G时,需要询问用户是否继续下载。又或者在需要清空缓存的时候:

[[MCDownloader sharedDownloader] cancelAllDownloads];

[[MCDownloader sharedDownloader] removeAndClearAll];

上边说的这些功能,在demo中都有演示。

核心思想

由于下载功能不算是特别复杂的功能,所以我就简单的说说内部的实现原理。

在代码设计之初,我最先写的类就是MCDownloadReceipt。通过它来对数据进行抽象封装,我们先不管它是如何获取的,只关心它需要暴露多少信息。这个类很简单,我就不把代码弄上来了,但是需要注意下边几点:

  • 这些属性被设计成只读属性,表明只在该类中获取数据,不要修改其中的数据
  • receipt需要保存在本地,我采用的是归档的方法进行持久化
  • 文件名要做MD5处理
  • 每一个receipt都绑定了一个状态属性

完成了模型的搭建后,就要处理最基本的下载任务了,MCDownloadOperation继承自NSOperation,因此在MCDownloadOperation中我们就不需要关心线程的问题。我们在这个类中只做了下边这几件事:

  • 开启下载任务,在开启任务的start方法中,我做了一些保证任务开始的必要措施,有兴趣的可以去看看源码
  • 接受数据和写入数据
  • 处理下载过程中和完成后的回调函数
  • 处理下载状态
  • 关心如何取消任务

接下来就到了最核心的地方,如何把MCDownloadReceipt和MCDownloadOperation组合在一起,也就是MCDownloader的内容。MCDownloader是暴露出来最核心的模块,在设计上主要考虑下边几件事情:

  • 需要一个单利对象来管理全局的情况
  • 支持设置一些跟下载相关的额外信息,比如超时时间,请求头和并发数等等
  • 提供一些控制下载的常用方法,如何开始,取消,移除等等

综上所述,这基本上是写任何一个框架的基本流程,在编码之前先进行设计。 另外,在使用的过程中,如果有任何问题,可以给我留言,如果有新的需求,也可以给我留言。

由于水平有限,难免会出现错误,如果发现后,还望能够告知一声。

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

推荐阅读更多精彩内容

  • 多线程 在iOS开发中为提高程序的运行效率会将比较耗时的操作放在子线程中执行,iOS系统进程默认启动一个主线程,用...
    郭豪豪阅读 2,586评论 0 4
  • 什么是进程? 进程是指在系统中正在运行的一个应用程序。 每个进程之间是独立的,每个进程均运行在其专用且受保护的内存...
    珍此良辰阅读 1,243评论 1 5
  • 多线程 什么是多线程?多线程就是一个进程中可以开启多条线程,每条线程可以并行执行不同的任务,提高执行效率;一个基本...
    西风颂阅读 864评论 1 16
  • 前言 Pthread,NSThread,GCD和NSOperation是iOS中多线程的四种实现方案。 一.进程和...
    小李龍彪阅读 662评论 1 4
  • 文/桐阳妈 有妈妈问:桐阳妈,我家孩子自控力特别差,该怎么办呢?作业不着急写,上课不集中。早上不起床,反复催也不管...
    桐阳妈阅读 773评论 3 18