SDWebImage

<p align="center" > <img src="https://yellow-cdn.veclightyear.com/2b54e442/4be98371-5b9c-4a14-9db9-9fe31d5a6ac1.png" title="SDWebImage标志" float=left> </p>

该库提供了一个带缓存支持的异步图像下载器。为了方便，我们为UI元素如UIImageView、UIButton、MKAnnotationView添加了分类。

💡注意：SD是Simple Design（作者Olivier Poitrey在Daily Motion公司的团队名称）的前缀

特性

• 为UIImageView、UIButton、MKAnnotationView添加分类，提供网络图像和缓存管理
• 异步图像下载器
• 具有自动缓存过期处理的异步内存+磁盘图像缓存
• 后台图像解压缩，避免帧率下降
• 渐进式图像加载（包括动画图像，如在Web浏览器中显示的GIF）
• 缩略图解码以节省大图像的CPU和内存
• 可扩展的图像编码器支持大量图像格式，如WebP
• 动画图像的全栈解决方案在CPU和内存之间保持平衡
• 可自定义和组合的转换可在下载后立即应用于图像
• 可自定义的多缓存系统
• 可自定义的多加载器系统以扩展功能，如照片库
• 图像加载指示器
• 图像加载过渡动画
• 保证同一URL不会被多次下载
• 保证无效URL不会反复重试
• 保证主线程永不阻塞
• 现代Objective-C和更好的Swift支持
• 性能！

对于Apple visionOS

从5.19+开始，SDWebImage在所有包管理器（包括CocoaPods/Carthage/SPM）上支持visionOS。如果遇到问题，请升级相关工具。

对于5.18+，SDWebImage可以为visionOS平台编译。然而，它仍处于测试阶段，可能包含问题，不像稳定的iOS UIKit支持。欢迎尝试并报告问题。

要在visionOS上构建，目前我们仅支持标准的Xcode集成。

请参见下面的使用Swift Package Manager安装和手动安装指南。

支持的图像格式

• Apple系统支持的图像格式（JPEG、PNG、TIFF、BMP等），包括GIF/APNG动画图像
• iOS 11/macOS 10.13起支持HEIC格式，包括iOS 13/macOS 10.15起通过SDWebImageHEICCoder支持的动画HEIC。对于较低固件，使用编码器插件SDWebImageHEIFCoder
• iOS 14/macOS 11.0起通过SDWebImageAWebPCoder支持WebP格式。对于较低固件，使用编码器插件SDWebImageWebPCoder
• iOS 17/macOS 14.0起内置支持JPEG-XL格式。对于较低固件，使用编码器插件SDWebImageJPEGXLCoder
• 支持新图像格式如BPG、AVIF的可扩展编码器插件。以及矢量格式如PDF、SVG。查看图像编码器插件列表中的完整列表

💡注意：对于新用户

SDWebImage使用编码器插件系统来支持Apple内置和外部图像格式。对于静态图像，我们总是使用Apple内置作为后备，但对于动画图像则不然。目前（更新到5.19.x版本）我们默认只注册传统动画格式如GIF/APNG，不包括现代格式如AWebP/HEICS/AVIF，即使在最新固件上。

如果你想支持这些动画图像格式，只需用一行代码自行注册，详见WebP编码器和HEIC编码器

未来我们将改变这一行为，始终注册所有Apple内置的动画图像格式，以便新用户更容易集成。

附加模块和生态系统

为了保持SDWebImage专注于核心功能并限制其范围，同时允许扩展性和自定义行为，在5.0重构期间我们着重于模块化库。 因此，我们将新模块移动/构建到SDWebImage组织。

SwiftUI

SwiftUI是一个创新的UI框架，用Swift编写，用于构建跨所有Apple平台的用户界面。

我们通过构建一个全新的框架SDWebImageSwiftUI来支持SwiftUI，该框架建立在SDWebImage核心功能（缓存、加载和动画）之上。

新框架为SwiftUI世界引入了两个View结构WebImage和AnimatedImage，为任何View提供ImageIndicator修饰符，ImageManager可观察对象作为数据源。支持iOS 13+/macOS 10.15+/tvOS 13+/watchOS 6+和Swift 5.1。欢迎尝试并提供反馈！

支持额外图像格式的编码器

