KingFisher源码分析 --- 下载

2019-03-11 本文已影响155人微笑_d797

Basic模块 --- KingFisher的基本使用只涉及到下载流程缓存策略在这里

DownloadTask

KingFisher的使用时通过setimage方法构造了一个DownloadTask。先来分析一下这个DownloadTask是个什么玩意
通过源码我们看到DownloadTask主要是由sessionTask cancelToken cancel组成的结构体主要重点是SessionDataTask类
里面的构成是 TaskCallback、mutableData(已下载的数据)、URLSessionDataTask、一个[CancelToken: TaskCallback]token对应一个任务、callbacks所有的任务一个集合、started(任务开始结束的标志位)、containsCallbacks(任务是否立即执行)、

/// Represents a session data task in `ImageDownloader`. It consists of an underlying `URLSessionDataTask` and
/// an array of `TaskCallback`. Multiple `TaskCallback`s could be added for a single downloading data task.
public class SessionDataTask {

    /// Represents the type of token which used for cancelling a task.
    public typealias CancelToken = Int

    struct TaskCallback {
        let onProgress: Delegate<(Int64, Int64), Void>?
        let onCompleted: Delegate<Result<ImageLoadingResult, KingfisherError>, Void>?
        let options: KingfisherParsedOptionsInfo
    }

    /// Downloaded raw data of current task.
    public private(set) var mutableData: Data

    /// The underlying download task. It is only for debugging purpose when you encountered an error. You should not
    /// modify the content of this task or start it yourself.
    public let task: URLSessionDataTask
    private var callbacksStore = [CancelToken: TaskCallback]()

    var callbacks: Dictionary<SessionDataTask.CancelToken, SessionDataTask.TaskCallback>.Values {
        return callbacksStore.values
    }

    private var currentToken = 0
    private let lock = NSLock()

    let onTaskDone = Delegate<(Result<(Data, URLResponse?), KingfisherError>, [TaskCallback]), Void>()
    let onCallbackCancelled = Delegate<(CancelToken, TaskCallback), Void>()

    var started = false
    var containsCallbacks: Bool {
      //我们应该可以使用'task.state！=。运行以检查它。
      //但是，在一些罕见的情况下，取消任务不会改变
      //任务状态为“立即取消”，但仍处于“正在运行”。
      //因此我们需要检查回调计数以确保删除
      //委托中的任务。
        return !callbacks.isEmpty
    }

    init(task: URLSessionDataTask) {
        self.task = task
        mutableData = Data()
    }

    func addCallback(_ callback: TaskCallback) -> CancelToken {
        lock.lock()
        defer { lock.unlock() }
        callbacksStore[currentToken] = callback
        defer { currentToken += 1 }
        return currentToken
    }

    func removeCallback(_ token: CancelToken) -> TaskCallback? {
        lock.lock()
        defer { lock.unlock() }
        if let callback = callbacksStore[token] {
            callbacksStore[token] = nil
            return callback
        }
        return nil
    }

    func resume() {
        guard !started else { return }
        started = true
        task.resume()
    }

    func cancel(token: CancelToken) {
        guard let callback = removeCallback(token) else {
            return
        }
        if callbacksStore.count == 0 {
            task.cancel()
        }
        onCallbackCancelled.call((token, callback))
    }

    func forceCancel() {
        for token in callbacksStore.keys {
            cancel(token: token)
        }
    }

    func didReceiveData(_ data: Data) {
        mutableData.append(data)
    }
}

demo方法分析

image.png

先不说源码我觉得这里他在cell不绘制的时候进行任务取消是节省cpu资源的做法，微信图片加载的实现也类似这种机制，当imageview容器不在的时候，就暂停该资源的加载

首先看UIimageView里的kf属性我们需要知道他是怎么实现的点进去发打开Kingfisher.Swift文件现他是一个协议而UIImageView、UIButton、UIImage实现了这个协议

