AFImageDownloader类说明


继承:NSObject


声明处:AFImageDownloader.h


概述

AFImageDownloader类负责在优先队列中并行下载图片。新添加的下载被添加在队列的前面或后面是依赖下载优先级。任意一个下载图片缓存在底层NSURLCache,以及内存映像缓存中。默认情况下,任何缓存图片下载请求等价于图片缓存,将自动被缓存图片代表服务。

任务

  • imageCache 属性
  • sessionManager 属性
  • downloadPrioritization 属性
  • + defaultInstance
  • + defaultURLCache
  • – init
  • – initWithSessionManager:downloadPrioritization:maximumActiveDownloads:imageCache:
  • – downloadImageForURLRequest:success:failure:
  • – downloadImageForURLRequest:withReceiptID:success:failure:
  • – cancelTaskForImageDownloadReceipt:

属性

downloadPrioritizaion

@property (nonatomic, assign) AFImageDownloadPrioritization downloadPrioritizaton

讨论

定义插入到队列中下载请求的排序优先级。默认为AFImageDownloadPrioritizationFIFO。

声明处

AFImageDownloader.h

imageCache

@property (nonatomic, strong, nullable) id<AFImageRequestCache> imageCache

讨论

图片缓存用来保存所有下载的图片。默认为AFAutoPurgingImageCache。

声明处

AFImageDownloader.h

sessionManager

@property (nonatomic, strong) AFHTTPSessionManager *sessionManager

讨论

AFHTTPSessionManager用来下载图片。默认情况下,这个属性根据一个AFImageResponseSerializer配置,为所有下载的图片提供一个共享的NSURLCache。

声明处

AFImageDownloader.h

类方法

defaultInstance

+ (instancetype)defaultInstance

讨论

共享默认的AFImageDownloader单例,使用默认值初始化。

声明处

AFImageDownloader.h

defaultURlCache

+ (NSURLCache *)defaultURLCache

讨论

使用常用的参数值创建一个默认的NSURlCache对象。

返回值

默认的NSURlCache对象。

声明处

AFImageDownloader.h

实例方法

CancelTaskForImageDownloadReceipt:

- (void)cancelTaskForImageDownloadReceipt:(AFImageDownloadReceipt *)imageDownloadReceipt

讨论

通过移除成功和失败的块,取消收据中数据任务,如果可能取消数据任务。如果数据任务在队列中等待,当没有其他的成功和失败块在数据任务中注册则会被取消。如果数据任务当前正在执行或已经完成,成功和失败的块被移除,那么当任务完成时不会再被调用。

参数

imageDownloadReceipt

取消图片下载收据。

声明处

AFImageDownloader.h

downloadImageForURLRequest:success:failure:

- (nullable AFImageDownloadReceipt *)downloadImageForURLRequest:(NSURLRequest *)request success:(nullable void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *_Nullable response , UIImage *responseObject ))success failure:(nullable void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *_Nullable response , NSError *error ))failure

讨论

使用sessionManager实例根据指定的URL请求创建一个数据任务。

参数

request

URL请求

success

一个块当图片数据任务成功完成后被执行。这个块没有返回值,有3个参数:客户端发送的请求,从服务器接受到的响应,从请求响应的数据创建的图片。如果图片是从缓存中返回的,那么响应参数会是nil。

failure

一个块当图片数据任务完成时失败时或成功时被执行。这个块没有返回值,有3个参数:客户端发送的请求,从服务器接收到的响应,描述网络或发生的解析错误的错误对象。

返回值

如果有效,返回数据任务的图片下载收据。如果图片是保存在缓存中,则返回nil。缓存和URL请求缓存政策允许使用缓存。

声明处

AFImageDownloader.h

downloadImageForURLRequest:withReceiptID:success:failure:

- (nullable AFImageDownloadReceipt *)downloadImageForURLRequest:(NSURLRequest *)request withReceiptID:(NSUUID *)receiptID success:(nullable void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *_Nullable response , UIImage *responseObject ))success failure:(nullable void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *_Nullable response , NSError *error ))failure

讨论

使用sessionManager实例,根据指定的URL请求创建一个数据任务。
如果有相同的数据任务已经在队列或当前正在被下载,则成功和失败的块被追加在已经存在的任务中。一旦任务完成,任务中所有的成功或失败的块都按添加的顺序被执行

参数

请求

URL请求

receiptID

下载收据使用的标识是这个请求创建的。必须是唯一的标识,不能在任何其他的请求中重复出现。

success

一个块当图片数据任务成功完成时被执行。这个块没有返回值,有3个参数:客户端发送的请求,从服务器接受到的响应,请求的响应数据创建的图片。如果图片是从缓存中返回的,那么响应参数为nil。

failure

一个块当图片数据任务完成时失败时或成功时被执行。这个块没有返回值,有3个参数:客户端发送的请求,从服务器接收到的响应,描述网络或发生的解析错误的错误对象。

返回值

如果有效,返回数据任务的图片下载收据。如果图片是保存在缓存中,则返回nil。缓存和URL请求缓存政策允许使用缓存。

声明处

AFImageDownloader.h

init

- (instancetype)init

讨论

默认初始化方法。

返回值

默认值初始化的AFImageDownloader实例。

声明处

AFImageDownloader.h

initWithSessionManager:downloadPrioritization:maxmumActiveDownloads:imageCache:

- (instancetype)initWithSessionManager:(AFHTTPSessionManager *)sessionManager downloadPrioritization:(AFImageDownloadPrioritization)downloadPrioritization maximumActiveDownloads:(NSInteger)maximumActiveDownloads imageCache:(nullable id<AFImageRequestCache>)imageCache

讨论

根据提供的会话管理器,下载优先级,最大下载数和图片缓存初始化一个AFImageDownloader实例。

参数

sessionManager

使用会话管理下载图片。

downloadPrioritization

下载队列的下载优先级。

maximumActiveDownloads

在任何时间中,允许主动下载的最大数。建议4.

图片缓存

图片缓存用来保存所有的下载的图片。

返回值

一个新的AFImageDownloader实例

声明处

AFImageDownloader.h

// END

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

推荐阅读更多精彩内容