SDWebImageDownloader类说明


继承于: NSObject


声明处: SDWebImageDownloader.h


概述

为下载图片提供专用和优化的异步下载器。

任务

  • shouldDecompressImages 属性
  • maxConcurrentDownload 属性
  • currentDownloadCount 属性
  • downloadTimeout 属性
  • sessionConfiguration 属性
  • executionOrder 属性
  • + sharedDownloader
  • urlCredential 属性
  • username 属性
  • password 属性
  • headerFilter 属性
  • - initWithSessionConfiguration:
  • - setValue:forHTTPHeaderField:
  • - valueForHTTPHeaderField:
  • setOperationClass:
  • – downloadImageWithURL:options:progress:completed:
  • - cancel:
  • setSuspended:
  • cancelAllDownloads
  • createNewSessionWithConfiguration:

属性

currentDownloadCount

@property (readonly, nonatomic) NSUInteger currentDownloadCount

讨论

显示当前仍然需要下载的大小。

声明处

SDWebImageDownloader.h

downloadTimeout

@property (assign, nonatomic) NSTimeInterval downloadTimeout

讨论

下载操作的超时时间(单位为秒)。默认值为:15.0.

声明处

SDWebImageDownloader.h

executionOrder

@property (assign, nonatomic) SDWebImageDownloaderExecutionOrder executionOrder

讨论

修改下载操作的执行顺序。默认值为SDWebImageDownloaderFIFOExecutionOrder。

声明处

SDWebImageDownloader.h

headersFilter

@property (nonatomic, copy, nullable) SDWebImageDownloaderHeadersFilterBlock headersFilter

讨论

设置过滤器用来挑选下载图片的HTTP请求的头。
这个块在每个图片下载请求时被调用,返回在相应的HTTP请求中用于HTTP头的NSDictionary。

声明处

SDWebImageDownloader.h

maxConcurrentDownloads

@property (assign, nonatomic) NSInteger maxConcurrentDownloads

讨论

最大的并发下载数。

声明处

SDWebImageDownloader.h

password

@property (strong, nonatomic, nullable) NSString *password

讨论

设置密码。

声明处

SDWebImageDownloader.h

sessionConfiguration

@property (readonly, nonatomic, nonnull) NSURLSessionConfiguration *sessionConfiguration

讨论

NSURLSession内部使用的配置。直接修改这个对象没有效果。

同见

- createNewSessionWithConfiguration:

声明处

SDWebImageDownloader.h

shouldDecompressImages

@property (assign, nonatomic) BOOL shouldDecompressImages

讨论

解压已经下载和缓存的图片可以提高性能,但是会消耗很多的内容。默认为YES。设置为NO,如果你遇到由于大量的消耗内存导致崩溃。

声明处

SDWebImageDownloader.h

urlCredential

@property (strong, nonatomic, nullable) NSURLCredential *urlCredential

讨论

为请求操作设置默认的URL证书。

声明处

SDWebImageDownloader.h

username

@property (strong, nonatomic, nullable) NSString *username

讨论

设置用户名。

声明处

SDWebImageDownloader.h

类方法

sharedDownloader

+ (nonnull instancetype)sharedDownloader

讨论

单例方法,返回一个共享的实例。

返回值

下载类的全局共享实例。

声明处

SDWebImageDownloader.h

实例方法

cancel

- (void)cancel:(nullable SDWebImageDownloadToken *)token

讨论

取消一个使用downloadImageWithURL:options:progress:completed:生成的在之前队列中的下载任务。

参数

token

downloadImageWithRUL:options:progress:completed:获取的token,应该被取消。

声明处

SDWebImageDownloader.h

cancelAllDownloads

- (void)cancelAllDownloads

讨论

取消队列中所有下载操作。

声明处

SDWebImageDownloader.h

createNewSessionWithConfiguration:

- (void)createNewSessionWithConfiguration:(nonnull NSURLSessionConfiguration *)sessionConfiguration

