SDWebImage 的常用方法使用

原创 2015年11月20日 20:45:54

API documentation is available at CocoaDocs - SDWebImage

UITableView中使用 UIImageView+WebCache category

Just #import the UIImageView+WebCache.h header, and call the setImageWithURL:placeholderImage: method from the tableView:cellForRowAtIndexPath: UITableViewDataSource method. Everything will be handled for you, from async downloads to caching management.

#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 setImageWithURL: method to load the web image
    [cell.imageView setImageWithURL:[NSURL URLWithString:@""]
                   placeholderImage:[UIImage imageNamed:@"placeholder.png"]];

    cell.textLabel.text = @"My Text";
    return cell;

使用 blocks

With blocks, you can be notified about the image download progress and whenever the image retrival has completed with success or not:

// Here we use the new provided setImageWithURL: method to load the web image
[cell.imageView setImageWithURL:[NSURL URLWithString:@""]
               placeholderImage:[UIImage imageNamed:@"placeholder.png"]
                      completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType) {... completion code here ...}];

Note: neither your success nor failure block will be call if your image request is canceled before completion.

使用 SDWebImageManager

The SDWebImageManager is the class behind the UIImageView+WebCache category. It ties the asynchronous downloader with the image cache store. You can use this class directly to benefit from web image downloading with caching in another context than a UIView (ie: with Cocoa).

Here is a simple example of how to use SDWebImageManager:

SDWebImageManager *manager = [SDWebImageManager sharedManager];
[manager downloadWithURL:imageURL
                 progress:^(NSInteger receivedSize, NSInteger expectedSize)
                     // progression tracking code
                 completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, BOOL finished)
                     if (image)
                         // do something with image

使用 Asynchronous Image Downloader Independently

It's also possible to use the async image downloader independently:

[SDWebImageDownloader.sharedDownloader downloadImageWithURL:imageURL
                                                   progress:^(NSInteger receivedSize, NSInteger expectedSize)
                                                       // progression tracking code
                                                   completed:^(UIImage *image, NSData *data, NSError *error, BOOL finished)
                                                       if (image && finished)
                                                           // do something with image

使用 Asynchronous Image Caching Independently

It is also possible to use the aync based image cache store independently. SDImageCache maintains a memory cache and an optional disk cache. Disk cache write operations are performed asynchronous so it doesn't add unnecessary latency to the UI.

The SDImageCache class provides a singleton instance for convenience but you can create your own instance if you want to create separated cache namespace.

To lookup the cache, you use the queryDiskCacheForKey:done: method. If the method returns nil, it means the cache doesn't currently own the image. You are thus responsible for generating and caching it. The cache key is an application unique identifier for the image to cache. It is generally the absolute URL of the image.

SDImageCache *imageCache = [[SDImageCache alloc] initWithNamespace:@"myNamespace"];
[imageCache queryDiskCacheForKey:myCacheKey done:^(UIImage *image)
    // image is not nil if image was found

By default SDImageCache will lookup the disk cache if an image can't be found in the memory cache. You can prevent this from happening by calling the alternative methodimageFromMemoryCacheForKey:.

To store an image into the cache, you use the storeImage:forKey: method:

[[SDImageCache sharedImageCache] storeImage:myImage forKey:myCacheKey];

By default, the image will be stored in memory cache as well as on disk cache (asynchronously). If you want only the memory cache, use the alternative method storeImage:forKey:toDisk: with a negative third argument.

使用 cache key filter

Sometime, you may not want to use the image URL as cache key because part of the URL is dynamic (i.e.: for access control purpose). SDWebImageManager provides a way to set a cache key filter that takes the NSURL as input, and output a cache key NSString.

The following example sets a filter in the application delegate that will remove any query-string from the URL before to use it as a cache key:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
    SDWebImageManager.sharedManager.cacheKeyFilter = ^(NSURL *url) {
        url = [[NSURL alloc] initWithScheme:url.scheme path:url.path];
        return [url absoluteString];

    // Your app init code...
    return YES;


Using dynamic image size with UITableViewCell

UITableView determins the size of the image by the first image set for a cell. If your remote images don't have the same size as your placeholder image, you may experience strange anamorphic scaling issue. The following article gives a way to workaround this issue:


SDWebImage does very aggressive caching by default. It ignores all kind of caching control header returned by the HTTP server and cache the returned images with no time restriction. It implies your images URLs are static URLs pointing to images that never change. If the pointed image happen to change, some parts of the URL should change accordingly.

If you don't control the image server you're using, you may not be able to change the URL when its content is updated. This is the case for Facebook avatar URLs for instance. In such case, you may use the SDWebImageRefreshCached flag. This will slightly degrade the performance but will respect the HTTP caching control headers:

[imageView setImageWithURL:[NSURL URLWithString:@""]
          placeholderImage:[UIImage imageNamed:@"avatar-placeholder.png"]


See this category:

版权声明:VIC 举报



//常用方法一 - (void)sd_setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder; //例如: [cel...






在网站上看到大牛们在分析SDWebImage,所以就借鉴了自己觉得不错的地方,大家可以瞅一眼。 SDWebImage作为目前最受欢迎的图片下载第三方框架,使用率很高。本文将通过例子分析如何合...

SDWebImage 更新 简单使用方法

最新版本下载地址 :


SDWebImage作为目前最受欢迎的图片下载第三方框架,使用率很高。但是你真的会用吗?本文接下来将通过例子分析如何合理使用SDWebImage。 使用场景:自定义的UITableViewCel...


"加载GIF图"- (void)loadGIF { NSURL *URL; // 加载网络gif图 URL = [NSURL URLWithString:@"http://pho...


报错:Use of undeclared identifier '_executing' / '_finished';解决方法:在SDWebImageDownloaderOperation类的实现中(...

SDWebImage中的- (void)sd_setImageWithURL:(NSURL *)url方法分析

经常有面试官问到SDWebImage的请求过程。感觉有必要写下来。查看UIImageView+WebCache.m文件:- (void)sd_setImageWithURL:(NSURL *)url这...