• SDWebImageWebPCoder - WebP格式的编码器。iOS 9+/macOS 10.11+。基于libwebp
• SDWebImageHEIFCoder - HEIF格式的编码器，支持iOS 9+/macOS 10.11+。基于libheif
• SDWebImageBPGCoder - BPG格式的编码器。基于libbpg
• SDWebImageFLIFCoder - FLIF格式的编码器。基于libflif
• SDWebImageAVIFCoder - AVIF（基于AV1）格式的编码器。基于libavif
• SDWebImagePDFCoder - PDF矢量格式的编码器。使用内置框架
• SDWebImageSVGCoder - SVG矢量格式的编码器。使用内置框架
• SDWebImageSVGNativeCoder - SVG-Native矢量格式的编码器。基于svg-native
• SDWebImageLottieCoder - Lottie动画格式的编码器。基于rlottie
• SDWebImageJPEGXLCoder - JPEG-XL格式的编码器。iOS 9+/macOS 10.11+。基于libjxl
• 以及更多来自社区的贡献！

自定义缓存

• SDWebImageYYPlugin - 支持使用YYCache缓存图像的插件
• SDWebImagePINPlugin - 支持使用PINCache缓存图像的插件

自定义加载器

• SDWebImagePhotosPlugin - 支持从Photos加载图片的插件(使用 Photos.framework)
• SDWebImageLinkPlugin - 支持从富链接URL加载图片的插件,以及 LPLinkView (使用 LinkPresentation.framework)

与第三方库集成

• SDWebImageLottiePlugin - 支持 Lottie-iOS 的插件,使用远程JSON文件渲染矢量动画
• SDWebImageSVGKitPlugin - 支持 SVGKit 的插件,使用Core Animation渲染SVG,支持iOS 9+/macOS 10.11+
• SDWebImageFLPlugin - 支持 FLAnimatedImage 作为GIF动画引擎的插件
• SDWebImageYYPlugin - 集成 YYImage 和 YYCache 用于图片渲染和缓存的插件

社区驱动的热门库

• FirebaseUI - 基于SDWebImage加载系统的Firebase Storage图片查询绑定
• react-native-fast-image - 基于SDWebImage动画图片解决方案的React Native快速图片组件
• flutter_image_compress - 基于SDWebImage WebP编码器插件的Flutter图片压缩插件

让我们的生活更轻松

• libwebp-Xcode - libwebp的包装器 + Xcode项目。
• libheif-Xcode - libheif的包装器 + Xcode项目。
• libavif-Xcode - libavif的包装器 + Xcode项目。
• 以及更多支持CocoaPods/Carthage/SwiftPM的第三方C/C++图像编解码库。

你可以直接使用这些,或者利用SDWebImage的可定制架构创建类似的组件。

要求

• iOS 9.0或更高版本
• tvOS 9.0或更高版本
• watchOS 2.0或更高版本
• macOS 10.11或更高版本(Catalyst需要10.15)
• visionOS 1.0或更高版本
• Xcode 14.0或更高版本(visionOS需要Xcode 15.0)

向后兼容性

• 对于iOS 8、macOS 10.10或Xcode < 11,使用5.x版本直到5.9.5
• 对于iOS 7、macOS 10.9或Xcode < 8,使用4.x版本直到4.4.6
• 对于macOS 10.8,使用4.x版本直到4.3.0
• 对于iOS 5和6,使用3.x版本直到3.7.6
• 对于iOS < 5.0,请使用最后的2.0版本。

入门

• 阅读此README文档
• 阅读如何使用部分
• 阅读最新文档和旧版本的CocoaDocs
• 通过从Github下载项目或更简单地使用CocoaPods尝试pod try SDWebImage来尝试示例
• 阅读安装指南
• 阅读SDWebImage 5.0迁移指南了解从4.x到5.x的变化
• 阅读SDWebImage 4.0迁移指南了解从3.x到4.x的变化
• 阅读常见问题找到常见问题的解决方案
• 访问Wiki页面获取更多信息,如高级用法

谁在使用它

• 查看谁在使用SDWebImage并将你的应用添加到列表中。

沟通

• 如果你需要帮助,使用Stack Overflow。(标签'sdwebimage')
• 如果你想问一个一般性问题,使用Stack Overflow。
• 如果你发现了bug,打开一个issue。
• 如果你有功能请求,打开一个issue。
• 如果你需要IRC频道,使用Gitter。

贡献

• 如果你想贡献,阅读贡献指南
• 对于开发贡献指南,阅读如何贡献
• 要理解代码架构,阅读代码架构分析

如何使用

• Objective-C

#import <SDWebImage/SDWebImage.h>
...
[imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"]
             placeholderImage:[UIImage imageNamed:@"placeholder.png"]];

• Swift

import SDWebImage