image.png

而kf是一个结构体这个结构体注释是

Kingfisher兼容类型的包装。此类型为提供扩展点
Kingfisher的遍历构造方法。
我们可以看到他内部实现是一个泛型可以看到她自带get属性的实现就是当 UIImageView.kf时候其实是将UIImageVIew对象传了进去

加载默认动画实现

cellForRowItem的indicatorType是对KingfisherWrapper结构体的拓展

image.png

indicatorType：
表示应添加到的活动指示器类型
下载图像时的图像视图。
-None：无指示器。
-Activity：使用系统活动指示器。
-image：使用图像作为指示器。支持GIF。
-custom(indicator: Indicator)：使用自定义指示器。关联值的类型应符合“indicator”协议。
indicator: 可用于显示下载任务正在进行的指示器类型。实现下面几个代理即可构造一组完整的指示器类型

图片加载流程

创建任务

这里是重点代码注释翻译是我直接从百度翻译上趴的没有做其他处理

image.png

Resource: 表示某个URL上的图像资源和给定的缓存键。kingfisher将使用“resource”从网络下载资源，并在
使用“source.network”作为图像设置源。他是一个接口里面有一个cachekey和downloadUrl，实现该类的接口如果没有设置cachekey那么取downloadUrl的absoluteString，KingFisher为我们定义了一个实现该接口的结构体ImageResource，还有对URL的也实现了这个接口。因此我们可以直接将URL对象差传进来。

Resource

Placeholder：一个接口，可以用做加载图像过程中的占位图，UIimage默认实现这个接口将自己当对象实现PlaceHolder的接口，在图片加载完成后PlaceHolder将其从视图中移除

image.png

options: 一个枚举数组，枚举里包含targetCache(ImageCache)、case originalCache(ImageCache)、case downloader(ImageDownloader)、case transition(ImageTransition)、case downloadPriority(Float)、case forceRefresh。等可选枚举，设置后将在完成后进入如下参数的设置默认为空，这个枚举有注释可以清晰易懂，可以根据自己的需求设置不同的type。

DownloadProgressBlock 下载进度回调主线程执行

completionHandler 完成回调主线程执行

DownloadTask返回值是一个task，刚刚所有的操作都是为了创建一个图片加载任务。

接下来是这个方法的实现
注意他是有引入到了另一个方法里面这个方法resource.map { .network($0) }将 Resource转出了一个Source枚举

image.png

这样做的目的是还有一个Provider(以您自己的方式加载一些图像数据，只要您能够提供这些数据)的方法是来加载图片这个随后说下面我们看这个DataDownloadTask的任务实现
前面就是对source判空和placeholderimage进行赋值以及开始执行指示动画。重点是task的生成，并将改task赋值给加载图片的容器以控制task进度
看到task的创建有是在KingfisherManager中进行的，执行completionHandler 将加载图片容器的task置为nil，通过CallbackQueue进行成功或者失败的回调，

image.png

CallbackQueue是他将GCD封装了一下。并未gcd添加了一个安全同步步的方法避免主线程造成死锁。66666

image.png

KingfisherManager.shared.retrieveImage

显示将KingfisherOptionsInfo设置到KingfisherParsedOptionsInfo让其生效
如果forceRefresh为true那么不取缓存直接从远处获取，否则从缓存中取，如果缓存存在那么返回nil，没有缓存则判断是不是只从缓存中取如果是则抛出异常，否则去远程加载

image.png

loadAndCacheImage(远处获取)

RetrieveImageResult是回调的结果里面包含image cacheType source三个属性

image.png

provideImage 暂时不分析

ImageDownloader

这个类是KingFisher的核心下载类，在KingFisher中如果不指定生成那么就会生成一个默认的，通过设置URLSession进行下载，将URLSession的degate设置为sessionDelegate，这个类是负责回调URLSession的下载进度等
通过这个闭包类进行回调防止内存泄漏