这个库提供了一个支持从网络上获取远程图片的 UIImageView 分类。
它提供了以下功能:
UIImageView
分类注意:SDWebImage 的 3.0 版本并不完全向后兼容 2.0 版本,并且需要 iOS 5.1.1 最小部署版本。如果您需要 iOS < 5.0 的支持,请使用最后的 2.0 版本。
了解 谁在使用 SDWebImage 并将您的应用程序添加到列表中。
API 文档可以在 CocoaDocs - SDWebImage 中找到
只需 #import UIImageView+WebCache.h 头文件,并从 tableView:cellForRowAtIndexPath: UITableViewDataSource 方法调用 sd_setImageWithURL:placeholderImage: 方法。一切都将为您处理,从异步下载到缓存管理。
#import <SDWebImage/UIImageView+WebCache.h>
...
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
static NSString *MyIdentifier = @"MyIdentifier";
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:MyIdentifier];
if (cell == nil) {
cell = [[[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault
reuseIdentifier:MyIdentifier] autorelease];
}
// Here we use the new provided sd_setImageWithURL: method to load the web image
[cell.imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"]
placeholderImage:[UIImage imageNamed:@"placeholder.png"]];
cell.textLabel.text = @"My Text";
return cell;
}
使用块,您可以在图片下载进度和图像检索成功或失败时收到通知
// Here we use the new provided sd_setImageWithURL: method to load the web image
[cell.imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"]
placeholderImage:[UIImage imageNamed:@"placeholder.png"]
completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, NSURL *imageURL) {
... completion code here ...
}];
注意:如果您的图像请求在完成前被取消,您的成功或失败块将不会被调用。
SDWebImageManager 是 behind the UIImageView+WebCache category 的类。它将异步下载器与图像缓存存储绑定在一起。您可以直接使用这个类来在其他上下文中(例如,使用 Cocoa)享受带有缓存的网络图像下载。
以下是一个如何使用SDWebImageManager的简单示例
SDWebImageManager *manager = [SDWebImageManager sharedManager];
[manager downloadImageWithURL:imageURL
options:0
progress:^(NSInteger receivedSize, NSInteger expectedSize) {
// progression tracking code
}
completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, BOOL finished, NSURL *imageURL) {
if (image) {
// do something with image
}
}];
也可以单独使用异步图像下载器
SDWebImageDownloader *downloader = [SDWebImageDownloader sharedDownloader];
[downloader downloadImageWithURL:imageURL
options:0
progress:^(NSInteger receivedSize, NSInteger expectedSize) {
// progression tracking code
}
completed:^(UIImage *image, NSData *data, NSError *error, BOOL finished) {
if (image && finished) {
// do something with image
}
}];
也可以独立使用基于异步的图像缓存存储。SDImageCache维护一个内存缓存和一个可选的磁盘缓存。磁盘缓存的写操作是异步的,因此它不会给UI添加不必要的延迟。
SDImageCache类提供了一个单例实例以便于使用,但如果你想创建独立的缓存命名空间,你也可以创建自己的实例。
要查找缓存,你使用queryDiskCacheForKey:done:
方法。如果此方法返回nil,则表示缓存当前不拥有该图像。因此,你需要负责生成和缓存它。缓存键是缓存图像的应用程序唯一标识符。它通常是图像的绝对URL。
SDImageCache *imageCache = [[SDImageCache alloc] initWithNamespace:@"myNamespace"];
[imageCache queryDiskCacheForKey:myCacheKey done:^(UIImage *image) {
// image is not nil if image was found
}];
默认情况下,如果内存缓存中找不到图像,SDImageCache将查找磁盘缓存。你可以通过调用替代方法imageFromMemoryCacheForKey:
来防止这种行为。
要将图像存储到缓存中,你使用storeImage:forKey:
方法
[[SDImageCache sharedImageCache] storeImage:myImage forKey:myCacheKey];
默认情况下,图像将存储在内存缓存以及磁盘缓存中(异步)。如果你只想存储在内存缓存中,请使用具有负第三个参数的替代方法storeImage:forKey:toDisk:
。
有时,你可能不希望使用图像URL作为缓存键,因为URL的一部分是动态的(例如,为了访问控制)。SDWebImageManager提供了一种设置缓存键过滤器的方式,该过滤器以NSURL作为输入,并输出一个缓存键NSString。
以下示例将在应用程序代理中设置一个过滤器,该过滤器在将URL用作缓存键之前会删除任何查询字符串
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
SDWebImageManager.sharedManager.cacheKeyFilter = ^(NSURL *url) {
url = [[NSURL alloc] initWithScheme:url.scheme host:url.host path:url.path];
return [url absoluteString];
};
// Your app init code...
return YES;
}
UITableView通过单元格的第一个图像集来决定图像的大小。如果你的远程图像的大小与占位符图像不同,你可能会遇到奇特的假变形缩放问题。以下文章提供了一种绕过此问题的方法
http://www.wrichards.com/blog/2011/11/sdwebimage-fixed-width-cell-images/
默认情况下,SDWebImage会非常积极地缓存。它会忽略HTTP服务器返回的所有类型的缓存控制头,并以无时间限制的方式缓存返回的图像。这意味着你的图像URL是静态URL,指向永远不会更改的图像。如果指向的图像发生更改,URL的一些部分应该相应地更改。
如果你不能控制你使用的图像服务器,你可能无法在内容更新时更改URL。例如,Facebook头像URL就是这样。在这种情况下,你可以使用SDWebImageRefreshCached
标志。这将略微降低性能,但会尊重HTTP缓存控制头。
[imageView sd_setImageWithURL:[NSURL URLWithString:@"https://graph.facebook.com/olivier.poitrey/picture"]
placeholderImage:[UIImage imageNamed:@"avatar-placeholder.png"]
options:SDWebImageRefreshCached];
请参阅此分类: https://github.com/JJSaccolo/UIActivityIndicator-for-SDWebImage
有三种方法可以在你的项目中使用SDWebImage
platform :ios, '6.1'
pod 'SDWebImage', '~>3.7'
如果您在使用Swift语言,请确保添加use_frameworks!
并将目标版本设置为iOS 8及以上。
platform :ios, '8.0'
use_frameworks!
目前有3个Subspec可用:Core
、MapKit
和WebP
(这意味着您只需要安装SDWebImage模块的一部分。默认情况下,您仅获得Core
,所以如果您需要WebP
,您需要指定它)。
Podfile 示例
pod 'SDWebImage/WebP'
github "rs/SDWebImage"
Swift
如果您使用CocoaPods安装
import SDWebImage
如果您手动安装
import WebImage
Objective-C
@import WebImage;
为了访问仓库中的所有文件,您应该克隆它。
git clone --recursive https://github.com/rs/SDWebImage.git
打开“构建设置”选项卡,在“链接”部分中,找到“其他链接器标志”设置并添加“-ObjC”标志
或者,如果这导致与扩展可选库的框架(如Parse、RestKit或opencv2)的编译问题,则不用-ObjC标志,改用
-force_load SDWebImage.framework/Versions/Current/SDWebImage
如果您使用Cocoa Pods并且有任何扩展可选库的框架(如Parsen RestKit或opencv2),则不用-ObjC标志,改用
-force_load $(TARGET_BUILD_DIR)/libPods.a
and this
$(inherited)
在需要使用库的源文件中导入头文件
#import <SDWebImage/UIImageView+WebCache.h>
此时,您的workspace应该可以无错误地构建。如果遇到问题,请在Issue帖子中发布,社区可以帮助您解决问题。
所有源代码均根据MIT许可证授权。