Kingfisher Notes

这篇文章已经对Kingfisher的源码分析的非常好了:
Kingfisher源码阅读

以下仅是自己一些学习笔记:

associate object

由于extension中不能定义存储型变量,这里需要使用的是associate object去在底层替代一个存储型变量的作用。在UIImageView的extension中分别对需要读取的url地址,读取过程中是否使用indicator的设置属性,indicator控件通过这样的方式进行了实现。
设置存储的时候,以存储url为例,除去要指明关联的源对象(self),所关联的对象(设置时为url地址,删除时为nil)之外,还有一个关联的key为一个void指针和关联策略,指针的用法在KF中是:

    private var lastURLKey : Void?

而在另一篇nshipster的介绍中则是专门为这些key封装了一个结构体,同时在内部用静态变量作为key:

 extension UIViewController {
  private struct AssociatedKeys {
    static var DescriptiveName = "nsh_DescriptiveName"
  }

  var descriptiveName: String? {
    get {
        return objc_getAssociatedObject(self, &AssociatedKeys.DescriptiveName) as? String
    }
    set {
        if let newValue = newValue {
            objc_setAssociatedObject(
                self,
                &AssociatedKeys.DescriptiveName,
                newValue as NSString?,
                UInt(OBJC_ASSOCIATION_RETAIN_NONATOMIC)
            )
        }
    }
}
}

而关联策略也需要在枚举中选择,这里的选项OBJC_ASSOCIATION_RETAION_NONATOMIC应该也是比较常见的情况。

cancel

kf_setImageWithResource...系列的API统一返回了一个RetrieveImageTask的对象,来封装获取图像的过程(无论是从网络还是从本地存储),这里主要提供的功能就是为了做cancel的操作。

/// RetrieveImageTask represents a task of image retrieving process. It contains an async task of getting image from disk and from network.

 public class RetrieveImageTask {

// If task is canceled before the download task started (which means the `downloadTask` is nil),
// the download task should not begin.
var cancelled: Bool = false

var diskRetrieveTask: RetrieveImageDiskTask?
var downloadTask: RetrieveImageDownloadTask?

/**
Cancel current task. If this task does not begin or already done, do nothing.
*/
public func cancel() {
    // From Xcode 7 beta 6, the `dispatch_block_cancel` will crash at runtime.
    // It fixed in Xcode 7.1.
    // See https://github.com/onevcat/Kingfisher/issues/99 for more.
    if let diskRetrieveTask = diskRetrieveTask {
        dispatch_block_cancel(diskRetrieveTask)
    }
    
    if let downloadTask = downloadTask {
        downloadTask.cancel()
    }
    
    cancelled = true
}

}

这里RetrieveImageDiskTask代表了一个去存储中获取数据的操作,其定义是一个dispatch_block_t,在实现中通过dispatch_block_create创建,并且立刻通过dispatch_async进入异步队列,但是这里返回引用可以支持做cancel操作。
另外一个RetrieveImageDownloadTask代表的则是网络请求的Task,它是NSURLSessionDataTask的别名

在Kingfisher的demo中并没有用到cancel功能,但是一个健全强大的异步加载图像的库还是必须支持这样的功能,尤其是当图像以grid的方式在界面上展示的时候,如果用户快速滑动,代码实现就必须能够做一些预加载和取消无效任务的优化来保证性能。

singleton

swift的单例现在只要写成这样就可以了,比起objc时代的dispatch_once还是方便不少

    private let instance = KingfisherManager()
    public class KingfisherManager{
      public class var shareManager : KingfisherManager{
        return instance
      }
    }

manager, cache, downloader

由于图像异步加载中存在各种需求可能,因此KF也是提供了多种配置选项,但是在代码实现中,单例的管理者Manager,存储管理的cache和下载管理的downloader逻辑非常清晰,各自负责的代码都进行了隔离,当然它们之间在流程上用了大量的block传递,这个还要多看几遍学习...

KingfisherOptionsInfo

这个类写的实在是太华丽了,第一次看到这段代码代码完全不明所以...

      if let optionsItem = optionsInfo.kf_firstMatchIgnoringAssociatedValue(.Options(.None)), case .Options(let optionsInOptionsInfo) = optionsItem {
        
        ..........
    }

其实这个设置的写法确实是很巧妙的,首先这里不同类型的配置项用带参数的枚举来定义:

public enum KingfisherOptionsInfoItem {
  case Options(KingfisherOptions)
  case TargetCache(ImageCache)
  case Downloader(ImageDownloader)
  case Transition(ImageTransition)
}

KingfisherOptions又是用Swift的OptionSetType定义的,这样就可以方便的使用union, intersect, exclusiveOr, contains, insert, remove等方法

整个配置是一个枚举的数组,这样的定义非常的清晰,而kf_firstMatchIgnoringAssociatedValue的方法则是一个CollectionType extension的泛型方法,进而用一个重载的操作符去判定是否为某种枚举的case

    infix operator <== {
        associativity none
        precedence 160
    }

    // This operator returns true if two `KingfisherOptionsInfoItem` enum is the same, without considering the associated values.
    func <== (lhs: KingfisherOptionsInfoItem, rhs: KingfisherOptionsInfoItem) -> Bool {
        switch (lhs, rhs) {
        case (.Options(_), .Options(_)): return true
        case (.TargetCache(_), .TargetCache(_)): return true
        case (.Downloader(_), .Downloader(_)): return true
        case (.Transition(_), .Transition(_)): return true
        default: return false
        }
    }

    extension CollectionType where         Generator.Element == KingfisherOptionsInfoItem {

        func kf_firstMatchIgnoringAssociatedValue(target: Generator.Element) -> Generator.Element? {
    
            let index = indexOf {
                item in
                return item <== target
            }
    
            return (index != nil) ? self[index!] : nil
        }
    }

结合源码分析读完整个代码后感受到了代码的优雅,写的真是太好了!

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

推荐阅读更多精彩内容