源码解析--YYWebImage

封面.png

前言:YYWebImage是YYKit系列中图片请求的框架。作者号称是可以替代SDWebImage框架。至于优秀的SDWebImage的框架在iOS中的地位想必你一定是知道的。再开始学习之前先奉上YYWebImage框架的地址。当然你也可以先看看YYWebImage缓存框架的解析

本文准备从YYWebImageDemo中一个网络请求开始,为了更好的解析这个请求的过程。我们先将Demo中YYWebImageExample类请求url数组设置为单个

 NSArray *links = @[
         @"https://s-media-cache-ak0.pinimg.com/1200x/2e/0c/c5/2e0cc5d86e7b7cd42af225c29f21c37f.jpg"];

下面是这次请求的方法:

 [_webImageView yy_setImageWithURL:url
                          placeholder:nil
                          options:YYWebImageOptionProgressiveBlur | YYWebImageOptionShowNetworkActivity | YYWebImageOptionSetImageWithFadeAnimation
                          progress:^(NSInteger receivedSize, NSInteger expectedSize) {
                              if (expectedSize > 0 && receivedSize > 0) {
                                  CGFloat progress = (CGFloat)receivedSize / expectedSize;
                                  progress = progress < 0 ? 0 : progress > 1 ? 1 : progress;
                                  if (_self.progressLayer.hidden) _self.progressLayer.hidden = NO;
                                  _self.progressLayer.strokeEnd = progress;
                              }
                          }
                          transform:nil
                          completion:^(UIImage *image, NSURL *url, YYWebImageFromType from, YYWebImageStage stage, NSError *error) {
                              if (stage == YYWebImageStageFinished) {
                                  _self.progressLayer.hidden = YES;
                                  [_self.indicator stopAnimating];
                                  _self.indicator.hidden = YES;
                                  if (!image) _self.label.hidden = NO;
                              }
                         }];

我们先针对上面的请求方法看看相关的参数,如果你使用过SDWebImage,那这些参数你理解起来应该会比较容易。你最应该注意的是options枚举,因为它在整个流程的地方十分重要(作者给的备注英语通俗易懂,就再不做画蛇添足的翻译了):

Paste_Image.png

本次网络请求主要分为下面三个方面:

1.数据请求阶段前根据option类型的操作。

这个阶段主要的操作就是根据option类型来决定是否直接从内存里面取图像。如果不从内存里面拿,是否需要先暂时显示placeholder。这都是option来决定的。我们现在要做的是跑通一个流程。Here we go!!!下面的代码请结合流程一起看。

