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版本提供了以下几个功能：
- 多线程异步下载，支持自定义并发线程数。在上图的示例图中，采用的并发数为3
- 边下载变保存，这一条是该下载器最重要的思想，数据被实时的保存在本地，同时支持断点下载
- 十分方便的数据获取能力，通过MCDownloadReceipt来对下载的数据进行抽象，几乎所有的信息都能在MCDownloadReceipt中获取
- 提供了下载进度，可以通过接口函数的block监听下载进度和完成回调，也可以通过给MCDownloadReceipt绑定block来监听block回调
- 支持显示当前的下载速度
- 支持批量下载，批量取消功能
- 支持任务的暂停，取消，删除功能
- 支持下载顺序定制，先入先出或者后入先出
- 支持后台和锁屏下载
如何使用？
开启下载
每一个下载任务的唯一标识是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是暴露出来最核心的模块，在设计上主要考虑下边几件事情：
- 需要一个单利对象来管理全局的情况
- 支持设置一些跟下载相关的额外信息，比如超时时间，请求头和并发数等等
- 提供一些控制下载的常用方法，如何开始，取消，移除等等
综上所述，这基本上是写任何一个框架的基本流程，在编码之前先进行设计。 另外，在使用的过程中，如果有任何问题，可以给我留言，如果有新的需求，也可以给我留言。
由于水平有限，难免会出现错误，如果发现后，还望能够告知一声。