讨论

强制SDWebImageDownloader创建和使用一个根据提供的配置初始化的新NSURLSession。注意:所有在队列中已经存在的下载操作都会被取消。注意:timeoutIntervalForRequest将会被重写。

参数

sessionConfiguration

为新NSURLSession使用的配置。

声明处

SDWebImageDownloader.h

downloadImageWithURL:options:progress:completed:

- (nullable SDWebImageDownloadToken *)downloadImageWithURL:(nullable NSURL *)url options:(SDWebImageDownloaderOptions)options progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock completed:(nullable SDWebImageDownloaderCompletedBlock)completedBlock

讨论

根据提供的URL创建一个SDWebImageDownloader异步下载实例。
代理在图片下载完成或发生一个错误后被执行。
注意:进度块在后台队列中执行。

参数

url

下载图片的URL。

options

下载需要使用的选项。

progressBlock

在图片下载过程中,块被重复调用。

completedBlock

一旦下载完成就调用块。如果下载成功,image参数已经设置,如果发生错误,error参数设置为这个错误信息。如果SDWebImageDownloaderProgressDownload没有使用,最后的参数总是YES。SDWebImageDownloaderProgressiveDownload选项,在最后一次之前部分图片对象重复调用块,finished参数设置为NO。完整图片对象最后一次调用块,并设置finished参数为YES。假如发生错误,finished参数总是YES。

返回值

一个token(SDWebImageDownloadToken)。这个token可以传送cancel:来取消下载操作。

声明处

SDWebImageDownloader.h

initiWithSessionConfiguration:

- (nonnull instancetype)initWithSessionConfiguration:(nullable NSURLSessionConfiguration *)sessionConfiguration

讨论

根据指定的会话配置创建一个下载器实例。注意:timeoutIntervalForRequest将会被重写。

返回值

下载器类的实例。

声明处

SDWebImageDownloader.h

setOperationClass:

- (void)setOperationClass:(nullable Class)operationClass

讨论

设置SDWebImageDownloaderOperation的子类作为默认NSOperation,每次SDWebImage构建一个请求操作去下载一张图片时被使用。

参数

operationClass

SDWebImageDownloaderOperation的子类设置为默认值。传送nil将恢复为SDWebImageDownloadOperation。

声明处

SDWebImageDownloader.h

setSuspended:

- (void)setSuspended:(BOOL)suspended

讨论

设置下载队列的暂停状态。

声明处

SDWebImageDownloader.h

setValue:forHTTPHeaderField:

- (void)setValue:(nullable NSString *)value forHTTPHeaderField:(nullable NSString *)field

讨论

设置一个HTTP头的值,追加在每一个下载HTTP请求中。

参数

value

头域的值。使用nil去移除一个头。

field

设置的头域的名称。

声明处

SDWebImageDownloader.h

valueForHTTPHeaderField:

- (nullable NSString *)valueForHTTPHeaderField:(nullable NSString *)field

讨论

返回指定HTTP头域的值。

返回值

与头域相关联的值。如果没有一致的头域则为nil。

声明处

SDWebImageDownloader.h

// END 今天看了WePhone的创始人自杀的事件,天啊。程序员总结起来就是“简单却又胆小的程序员”。这个是外人的终结。我却无力反驳。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,265评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,078评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,852评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,408评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,445评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,772评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,921评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,688评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,130评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,467评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,617评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,276评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,882评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,740评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,967评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,315评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,486评论 2 348

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,629评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,749评论 25 707
  • 继承:NSObject 遵照:NSCopying,NSSecureCoding,NSURLSessionDataD...
    _阿南_阅读 1,780评论 1 2
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,923评论 6 13
  • 春天是赋予人间希望的象征。 山下一片杏花如云,山谷里溪流旋转,奔腾跳跃,丁冬作响,银雾飞溅。到处都是生机,就...
    我爱间书阅读 286评论 0 1