如何使用Kingfisher展示图片？

官方Demo中使用setImage展示图片

// source: Kingfisher-Demo > ViewController.swift_ = (cell as! CollectionViewCell).cellImageView.kf.setImage(with: url,placeholder: nil,options: [.transition(ImageTransition.fade(1))],progressBlock: { receivedSize, totalSize inprint("\(indexPath.row + 1): \(receivedSize)/\(totalSize)")},completionHandler: { image, error, cacheType, imageURL inprint("\(indexPath.row + 1): Finished")
})
复制代码

为什么要使用kf ？

Kingfisher.swift

KingfisherCompatible协议有个只读属性kf，它返回Kingfisher。Demo中的cellImageView.kf即为Kingfisher(ImageView)。

//source: Kingfisher > Kingfisher.swiftpublic protocol KingfisherCompatible {associatedtype CompatibleTypevar kf: CompatibleType { get }
}public extension KingfisherCompatible {public var kf: Kingfisher<Self> {return Kingfisher(self)}
}复制代码

kingfisher中，对不同的种类可以进行各种不同的操作，比如对Image，你能对它设置图片、设置动画；对UIButton的不同状态设置图片；还有ImageView、WKInterfaceImage（watchOS中）。我们把这些不同的种类归位Base（泛型），它可以是Image，也可以是UIButton。不可继承的类Kingfisher就有属性Base，初始化时传入一个Base。

//source: Kingfisher > Kingfisher.swiftpublic final class Kingfisher<Base> {public let base: Basepublic init(_ base: Base) {self.base = base}
}
复制代码

//source: Kingfisher > Kingfisher.swiftextension Image: KingfisherCompatible { }
复制代码

在Kingfisher.swift中，让ImageView实现KingfisherCompatible协议。

ImageView+Kingfisher.swift

在ImageView+Kingfisher.swift中，定义当Base时ImageView的时候，给Kingfisher拓展方法，例如setImage方法。

//source: Kingfisher > Extensions > ImageView+Kingfisher.swiftextension Kingfisher where Base: ImageView public func setImage(with resource: Resource?,placeholder: Placeholder? = nil,options: KingfisherOptionsInfo? = nil,progressBlock: DownloadProgressBlock? = nil,completionHandler: CompletionHandler? = nil) -> RetrieveImageTask{// 代码太长，此处省略}复制代码

该setImage方法主要做了以下事：

1. 如果resource不存在，比如没有传入图的url，则给一个默认的placeholder（占位图）。

2. 如果resource存在，显示加载动画（若存在），调用KingfisherManager的retrieveImage方法，在拉取数据过程中，实时回调当前已收到的资源数据和总数据；完成后，主线程异步变化UI，不再显示加载动画，没有收到image就回调错误，有收到image就将base（此处为UIImageView）的image设为返回的image。非macOS平台可设置相关动画。

KingfisherManager.swift

该类管理了Kingfisher的下载和缓存，可以使用这个类来从网络URL地址或者缓存获取图片，retrieveImage方法。

//source: Kingfisher > Core > KingfisherManager.swift@discardableResult
public func retrieveImage(with resource: Resource,options: KingfisherOptionsInfo?,progressBlock: DownloadProgressBlock?,completionHandler: CompletionHandler?) -> RetrieveImageTask
{let task = RetrieveImageTask()let options = currentDefaultOptions + (options ?? KingfisherEmptyOptionsInfo)if options.forceRefresh {_ = downloadAndCacheImage(with: resource.downloadURL,forKey: resource.cacheKey,retrieveImageTask: task,progressBlock: progressBlock,completionHandler: completionHandler,options: options)} else {tryToRetrieveImageFromCache(forKey: resource.cacheKey,with: resource.downloadURL,retrieveImageTask: task,progressBlock: progressBlock,completionHandler: completionHandler,options: options)}return task
}
复制代码

1. 新建获取图片的任务task（RetrieveImageTask类型），并读取配置options（KingfisherOptionsInfo类型）

2. 如果配置中forceRefresh（永远从网络读取图片数据）为真，则调用本类中的downloadAndCacheImage方法，其使用ImageDownloader的downloadImage下载图片，下载完成后，如果返回的错误是notModified，尝试从targetCache读取已缓存的图片；如果下载成功则使用targetCache（ImageCache）类型的store方法缓存图片，然后如果配置中cacheOriginalImage为真且当前processor不是DefaultImageProcessor，使用originalCache缓存图片。

3. 如果配置中forceRefresh为假，则调用本类中的tryToRetrieveImageFromCache方法，其先从缓存targetCache里找，image存在则返回；如果image不存在，且正在使用DefaultImageProcessor，则去下载图片；如非使用DefaultImageProcessor，则用originalCache去看看原始图片是否已在缓存中，如果有则不再下载，直接用processor处理图片，使用targetCache存储再返回。

ImageCache.swift

//source: Kingfisher > Core > ImageCache.swiftopen func store(_ image: Image,original: Data? = nil,forKey key: String,processorIdentifier identifier: String = "",cacheSerializer serializer: CacheSerializer = DefaultCacheSerializer.default,toDisk: Bool = true,completionHandler: (() -> Void)? = nil){// 代码太长，此处省略}
复制代码

//source: Kingfisher > Core > ImageDownloader.swiftopen class ImageDownloader {class ImageFetchLoad {var contents = [(callback: CallbackPair, options: KingfisherOptionsInfo)]()var responseData = NSMutableData()var downloadTaskCount = 0var downloadTask: RetrieveImageDownloadTask?var cancelSemaphore: DispatchSemaphore?}var fetchLoads = [URL: ImageFetchLoad]()//其他属性省略
}复制代码

//source: Kingfisher > Core > ImageDownloader.swift@discardableResult
open func downloadImage(with url: URL,retrieveImageTask: RetrieveImageTask? = nil,options: KingfisherOptionsInfo? = nil,progressBlock: ImageDownloaderProgressBlock? = nil,completionHandler: ImageDownloaderCompletionHandler? = nil) -> RetrieveImageDownloadTask?{// 代码太长，此处省略}复制代码

//source: Kingfisher > Core > ImageDownloader.swiftfunc setup(progressBlock: ImageDownloaderProgressBlock?, with completionHandler: ImageDownloaderCompletionHandler?, for url: URL, options: KingfisherOptionsInfo?, started: @escaping ((URLSession, ImageFetchLoad) -> Void)) {// 代码太长，此处省略}复制代码

//source: Kingfisher > Core > ImageDownloader.swiftfunc fetchLoad(for url: URL) -> ImageFetchLoad? {var fetchLoad: ImageFetchLoad?barrierQueue.sync(flags: .barrier) { fetchLoad = fetchLoads[url] }return fetchLoad
}
复制代码

//source: Kingfisher > Core > ImageDownloader.swiftfunc urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {guard let url = task.originalRequest?.url else {return}if let downloader = downloadHolder {downloader.delegate?.imageDownloader(downloader, didFinishDownloadingImageForURL: url, with: task.response, error: error)}guard error == nil else {callCompletionHandlerFailure(error: error!, url: url)return}processImage(for: task, url: url)
}private func processImage(for task: URLSessionTask, url: URL) {// 代码太长，此处省略}复制代码

ImageTransition.swift

可以通过ImageTransition.swift文件来为已下载图片显示添加动画，例如渐入、从上下左右进入等动画，也可自定义动画。