专栏首页陈满iOSiOS开发·由SDWebImage引发的知识点聚合与思考(最新呕心沥血之作)

iOS开发·由SDWebImage引发的知识点聚合与思考(最新呕心沥血之作)

前面的话

引言

学习iOS的各种知识点,例如runloop,只懂原理不行,要清楚明白它的应用场景才是真懂;学习SDWebImage的框架源码,只看SDWebImage的业务逻辑,也不是真懂。有效的学习是不断的问问题,挖掘并总结SDWebImage它这些场景涉及到的知识点,然后再模仿它,结合那些场景去写出这个知识点才是真懂。据我所观察SD涉及到的知识点就有:runloop的mode切换,runtime的关联对象,多线程NSOperation的开始与挂起,网络操作里面NSURLSession与NSURLConnection的区别,关于缓存的NSCache,NSFileManager操作,等等。

目录
  1. 网络知识篇 1.1 基于的方案:NSURLConnection与NSURLSession 1.2 断点续传(非可持久性,APP重启后不能再续传) 1.3 可持久性断点续传(持久性,APP重启后可再续传) 1.4 NSURLSession的两种形式:Block和代理 1.5 操作及改动NSURLSession下载的文件位置
  2. 多线程与NSOperation篇 2.1 基于NSURLConnection的SDWebImage 2.2 基于NSURLSession的SDWebImage
  3. Runloop的mode切换暂停 vs NSOperaiton的suspend挂起 3.1 基于NSURLConnection的SDWebImage 3.2 基于NSURLSession的SDWebImage
  4. 缓存与文件操作篇 4.1 获取内存缓存的关键 --imageFromMemoryCacheForKey 4.2 获取磁盘缓存的关键 -- diskImageForKey: 4.3 除了真正下载操作之前的缓存检查,磁盘缓存还有什么用?
  5. 后面的话
  6. 致谢
写这篇文章的起因

有人问我,在优化UITableView的时候,滑动屏幕时,SDWebImage会暂停下载吗?如果会,那是怎样实现的,如果不会,那自己又怎么实现?刚开始,我查阅了老版本的SDWebImage,发现NSURLConnection虽然会开几个新的子线程,但它的回调是工作在主线程,并指定创建时当前线程的工作mode为defaultMode,这时候,子线程如果真有runloop并且切换mode,的确是对该子线程有暂停效果的。但有人分不清这是不同的线程(我也曾经被误导),如是就有人说,基于NSURLConnection的SDWebImage因为工作在主线程并指定了其mode,所以屏幕滑动会导致主线程的runloop切换mode,因而导致defaultMode上的SDWebImage的操作会暂停。他们的依据是老版SDWebImage里的SDWebImageDownloaderOperation.m有这样一句话:

因为它通过CFRunLoopInMode(...)这样的方式指定了主线程runloop的mode,所以滑动屏幕会切换runloop的mode从而导致SDWebImage暂停”。这句话是有漏洞的,这是没分清楚这是两个不同线程。主线程的runloop切换与子线程(在SDWebImageDownloaderOperation.m中)的runloop何干?实验结果如下图所示:

所以,问题来了,SDWebImage的哪一部分才工作在主线程?其实只有最上层的回调(在UIImageView+WebCache.m中)工作在主线程:

如上所示,wself.image = image;才是工作在主线程,主线程runloop的mode切换影响的是UIImageView+WebCache.m中的这个才对,跟SDWebImageDownloaderOperation.m文件中的那部分CFRunloop控制无关。

但是,后来发现新版本的SDWebImage是基于NSURLSession的,这个NSURLSession与NSURLConnection的最大不同是,它不通过获取当前线程的runloop进行控制,而是通过NSOPeration新开一个子线程进行操作,而主线程runloop的切换也不会影响到子线程。

总之,不管下层的工作是不是在子线程,新旧版本中关于最后获取image数据并设置给ImageView的都是放在最上层回调,而这部分代码是在主线程执行,所以这个时候,是有这个滑动即暂停的效果的。后来,我跑到iOS开发群里面讨论了这个事,得到了一些朋友的启示和肯定。

可见,只要setImage部分在主线程,就有滑动即暂停的效果。但是,对于不在defualtMode怎么办?解决方案可以是这个:

self.imageView performSelector:@selector(setImage:) withObject:downloadedImage afterDelay:0 inModes:@[NSDefaultRunLoopMode]];

但是,对于不在主线程的setImage怎么办?那就把这个选择器送到主线程,解决方案可以是这个:

[self performSelectorOnMainThread:@selector(setImage:)
                       withObject:downloadedImage
                    waitUntilDone:YES
                            modes:@[NSDefaultRunLoopMode]];

这样就把setImage及其参数运行在主线程并制定mode了。