imageView.sd_setImage(with: URL(string: "http://www.domain.com/path/to/image.jpg"), placeholderImage: UIImage(named: "placeholder.png"))

• 有关如何使用库的详细信息和清晰示例,请参阅详细的使用方法

动画图像(GIF)支持

在5.0中,我们引入了一种全新的支持动画图像的机制。这包括动画图像加载、渲染、解码,并且还支持自定义(针对高级用户)。

这个动画图像解决方案适用于iOS/tvOS/macOS。SDAnimatedImage是UIImage/NSImage的子类,SDAnimatedImageView是UIImageView/NSImageView的子类,使它们与常见框架API兼容。

SDAnimatedImageView支持熟悉的图像加载分类方法,可作为UIImageView/NSImageView的即插即用替代品。

没有UIView(比如WatchKit或CALayer)? 你仍然可以使用SDAnimatedPlayer这个播放引擎进行高级播放和渲染。

有关更详细信息,请参阅动画图像。

• Objective-C

SDAnimatedImageView *imageView = [SDAnimatedImageView new];
SDAnimatedImage *animatedImage = [SDAnimatedImage imageNamed:@"image.gif"];
imageView.image = animatedImage;

• Swift

let imageView = SDAnimatedImageView()
let animatedImage = SDAnimatedImage(named: "image.gif")
imageView.image = animatedImage

FLAnimatedImage集成有自己的专用仓库

为了整理项目并使我们的核心项目做更少的事情,我们决定FLAnimatedImage集成不属于这里。从5.0开始,这仍然可用,但在专用仓库SDWebImageFLPlugin中。

安装

有5种方法在你的项目中使用SDWebImage:

• 使用CocoaPods
• 使用Carthage
• 使用Swift Package Manager
• 下载二进制XCFramework
• 手动安装(构建框架或嵌入Xcode项目)

使用CocoaPods安装

CocoaPods是Objective-C的依赖管理器,它可以自动化和简化在项目中使用第三方库的过程。有关更多详细信息,请参阅入门部分。

Podfile

platform :ios, '8.0'
pod 'SDWebImage', '~> 5.0'

Swift和静态框架

Swift项目以前必须使用use_frameworks!将所有Pod变成动态框架才能让CocoaPods工作。

然而,从CocoaPods 1.5.0+(与Xcode 9+)开始,它支持将Objective-C和Swift代码构建到静态框架中。你可以使用模块化头文件将SDWebImage作为静态框架使用,而无需use_frameworks!:

platform :ios, '8.0'
# 当你想要所有Pod作为静态框架时取消下一行的注释
# use_modular_headers!
pod 'SDWebImage', :modular_headers => true

详见CocoaPods 1.5.0 — Swift静态库

如果不是,你仍然需要添加use_frameworks!将SDWebImage作为动态框架使用:

platform :ios, '8.0'
use_frameworks!
pod 'SDWebImage'

子规格

现在有2个可用的子规格:Core和MapKit(这意味着你可以只安装SDWebImage的某些模块。默认情况下,你只得到Core,所以如果你需要MapKit,你需要指定它)。

Podfile示例:

pod 'SDWebImage/MapKit'

使用Carthage安装

Carthage是Swift和Objective-C的轻量级依赖管理器。它利用CocoaTouch模块,比CocoaPods侵入性更小。

要使用carthage安装,请按照Carthage上的说明进行操作

Carthage用户可以指向这个仓库并使用他们喜欢的生成框架:SDWebImage、SDWebImageMapKit或两者都用。

在你的Cartfile中做以下条目:github "SDWebImage/SDWebImage" 然后运行carthage update 如果这是你第一次在项目中使用Carthage,你需要经过一些额外的步骤,这些步骤在Carthage上有解释。

💡注意:目前Carthage不提供构建特定存储库子组件(或等同于CocoaPods的subspecs)的方法。上述命令将构建所有组件及其依赖项。但是,您不需要将不使用的框架复制到项目中。例如,如果您不使用SDWebImageMapKit,可以在carthage update完成后从Carthage Build目录中删除该框架。

💡注意:Apple要求SDWebImage包含签名。因此,默认情况下carthage build二进制框架不进行代码签名,这将导致验证错误。您可以使用Apple Developer Program身份自行签名,或使用二进制框架:

binary "https://github.com/SDWebImage/SDWebImage/raw/master/SDWebImage.json"

使用Swift Package Manager安装(Xcode 11+)

Swift Package Manager(SwiftPM)是一个用于管理Swift代码以及C系列依赖项分发的工具。从Xcode 11开始,SwiftPM已原生集成到Xcode中。

