Kingfisher - Swift图片下载缓存库异步加载多平台支持

Kingfisher

Kingfisher是一个强大的纯Swift库，用于从网络下载和缓存图像。它为您提供了一种纯Swift的方式来处理您下一个应用程序中的远程图像。

特性

Kingfisher入门

最简单的使用场景是使用UIImageView扩展将图像设置到图像视图：

import Kingfisher

let url = URL(string: "https://example.com/image.png")
imageView.kf.setImage(with: url)

Kingfisher将从url下载图像，将其发送到内存缓存和磁盘缓存，并在imageView中显示。当您稍后使用相同的URL设置时，图像将从缓存中检索并立即显示。

如果您使用SwiftUI，它也可以工作：

var body: some View {
    KFImage(URL(string: "https://example.com/image.png")!)
}

更高级的示例

通过强大的选项，您可以用Kingfisher简单地完成复杂的任务。例如，以下代码：

下载高分辨率图像。
将其下采样以匹配图像视图大小。
使用给定的半径将其制作成圆角。
在下载时显示系统指示器和占位图像。
准备就绪后，使用"淡入"效果为小缩略图添加动画。
原始大图像也被缓存到磁盘以供后续使用，避免在详细视图中再次下载。
当任务完成时，无论成功还是失败，都会打印控制台日志。

let url = URL(string: "https://example.com/high_resolution_image.png")
let processor = DownsamplingImageProcessor(size: imageView.bounds.size)
             |> RoundCornerImageProcessor(cornerRadius: 20)
imageView.kf.indicatorType = .activity
imageView.kf.setImage(
    with: url,
    placeholder: UIImage(named: "placeholderImage"),
    options: [
        .processor(processor),
        .scaleFactor(UIScreen.main.scale),
        .transition(.fade(1)),
        .cacheOriginalImage
    ])
{
    result in
    switch result {
    case .success(let value):
        print("任务完成: \(value.source.url?.absoluteString ?? "")")
    case .failure(let error):
        print("任务失败: \(error.localizedDescription)")
    }
}

这是我在日常工作中经常遇到的情况。想想如果没有Kingfisher，您需要写多少行代码！

方法链接

如果您不喜欢kf扩展，您也可以选择使用KF构建器并链接方法调用。以下代码实现相同的功能：

// 使用`kf`扩展
imageView.kf.setImage(
    with: url,
    placeholder: placeholderImage,
    options: [
        .processor(processor),
        .loadDiskFileSynchronously,
        .cacheOriginalImage,
        .transition(.fade(0.25)),
        .lowDataMode(.network(lowResolutionURL))
    ],
    progressBlock: { receivedSize, totalSize in
        // 进度更新
    },
    completionHandler: { result in
        // 完成
    }
)

// 使用`KF`构建器
KF.url(url)
  .placeholder(placeholderImage)
  .setProcessor(processor)
  .loadDiskFileSynchronously()
  .cacheMemoryOnly()
  .fade(duration: 0.25)
  .lowDataModeSource(.network(lowResolutionURL))
  .onProgress { receivedSize, totalSize in  }
  .onSuccess { result in  }
  .onFailure { error in }
  .set(to: imageView)

更好的是，如果之后您想切换到SwiftUI，只需将上面的KF改为KFImage，就完成了：

struct ContentView: View {
    var body: some View {
        KFImage.url(url)
          .placeholder(placeholderImage)
          .setProcessor(processor)
          .loadDiskFileSynchronously()
          .cacheMemoryOnly()
          .fade(duration: 0.25)
          .lowDataModeSource(.network(lowResolutionURL))
          .onProgress { receivedSize, totalSize in  }
          .onSuccess { result in  }
          .onFailure { error in }
    }
}

要求

Kingfisher 8.0

(UIKit/AppKit) iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+ / visionOS 1.0+
(SwiftUI) iOS 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+ / visionOS 1.0+
Swift 5.0+

Kingfisher 7.0

(UIKit/AppKit) iOS 12.0+ / macOS 10.14+ / tvOS 12.0+ / watchOS 5.0+ / visionOS 1.0+
(SwiftUI) iOS 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+ / visionOS 1.0+
Swift 5.0+

安装

详细的安装指南可以在安装指南中找到。

Swift包管理器

文件 > Swift包 > 添加包依赖
添加 https://github.com/onevcat/Kingfisher.git
选择"Up to Next Major"，版本为"7.0.0"

CocoaPods

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '12.0'
use_frameworks!

target 'MyApp' do
  pod 'Kingfisher', '~> 7.0'
end

预构建框架

打开发布页面，从资源部分下载最新版本的Kingfisher。
将Kingfisher.xcframework拖入您的项目并将其添加到目标（通常是应用目标）。
选择您的目标，在"General"标签中，找到"Frameworks, Libraries, and Embedded Content"部分，将Kingfisher设置为Embed Without Signing。