Project Icon

SDWebImage

异步图片加载与缓存管理框架

SDWebImage是一款iOS图片加载库,提供异步下载、缓存管理和内存优化功能。支持UIImageView和UIButton等组件,具备渐进式加载、缩略图解码和自定义转换等特性。该框架确保主线程不被阻塞,性能优异,适用于多种图片加载场景。

构建状态 Pod版本 Pod平台 Pod许可证 Carthage兼容 SwiftPM兼容 Mac Catalyst兼容 codecov

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

💡注意:SDSimple Design(作者Olivier Poitrey在Daily Motion公司的团队名称)的前缀

特性

对于Apple visionOS

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

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

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

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

支持的图像格式

💡注意:对于新用户

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结构WebImageAnimatedImage,为任何View提供ImageIndicator修饰符,ImageManager可观察对象作为数据源。支持iOS 13+/macOS 10.15+/tvOS 13+/watchOS 6+和Swift 5.1。欢迎尝试并提供反馈!

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

自定义缓存

自定义加载器

与第三方库集成

社区驱动的热门库

让我们的生活更轻松

你可以直接使用这些,或者利用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)

向后兼容性

入门

谁在使用它

沟通

  • 如果你需要帮助,使用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/macOSSDAnimatedImageUIImage/NSImage的子类,SDAnimatedImageViewUIImageView/NSImageView的子类,使它们与常见框架API兼容。

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

没有UIView(比如WatchKitCALayer)? 你仍然可以使用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个可用的子规格:CoreMapKit(这意味着你可以只安装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的数据收集做法列表。

作者

合作者

致谢

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

贡献者

许可证

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

架构

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

高级图表

整体类图

顶级API图

主要序列图

更详细的图表

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

白日梦AI

白日梦AI提供专注于AI视频生成的多样化功能,包括文生视频、动态画面和形象生成等,帮助用户快速上手,创造专业级内容。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Trae

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

Project Cover

讯飞绘镜

讯飞绘镜是一个支持从创意到完整视频创作的智能平台,用户可以快速生成视频素材并创作独特的音乐视频和故事。平台提供多样化的主题和精选作品,帮助用户探索创意灵感。

Project Cover

讯飞文书

讯飞文书依托讯飞星火大模型,为文书写作者提供从素材筹备到稿件撰写及审稿的全程支持。通过录音智记和以稿写稿等功能,满足事务性工作的高频需求,帮助撰稿人节省精力,提高效率,优化工作与生活。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号