- (void)yy_setImageWithURL:(NSURL *)imageURL
               placeholder:(UIImage *)placeholder
                   options:(YYWebImageOptions)options
                   manager:(YYWebImageManager *)manager
                  progress:(YYWebImageProgressBlock)progress
                 transform:(YYWebImageTransformBlock)transform
                completion:(YYWebImageCompletionBlock)completion {
    if ([imageURL isKindOfClass:[NSString class]]) imageURL = [NSURL URLWithString:(id)imageURL];
    
    manager = manager ? manager : [YYWebImageManager sharedManager];
    //runtime 取value
    _YYWebImageSetter *setter = objc_getAssociatedObject(self, &_YYWebImageSetterKey);
    if (!setter) {
        setter = [_YYWebImageSetter new];
        objc_setAssociatedObject(self, &_YYWebImageSetterKey, setter, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }
    int32_t sentinel = [setter cancelWithNewURL:imageURL];
    //回到主线程
    _yy_dispatch_sync_on_main_queue(^{
        //如果option有YYWebImageOptionSetImageWithFadeAnimation且没有YYWebImageOptionAvoidSetImage类型
        if ((options & YYWebImageOptionSetImageWithFadeAnimation) &&
            !(options & YYWebImageOptionAvoidSetImage)) {
            if (!self.highlighted) {
                //移除动画
                [self.layer removeAnimationForKey:_YYWebImageFadeAnimationKey];
            }
        }
        if (!imageURL) {//当imageURL为空
            //options没有YYWebImageOptionIgnorePlaceHolder类型则直接把placeholder赋给image
            if (!(options & YYWebImageOptionIgnorePlaceHolder)) {
                self.image = placeholder;
            }
            return;
        }
        
        // get the image from memory as quickly as possible
        UIImage *imageFromMemory = nil;
        //如果options 没有YYWebImageOptionUseNSURLCache,YYWebImageOptionRefreshImageCache类型
        if (manager.cache &&
            !(options & YYWebImageOptionUseNSURLCache) &&
            !(options & YYWebImageOptionRefreshImageCache)) {
            //根据key去YYCache里面取UIImage
            imageFromMemory = [manager.cache getImageForKey:[manager cacheKeyForURL:imageURL] withType:YYImageCacheTypeMemory];
        }
        
        if (imageFromMemory) {
            //如果options 没有YYWebImageOptionAvoidSetImage类型
            if (!(options & YYWebImageOptionAvoidSetImage)) {
                self.image = imageFromMemory;
            }
            if(completion) completion(imageFromMemory, imageURL, YYWebImageFromMemoryCacheFast, YYWebImageStageFinished, nil);
            return;
        }
       //如果options 没有YYWebImageOptionUseNSURLCache
        if (!(options & YYWebImageOptionIgnorePlaceHolder)) {
            self.image = placeholder;
        }
        
//============上面是文中数据请求阶段前根据option类型的操作====================================
        
//因为为了避免下载大尺寸文件或者图片内存爆掉,所以NSURLConnection会把文件或图片分成多段回调。下面就是拿到总expectedSize和每次接收到的receivedSize的block声明
        __weak typeof(self) _self = self;
        dispatch_async([_YYWebImageSetter setterQueue], ^{
            YYWebImageProgressBlock _progress = nil;
            if (progress) _progress = ^(NSInteger receivedSize, NSInteger expectedSize) {
                dispatch_async(dispatch_get_main_queue(), ^{
                    progress(receivedSize, expectedSize);
                });
            };

            __block int32_t newSentinel = 0;
            __block __weak typeof(setter) weakSetter = nil;
//====================================_completion==================================
// 完成的回调声明
            YYWebImageCompletionBlock _completion = ^(UIImage *image, NSURL *url, YYWebImageFromType from, YYWebImageStage stage, NSError *error) {
                __strong typeof(_self) self = _self;
                BOOL setImage = (stage == YYWebImageStageFinished || stage == YYWebImageStageProgress) && image && !(options & YYWebImageOptionAvoidSetImage);
                

                dispatch_async(dispatch_get_main_queue(), ^{
                    BOOL sentinelChanged = weakSetter && weakSetter.sentinel != newSentinel;
                    if (setImage && self && !sentinelChanged) {
                        BOOL showFade = ((options & YYWebImageOptionSetImageWithFadeAnimation) && !self.highlighted);
                        if (showFade) {
                            CATransition *transition = [CATransition animation];
                            transition.duration = stage == YYWebImageStageFinished ? _YYWebImageFadeTime : _YYWebImageProgressiveFadeTime;
                            transition.timingFunction = [CAMediaTimingFunction functionWithName:kCAMediaTimingFunctionEaseInEaseOut];
                            transition.type = kCATransitionFade;
                            [self.layer addAnimation:transition forKey:_YYWebImageFadeAnimationKey];
                        }
                        self.image = image;
                    }
                    if (completion) {
                        if (sentinelChanged) {
                            completion(nil, url, YYWebImageFromNone, YYWebImageStageCancelled, nil);
                        } else {
                            completion(image, url, from, stage, error);
                        }
                    }
                });
            };
//====================================_completion==================================

            //将相关参数和声明的block传过去
            newSentinel = [setter setOperationWithSentinel:sentinel url:imageURL options:options manager:manager progress:_progress transform:transform completion:_completion];
            weakSetter = setter;
        });
    });
}
1.png

2.加入队列数据请求阶段

这部分代码跳转太多,便不贴相关代码了。你运行代码应该能获取下图相关的流程。


2.png

3.NSURLConnection回调的处理

// 在构建connection会被响应。如果这个connection需要根据NSURLCredentialStorage中的权限进行构建,那么就返回YES
// 默认是YES,想要修改,需要用户自己指定self.shouldUseCredentialStorage值
- (BOOL)connectionShouldUseCredentialStorage:(NSURLConnection *)connection 
//客户端开始认证挑战(Authentication Challenge)
- (void)connection:(NSURLConnection *)connection willSendRequestForAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge
//返回相应头的信息。重要的有statusCode,expectedContentLength。回调给size,数据接收的开始阶段。
- (void)connection:(NSURLConnection *)connection didReceiveResponse:(NSURLResponse *)response
//文件或者图片分割成多份回调
- (void)connection:(NSURLConnection *)connection didReceiveData:(NSData *)data
//文件下载完毕后的回调
- (void)connectionDidFinishLoading:(NSURLConnection *)connection
//下载失败,失败回调
- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error 

流程跑完了,我们现在来看下类图:

类图.png

YYWebImage使用YYImageCache作缓存(YYCache上层),YYImage做解码相关工作。利用Category分类做提供接口。而_YYWebImageSetter是一个私有类,为categories提供接口,值得一提的是它使用OSAtomicIncrement32来原子操作级别地递增_sentinel。下面我们主要来看看YYWebImageManagerYYWebImageOperation

YYWebImageManager

YYWebImageManager是YYWebImage的管理类,主要提供了下面管理:
1.图片操作的枚举YYWebImageOptions
2.图片的来源的枚举YYWebImageFromType
3.请取图片状态的枚举YYWebImageStage
4.进度的回调block YYWebImageProgressBlock
5.对图片附加的操作block YYWebImageTransformBlock
6.请求图片完成的block YYWebImageCompletionBlock

YYWebImageOperation

YYWebImageOperationNSOperation的子类,是对一个请求任务的包装来从URL获取图片。它的属性executingfinishedcancelledstarted控制着任务的状态。通过把任务添加到队列,或者手动调用start方法执行。当一个任务开始:
1.从磁盘里面请求图片,如果存在。返回并completion block回调。
2.开始URL connection请求图片,如果设置了YYWebImageProgressBlock,则返回每一段的Progress
3.如果设置了YYWebImageTransformBlock,则依据block 处理图片
4.把图片存入磁盘。返回并completion block回调。

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

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,016评论 4 62
  • 前不久做了一个生成快照的需求,其中用到 SDWebImage 来下载图片,在使用该框架的过程中也遇到了一些问题,索...
    ShannonChenCHN阅读 14,046评论 12 241
  • 春晚,大家都看了吗?我看了,确切地说,大概的看了!现在想想,最后一次认真看春晚是何年?想不起来,也不想去想了!反正...
    Rock公主阅读 103评论 0 0
  • 为什么你总是对孩子发火?表面上看,是你处理情绪的能力差,因为被恶劣的情绪左右着,变得激愤偏执,暴跳如雷。而最根本的...
    无事闲逛的伊丽阅读 374评论 0 7
  • 清晨 湿润的空气飘散着泥土的气息 天真蓝 蓝透了我的双眼 太阳金黄 黄遍了我的周身 我来了 走向这刚刚睡醒的土地 ...
    魏加恩阅读 243评论 0 0