SDWebImage从5.1.0版本开始支持SwiftPM。要使用SwiftPM,您应该使用Xcode 11打开项目。点击文件 -> Swift包 -> 添加包依赖,输入SDWebImage仓库的URL。或者您可以使用GitHub帐户登录Xcode,只需输入SDWebImage进行搜索。

选择包后,您可以选择依赖类型(标记版本、分支或提交)。然后Xcode将为您设置好所有内容。

如果您是框架作者并使用SDWebImage作为依赖项,请更新您的Package.swift文件:

let package = Package(
    // 5.1.0 ..< 6.0.0
    dependencies: [
        .package(url: "https://github.com/SDWebImage/SDWebImage.git", from: "5.1.0")
    ],
    // ...
)

下载二进制XCFramework

从5.19.2版本开始,SDWebImage在GitHub发布页面上提供了官方的二进制XCFramework。

• 下载XCFramework

您可以选择下载SDWebImage-dynamic.xcframework.zip作为动态链接版本,或SDWebImage-static.xcframework.zip作为静态链接版本。

• 集成到Xcode项目

将解压缩的.xcframework拖到Xcode项目的Framework选项卡中。

• 验证二进制XCFramework的签名

从Xcode 15开始,Apple将验证二进制XCFramework的签名,以避免供应链攻击。

当前的指纹应该是FC 3B 10 13 86 34 4C 50 DB 70 2A 9A D1 01 6F B5 1A 3E CC 8B 9D A9 B7 AE 47 A0 48 D4 D0 63 39 83

证书存储在仓库这里

公钥存储在仓库这里

更多信息见:验证XCFrameworks的来源

手动安装指南

• 检查命令行Xcode版本

sudo xcode-select -s /path/to/Xcode.app

或

export DEVELOPER_DIR=/path/to/Xcode.app/Contents/Developer

• 运行脚本构建框架

./Scripts/build-frameworks.sh

• 运行脚本合并XCFramework

./Scripts/create-xcframework.sh

• 使用您自己的证书签名XCFramework

// https://developer.apple.com/support/third-party-SDK-requirements/
codesign --timestamp -v --sign "your own certificate" SDWebImage.xcframework

更多信息见wiki:手动安装指南

在源文件中导入头文件

在需要使用库的源文件中,导入伞头文件:

#import <SDWebImage/SDWebImage.h>

还建议使用模块导入语法,适用于CocoaPods(启用modular_headers)/Carthage/SwiftPM。

@import SDWebImage;

构建项目

此时您的工作空间应该可以无错误构建。如果遇到问题,请在Issue中发帖,社区可以帮助您解决。

数据收集做法

从Xcode 15开始,我们提供了新的PrivacyInfo.xcprivacy文件用于隐私详情,请参阅在隐私清单中描述数据使用

在通过SwiftPM/XCFramework或CocoaPods(use_frameworks设置为true)集成SDWebImage后归档您的应用程序时,您可以导出隐私报告。

对于旧版本或如果您使用静态ar归档,根据App Store上的应用隐私详情的要求,这里是SDWebImage的数据收集做法列表。

作者

• Olivier Poitrey

合作者

• Konstantinos K.
• Bogdan Poplauschi
• Chester Liu
• DreamPiggy
• Wu Zhong

致谢

感谢所有已经为SDWebImage做出贡献的人。

许可证

所有源代码均采用MIT许可证授权。

架构

要了解SDWebImage的架构设计以便贡献,请阅读SDWebImage v5.6架构的核心。感谢@looseyi的文章和翻译。

高级图表

<p align="center" > <img src="https://yellow-cdn.veclightyear.com/2b54e442/41332e87-f56b-46d6-ba8b-32f2470276da.jpeg" title="SDWebImage高级图表"> </p>

整体类图

<p align="center" > <img src="https://yellow-cdn.veclightyear.com/2b54e442/c72032d0-004f-4032-b068-36dbaf34a509.png" title="SDWebImage整体类图"> </p>

顶级API图

<p align="center" > <img src="https://yellow-cdn.veclightyear.com/2b54e442/f1e8d141-4506-42d8-94cf-88cec1b88496.png" title="SDWebImage顶级API图"> </p>

主要序列图

<p align="center" > <img src="https://yellow-cdn.veclightyear.com/2b54e442/b42a6b6c-873e-412e-bb2d-61826a1ea043.png" title="SDWebImage序列图"> </p>

更详细的图表

• 管理器API图
• 编码器API图
• 加载器API图
• 缓存API图