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 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)imageCache

讨论

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

参数

sessionManager

使用会话管理下载图片。

downloadPrioritization

下载队列的下载优先级。

maximumActiveDownloads

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

图片缓存

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

返回值

一个新的AFImageDownloader实例

声明处

AFImageDownloader.h

// END

你可能感兴趣的:(AFImageDownloader类说明)