Kingfisher 源码分析(一):命名空间 kf 实现

namespacing kf 实现

引用文件:

  • Kingfisher.swift
  • ImageView+Kingfisher.swift
  • UIButton+Kingfisher.swift

实现:

//Kingfisher.swift
public final class Kingfisher<Base> {
    public let base: Base
    public init(_ base: Base) {
        self.base = base
    }
}

/**
 A type that has Kingfisher extensions.
 */
public protocol KingfisherCompatible {
    associatedtype CompatibleType
    var kf: CompatibleType { get }
}

public extension KingfisherCompatible {
    public var kf: Kingfisher<Self> {
        get { return Kingfisher(self) }
    }
}

extension Image: KingfisherCompatible { }
#if !os(watchOS)
extension ImageView: KingfisherCompatible { }
extension Button: KingfisherCompatible { }

//ImageView+Kingfisher.swift
extension Kingfisher where Base: ImageView {
@discardableResult
    public func setImage(with resource: Resource?,
                         placeholder: Image? = nil,
                         options: KingfisherOptionsInfo? = nil,
                         progressBlock: DownloadProgressBlock? = nil,
                         completionHandler: CompletionHandler? = nil) -> RetrieveImageTask
    {
        ...
    }
}

//UIButton+Kingfisher.swift
extension Kingfisher where Base: UIButton {
    @discardableResult
    public func setImage(with resource: Resource?,
                         for state: UIControlState,
                         placeholder: UIImage? = nil,
                         options: KingfisherOptionsInfo? = nil,
                         progressBlock: DownloadProgressBlock? = nil,
                         completionHandler: CompletionHandler? = nil) -> RetrieveImageTask
    {
        ...
    }
}

调用事例:

let imageView = UIImageView()
imageView.kf.setImage(...)

let button = UIButton()
button.kf.setImage(...)

分析

Kingfisher<Base> 是一个范型类,类型是 Base 。

public protocol KingfisherCompatible {
    associatedtype CompatibleType
    var kf: CompatibleType { get }
}
public extension KingfisherCompatible {
    public var kf: Kingfisher<Self> {
        get { return Kingfisher(self) }
    }
}

extension ImageView: KingfisherCompatible { }
extension Button: KingfisherCompatible { }

定义协议 KingfisherCompatible,声明属性 kf,类型是范型 CompatibleType 。并要求遵守协议的一方,实现该属性的 get 方法。

在协议扩展中,协议自身实现了属性。这样就不必在每个遵守该协议的类里实现该属性了。参见苹果文档

Protocols can be extended to provide method and property implementations to conforming types. This allows you to define behavior on protocols themselves, rather than in each type’s individual conformance or in a global function.

协议里的 kf 是一个 Kingfisher 类的实例,调用的方法是 Kingfisher 类的方法。根据类型的不同,调用不同类型里的方法。如:对应 UIImageView / UIButton 的 Kingfisher 里的setImage 方法。

综上,也就实现了命名空间 kf 。

如图:

命名空间 kf

我们详细说说 KingfisherCompatible 。

public var kf: Kingfisher<Self> : Self 用在协议里面,代表的是遵守协议的 对象(类/结构体/枚举) 类型。如:extension ImageView: KingfisherCompatible { },用在这里,Self 是 ImageView ; extension Button: KingfisherCompatible { },用在这里, Self 是 Button 。

如果我们不用 public extension KingfisherCompatible ,也可以在遵守协议的时候,单独实现 kf 属性。

如单独实现 UIImageView 的协议扩展,像这样:

extension UIImageView: KingfisherCompatible {
    public var kf: Kingfisher<UIImageView> { return Kingfisher(self) }
}

extension Kingfisher where Base: UIImageView  {
    public func setImage() { print("imageView setImage") }
}

最后,样例如下:

public final class Kingfisher<Base> {
    public let base: Base
    public init(_ base: Base){
        self.base = base
    }
}
public protocol KingfisherCompatible {
    associatedtype CompatibleType
    var kf: CompatibleType { get }
}
extension UIImageView: KingfisherCompatible {
    public var kf: Kingfisher<UIImageView> { return Kingfisher(self) }
}
extension Kingfisher where Base: UIImageView  {
    public func setImage() { print("imageView setImage") }
}
extension UIButton: KingfisherCompatible {
    public var kf: Kingfisher<UIButton> { return Kingfisher(self) }
}
extension Kingfisher where Base: UIButton {
    public func setImage() { print("button setImage") }
}

let imageView = UIImageView()
imageView.kf.setImage()
let button = UIButton()
button.kf.setImage()

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

推荐阅读更多精彩内容

  • 序言 Kingfisher是喵神的一个异步下载和缓存图片的Swift库,类似于OC 的SDWebImage中文简介...
    乔克_叔叔阅读 6,103评论 7 25
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,066评论 4 62
  • 晚风送来凉意细雨朦胧了橘黄色的灯光城市灯光慵懒的沉醉里笑容在每个人的脸上枯萎风声、雨声、鸣笛声不断被心灵的沉寂弹回...
    流水亦公子阅读 309评论 4 5
  • 旧友来探我在异乡清酌 如今烟不抽,没得借火 当年初学画 谈理想论美 囫囵宛若老虎吃猪 如今说 什么是美 好看的姑娘...
    鹿羊I阅读 186评论 0 2
  • 第四卷 革命时期的爱情 第一到三章 我爬炉筒时,大概是九岁到十一二岁。到了四十岁上,我发现后来我干任何事情都没有了...
    吴玉纯阅读 325评论 0 0