SDWebImage ReadMe.md 翻譯版

1.SDWebImage注釋翻譯版github下載地址:
[https://github.com/zJunZ/SDWebImage-CN]
2.SDWebImage框架github下載地址:
[https://github.com/rs/SDWebImage]
3.該文章簡單翻譯了SDWebImage最新版本(3.7.5)的readMe.md

Web Image

版本3.7.5|平臺iOS|開源協議MIT|

  • 該庫為UIImageView提供了一個分類來處理遠程圖片資源的加載。
1) 為Cocoa Touch框架提供一個UIImageView的分類,加載圖片并進行緩存處理。
2)異步圖像下載
3)異步存儲器+具備自動緩存過期處理的磁盤映像緩存
4)支持GIF播放
5)支持WebP格式
6)背景圖像解壓縮
7)保證同一個url圖片資源不被多次下載
8)保證錯誤url不被反復嘗試下載
9)保證不會阻塞主線程
10)高性能
11)使用GCD和ARC
12)支持Arm64架構

注:SDWebimage3.0版本并沒有完全向后兼容2.0版本且要求的最低配置為iOS5.1.1版本。如果你需要在iOS5.0以前的版本使用,那么請您使用2.0版本。 How is SDWebImage better than X?

  • AFNetworking已經提供UIImageView相似的功能,還有必要使用SDWebimage嗎?

Who Use It(誰用)

查看哪些應用使用了SDWebImage框架,添加你的應用到列表。

How To Use(如何用)

查看api文檔CocoaDocs - SDWebImage

TableView加載圖片使用UIImageView+WebCache分類

只需要包含UIImageView+WebCache.h頭文件,并在tableView的數據源方法tableView:cellForRowAtIndexPath: 中調用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;
}

使用Blocks

使用block,你將能夠得到圖片的下載進度并獲知圖片是否下載成功或者失敗:

// 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 ...
                             }];

注意:如果圖像請求在完成前被取消了,那么成功和失敗的block塊將都不會被調用。

使用 SDWebImageManager

UIImageView+WebCache分類背后調用的是SDWebImageManager類的方法,負責圖像的異步下載和緩存處理。你可以直接使用這個類來下載圖片和進行緩存處理。
這有一個如何使用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提供內存高速緩存和可選的磁盤高速緩存。磁盤高速緩存寫入操作是異步的,所以不需要在用戶界面添加不必要的延遲。

為了方便,SDImageCache類提供了一個單一的實例,但如果你想自定義緩存空間,那么可以創建自己的實例。

您可以使用queryDiskCacheForKey:done:方法查找緩存。如果該方法返回nil,則說明當前image沒有緩存。你需要負責下載和進行緩存處理。圖像緩存的key通常為該圖像的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: method:方法保存圖片到緩存。

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

默認情況下,圖像將被進行內存緩存和磁盤緩存(異步)。如果你只想要內存緩存,那么可以使用storeImage:forKey:toDisk:方法,第三個參數傳NO即可。

使用緩存key篩選器

有時,你可能會因為URL的一部分是動態的而不希望使用URL作為圖像緩存的key。 SDWebImageManager提供了一種方式來設置,輸入URL輸出對應的字符串。下面的示例在應用程序的委托中設置一個過濾器,在使用它的緩存鍵之前將從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;
}

常見問題

使用動態圖像大小的UITableViewCell

UITableViewCell通過第一個單元格設置的圖像決定圖像的尺寸。如果你加載的網絡圖片和占位符圖像尺寸不一致,那么您可能會遇到奇怪的變形比例問題。下面的文章給出了解決此問題的方法:

http://www.wrichards.com/blog/2011/11/sdwebimage-fixed-width-cell-images/

處理圖像刷新

SSDWebimage默認情況下做了很好的緩存處理。它忽略通過HTTP服務器返回的所有類型的緩存控制頭,并且沒有時間限制地緩存返回的圖像它意味著你的url指向的圖片是一成不變的。更好的做法是如果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安裝到您的項目中:

  • 使用Cocoapods
  • 復制所有文件到您的項目
  • 作為靜態庫導入項目
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,578評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,701評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,691評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,974評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,694評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,026評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,015評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,193評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,719評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,442評論 3 360
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,668評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,151評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,846評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,255評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,592評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,394評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,635評論 2 380

推薦閱讀更多精彩內容