waitUntilDone参数解释:

  • 当为YES,先让主线程运行selector中的一些操作,之后再进行当前线程中的操作。
  • 当为NO,先进行当前线程中的操作,之后让主线程运行selector中的一些操作。

1. 网络知识篇

1.1 基于的方案:NSURLConnection与NSURLSession

  • 老版本的SDWebImage基于NSURLConnection,新版本的SDWebImage是基于NSURLSession的。
  • 基于NSURLConnection的SDWebImage通过runloop进行管理的,虽然SDWebImage的底层调用栈SDWebImageDownloaderOperation(继承自NSOperation)会新开一个线程,NSURLConnection也再创建了两个新的子线程,但是最终的网络请求的回调(即最终的setImage部分)工作在主线程
  • 基于NSURLSession的SDWebImage通过NSOperation进行管理的,虽然也会新开子线程,但最终的网络请求的回调也工作在主线程

1.2 断点续传(非可持久性,APP重启后不能再续传)

  • 先梳理下断点的步骤:首次下载-->取消下载-->保存已经下好的数据到内存-->暂停期-->继续下载-->...

NSURLSession

  • 取消下载的关键API
- (void)cancelByProducingResumeData:(void (^)(NSData *resumeData))completionHandler;。

该方法可以取消并保留下载好的数据。其中会回调一个参数 --- resumeData,它包含了此次下载文件的请求路径,以及断点之前已下载文件的位置信息。

  • 断点续传的关键API:
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData;,

可以利用上次停止前已下载好的resumeData,开启一个新的任务继续下载。因为涉及保存上次下载的resumeData,所以我们要将resumeData保存为全局变量,以便使用。例如:

self.downloadTask = [self.session downloadTaskWithResumeData:self.resumeData];​
  • 总结:在实现断点下载的按钮中添加以下步骤:
    1. 设置一个downloadTask、session以及resumeData的全局变量
    2. 如果开始下载,就创建一个新的downloadTask,并启动下载
    3. 如果暂停下载,调用取消下载的函数,并在block中保存本次的resumeData到全局resumeData中。
    4. 如果恢复下载,将上次保存的resumeData加入到任务中,并启动下载。

1.3 可持久性断点续传(持久性,APP重启后可再续传)

可持久性断点续传跟上面的最大区别是保存数据的位置,上面是把数据resumeData是作为属性保存的,它这个是内存区保存。

如果你想实现持久性断点续传怎么办?那就存到沙盒。

  • 这里梳理下断点的步骤:首次下载-->取消下载-->保存已经下好的数据到沙盒-->暂停期-->继续下载-->...

后面还有很多精彩内容,这里暂时不贴代码了,故而只提供思路。不过这种的实现是要比非可持久性断点续传多一些逻辑,还需要结合NSURLSession的代理来完成。

1.4 NSURLSession的两种形式:Block和代理

(1) Block

// 创建下载路径
NSURL *url = [NSURL URLWithString:@"http://bmob-cdn-8782.b0.upaiyun.com/2017/01/17/c6b6bb1640e9ae9e80b221c454c4e90d.jpg"];
// 创建NSURLRequest请求
NSURLRequest *request = [NSURLRequest requestWithURL:url];
// 创建NSURLSession对象
NSURLSession *session = [NSURLSession sharedSession];
// 创建下载任务,其中location为下载的临时文件路径
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
    // 文件将要移动到的指定目录
    NSString *documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
    // 新文件路径
    NSString *newFilePath = [documentsPath stringByAppendingPathComponent:response.suggestedFilename]; 
    // 移动文件到新路径
    [[NSFileManager defaultManager] moveItemAtPath:location.path toPath:newFilePath error:nil];
}];
// 开始下载任务
[downloadTask resume];

(2) 代理

  • 创建时指定代理,这里的delegate不可通过setter方法指定
// 创建下载路径
NSURL *url = [NSURL URLWithString:@"http://dldir1.qq.com/qqfile/QQforMac/QQ_V5.4.0.dmg"];
// 创建NSURLSession对象,并设计代理方法。其中NSURLSessionConfiguration为默认配置
NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];   
// 创建任务
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url];
// 开始任务
[downloadTask resume];
  • 代理方可以实现的代理方法,需要获取进度或者已下好的数据的时候用,例如断点续传
#pragma mark <NSURLSessionDownloadDelegate> 实现方法
/**
 *  文件下载完毕时调用
 */
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
didFinishDownloadingToURL:(NSURL *)location
{
    // 文件将要移动到的指定目录
    NSString *documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
    // 新文件路径
    NSString *newFilePath = [documentsPath stringByAppendingPathComponent:@"QQ_V5.4.0.dmg"];
    
    NSLog(@"File downloaded to: %@",newFilePath);
    // 移动文件到新路径
    [[NSFileManager defaultManager] moveItemAtPath:location.path toPath:newFilePath error:nil];
}
/**
 *  每次写入数据到临时文件时,就会调用一次这个方法。可在这里获得下载进度
 *
 *  @param bytesWritten              这次写入的文件大小
 *  @param totalBytesWritten         已经写入沙盒的文件大小
 *  @param totalBytesExpectedToWrite 文件总大小
 */
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
      didWriteData:(int64_t)bytesWritten
 totalBytesWritten:(int64_t)totalBytesWritten
totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
    
    // 下载进度
    self.progressView.progress = 1.0 * totalBytesWritten / totalBytesExpectedToWrite;
    self.progressLabel.text = [NSString stringWithFormat:@"当前下载进度:%.2f%%",100.0 * totalBytesWritten / totalBytesExpectedToWrite];
}

/**
 *  恢复下载后调用
 */
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
 didResumeAtOffset:(int64_t)fileOffset
expectedTotalBytes:(int64_t)expectedTotalBytes1
{
    
}

1.5 NSURLSession下载的文件位置改动操作

可以利用downloadTaskWithURL的回调location.path获取文件目录再拷贝或者剪切到你要的目录中去。

关键API:

  • 拷贝
[[NSFileManager defaultManager] copyItemAtPath:location.path toPath:path error:NULL];
  • 剪切
// 移动文件到新路径
[[NSFileManager defaultManager] moveItemAtPath:location.path toPath:newFilePath error:nil];

例如:

//全局会话 创建 downLoadTask任务;
//参数location: 下载完成后文件路径 (需要我们重新指定)
[[[NSURLSession sharedSession] downloadTaskWithURL:url completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
    //重新指定路径
    NSString *path = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject];
    path = [path stringByAppendingPathComponent: fileName];
    //复制文件过去
    [[NSFileManager defaultManager] copyItemAtPath:location.path toPath:path error:NULL];
}] resume]; //启动任务

2. 多线程与NSOperation篇

2.1 基于NSURLConnection的SDWebImage

  • sd_setImageWithURL方法怎么引发的网络操作?这里列一下调用栈:

UIImageView+WebCache.m

- (void)sd_setImageWithURL:(NSURL *)url{

它里面调用的就是下面这个,

- (void)sd_setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletionBlock)completedBlock{

它里面有这样一句话,

// balabala
id <SDWebImageOperation> operation = [SDWebImageManager.sharedManager downloadImageWithURL:url options:options progress:progressBlock completed:
// balabala

这句话返回了一个SDWebImageOperation,目的是将该operation通过sd_setImageLoadOperation:方法缓存到UIView的字典类型的操作缓存属性中。

[self sd_setImageLoadOperation:operation forKey:@"UIImageViewImageLoad"];

可是,系统原生的UIView类哪里来的这种字典属性?是通过UIView+WebCacheOperation分类为UIView(这里其实是UIImageView)关联的对象。这就涉及到runloop的关联对象的知识。这里仅仅截图一下它的sd_setImageLoadOperation:实现,不讲原理:

sd_setImageLoadOperation:的实现

接下来,就交给SDWebImageManager了。

SDWebImageManager.m

- (id <SDWebImageOperation>)downloadImageWithURL:(NSURL *)url
                                         options:(SDWebImageOptions)options
                                        progress:(SDWebImageDownloaderProgressBlock)progressBlock
                                       completed:(SDWebImageCompletionWithFinishedBlock)completedBlock {

这个方法体的代码有点长,但主要的就是三个任务,一是查询内存缓存,二是前者若没有则查询磁盘缓存,三是前者若没有则真正开始下载。如下图所示,查询缓存的两种方法其实都写在这个方法里面了:

queryDiskCacheForKey

关键调用栈(下面这两个调用栈都在SDImageCache.m中)是:

  • UIImage *image = [self imageFromMemoryCacheForKey:key];
  • UIImage *diskImage = [self diskImageForKey:key];

查询完缓存都没有,怎么办,就真正开始下载呗。SDWebImageManager.m文件中写了这一句:

id <SDWebImageOperation> subOperation = [self.imageDownloader downloadImageWithURL:url options:downloaderOptions progress:progressBlock completed:^(UIImage *downloadedImage, NSData *data, NSError *error, BOOL finished) {

这个方法返回的是SDWebImageOperation类型的subOperation,目的是为了在取消的回调中及时取消本操作。

所以,这个下载工作交给了SDWebImageDownloader

SDWebImageDownloader

查看它的下载实现,不过它又在下载之前进行了一些预处理,如下所示

下载之前的操作

可见,真正真正的下载操作是这样一句:

operation = [[wself.operationClass alloc] initWithRequest:request
                                                          options:options
                                                         progress:^(NSInteger receivedSize, NSInteger expectedSize) {

它返回的是一个SDWebImageDownloaderOperation的operation,而SDWebImageDownloaderOperation的父类是NSOperation

所以,真正真正的下载是交给SDWebImageDownloaderOperation了。

SDWebImageDownloaderOperation.m

可见它的初始化方法实现为:

- (id)initWithRequest:(NSURLRequest *)request
              options:(SDWebImageDownloaderOptions)options
             progress:(SDWebImageDownloaderProgressBlock)progressBlock
            completed:(SDWebImageDownloaderCompletedBlock)completedBlock
            cancelled:(SDWebImageNoParamsBlock)cancelBlock {
    if ((self = [super init])) {
        _request = request;
        _shouldDecompressImages = YES;
        _shouldUseCredentialStorage = YES;
        _options = options;
        _progressBlock = [progressBlock copy];
        _completedBlock = [completedBlock copy];
        _cancelBlock = [cancelBlock copy];
        _executing = NO;
        _finished = NO;
        _expectedSize = 0;
        responseFromCached = YES; // Initially wrong until `connection:willCacheResponse:` is called or not called
    }
    return self;
}
  • 所以,这样初始化之后就开始下载了吗?大错特错哦~
  • 真正的开始在哪里,在它重写NSOperation类的start{}方法
  • 可是,你一搜start{},结果发现整个SDWebImage框架中没有显示调用start{}的地方,所以这个start{}是什么时候调用的?
  • 其实,看看SDWebImageDownloaderOperation这个类本身,它是一个NSOperation的子类,start{}方法是重写NSOperation的,所以,你回想下NSOperationstart{}方法在哪些情况会调用?没错,就是被addOperation:到一个NSOperationQueue的时候。SDWebImageDownloaderOperation里面的addOperation:如下所示。

2.2 基于NSURLSession的SDWebImage

  • 不同点1:新的下载操作之前取消当前的操作

新版本的SDWebImage与老版本的一个不同在于UIView+WebCache.m的这一句话:

它的目的是什么?是为了解决TableView的cell的重用问题:还没来得及下载完的图片在它的父cell移除屏幕后,再次被其它行重用时,这时图片又下载完成,结果显示在不应该显示的行。

这个cancel非常关键,当在TableView的cell包含了的UIImageView被重用时,首先调用这一行代码,保证这个ImageView的下载和缓存组合操作都被取消。如果:

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【iOS开发】Cocoapods详解-使用及创建私有库

    CocoaPods现在是通过target来组织的,如果项目有多个target,可以写多个target为每个target引入不同的第三方库。 写法:

    吴老师
  • 【iOS开发】一些不错的文章博客整理

    吴老师
  • 【iOS开发】UITableView和UICollectionView多种类型cell处理,更好地组织代码

    开发不仅仅是完成功能,还要写出认后来人可以很容易上手维护的代码。今天就记录一下列表数据,多种类型cell时,如何更好的组织代码。从实际需求场景出发,先看一下UI...

    吴老师
  • 【iOS开发】浅谈iOS列表分页数据管理

    @property (nonatomic, copy) NSMutableArray *list; @property (nonatomic) NSInteg...

    吴老师
  • 如何在Linux,Mac或Windows上安装Git

    Git是由Linus Torvalds为Linux内核设计开发的。Git为非线性的分布式开发提供了支持,允许多个项目成员同时在一个项目上进行开发。Git是最流行...

    Techeek
  • 【iOS开发】RxSwift入门:从Observable.create讲起

    刚学习RxSwift的时候,到github看文档,搜索别人的博客。基本上都是从那些例子讲起,像下面这样,自己再跟着用playground写一篇。

    吴老师
  • 【iOS开发】UITableView优化

    移动开发中,任何一个应用都或多或少的有列表的存在,列表的上下滑动直接关系到用户体验。如果处理不好,就会使得列表滑动起来有明显的卡顿效果。所以对列表的优化,让它更...

    吴老师
  • 【iOS开发】RxSwift中的Subject(PublishSubject/BehaviorSubject/ReplaySubject/Variable)

    PublishSubject 即是一个被观察者(Observable)也是一个观察者 (Observer)

    吴老师
  • 【iOS开发】iOS 动画详解

    在移动开发中,为了提高用户体验,会用到一些动画来提高应用的视觉效果。让人有眼前一亮的感觉。同时有动画的过渡过程,会让应用看起来不是那么的生硬,更吸引用户。

    吴老师
  • 【iOS开发】启动时间优化,runloop的一个小技术点

    刚接触项目不久,最近产品说有一个点要优化,App的启动页面显示时间太长了。一直在开发其它的app,还真没注意这个点,去看了一下还真是,有的时候启动页面的显示时间...

    吴老师

扫码关注云+社区

领取腾讯云代金券