参考:AFNetworking 3.0 源码解读(八)之 AFImageDownloader
说明:很多内容都是摘抄原文,只是根据自己的需要进行摘抄或者总结,如有不妥请及时指出,谢谢。
AFImageDownloader 这个类对写DownloadManager有很大的借鉴意义。在平时的开发中,当我们使用UIImageView加载一个网络上的图片时,其原理就是把图片下载下来,然后再赋值。这也是AFImageDownloader这个类的核心功能。
AFImageDownloadPrioritization
表示图片下载的优先级:
AFImageDownloadPrioritizationFIFO 表示先进先出
AFImageDownloadPrioritizationLIFO 表示后进先出
AFImageDownloaderMergedTask
AFImageDownloaderMergedTask 封装了对同一个请求的处理。同下载任务一样,也存在下载的URL重复的情况,这种情况需要做特殊处理。这里是一个值得借鉴的地方。那么如何判定是一个请求呢?AFImageDownloader是通过request.URL.absoluteString来进行判断的。
AFImageDownloader
NSURLCache
我们简单介绍下NSURLCache。NSURLCache 为您的应用的 URL 请求提供了内存中以及磁盘上的综合缓存机制。网络缓存减少了需要向服务器发送请求的次数,同时也提升了离线或在低速网络中使用应用的体验。当一个请求完成下载来自服务器的回应,一个缓存的回应将在本地保存。下一次同一个请求再发起时,本地保存的回应就会马上返回,不需要连接服务器。NSURLCache 会 自动 且 透明 地返回回应。
NSURLRequest 有个 cachePolicy 属性,我们平时最常用的有四个属性:
NSURLRequestUseProtocolCachePolicy: 对特定的 URL 请求使用网络
协议中实现的缓存逻辑。这是默认的策略。
NSURLRequestReloadIgnoringLocalCacheData:数据需要从原始地址
加载。不使用现有缓存。
NSURLRequestReturnCacheDataElseLoad:无论缓存是否过期,先使
用本地缓存数据。如果缓存中没有请求所对应的数据,那么从原始地址
加载数据
NSURLRequestReturnCacheDataDontLoad:无论缓存是否过期,先使
用本地缓存数据。如果缓存中没有请求所对应的数据,那么放弃从原始
地址加载数据,请求视为失败(即:“离线”模式)。
核心方法
- (nullable AFImageDownloadReceipt *)downloadImageForURLRequest:(NSURLRequest *)request
withReceiptID:(nonnull NSUUID *)receiptID
success:(nullable void (^)(NSURLRequest *request, NSHTTPURLResponse * _Nullable response, UIImage *responseObject))success
failure:(nullable void (^)(NSURLRequest *request, NSHTTPURLResponse * _Nullable response, NSError *error))failure {
__block NSURLSessionDataTask *task = nil;
//判断URLIdentifier有效性
dispatch_sync(self.synchronizationQueue, ^{
NSString *URLIdentifier = request.URL.absoluteString;
if (URLIdentifier == nil) {
if (failure) {
NSError *error = [NSError errorWithDomain:NSURLErrorDomain code:NSURLErrorBadURL userInfo:nil];
dispatch_async(dispatch_get_main_queue(), ^{
failure(request, nil, error);
});
}
return;
}
// 1) Append the success and failure blocks to a pre-existing request if it already exists
//根据URLIdentifier,找到已经存在的任务,把回掉与这个任务进行绑定
AFImageDownloaderMergedTask *existingMergedTask = self.mergedTasks[URLIdentifier];
if (existingMergedTask != nil) {
AFImageDownloaderResponseHandler *handler = [[AFImageDownloaderResponseHandler alloc] initWithUUID:receiptID success:success failure:failure];
[existingMergedTask addResponseHandler:handler];
task = existingMergedTask.task;
return;
}
// 2) Attempt to load the image from the image cache if the cache policy allows it
//如果缓存策略允许,则直接读取缓存图片
switch (request.cachePolicy) {
case NSURLRequestUseProtocolCachePolicy:
case NSURLRequestReturnCacheDataElseLoad:
case NSURLRequestReturnCacheDataDontLoad: {
UIImage *cachedImage = [self.imageCache imageforRequest:request withAdditionalIdentifier:nil];
if (cachedImage != nil) {
if (success) {
dispatch_async(dispatch_get_main_queue(), ^{
success(request, nil, cachedImage);
});
}
return;
}
break;
}
default:
break;
}
// 3) Create the request and set up authentication, validation and response serialization
//走到这一步,说明图片还没有找到,那么必然我们需要下载了
//创建request,设置权限、序列化信息
NSUUID *mergedTaskIdentifier = [NSUUID UUID];
NSURLSessionDataTask *createdTask;
__weak __typeof__(self) weakSelf = self;
createdTask = [self.sessionManager
dataTaskWithRequest:request
uploadProgress:nil
downloadProgress:nil
completionHandler:^(NSURLResponse * _Nonnull response, id _Nullable responseObject, NSError * _Nullable error) {
dispatch_async(self.responseQueue, ^{
__strong __typeof__(weakSelf) strongSelf = weakSelf;
AFImageDownloaderMergedTask *mergedTask = strongSelf.mergedTasks[URLIdentifier];
if ([mergedTask.identifier isEqual:mergedTaskIdentifier]) {
//从合并任务中,找到自己,并进行移除
mergedTask = [strongSelf safelyRemoveMergedTaskWithURLIdentifier:URLIdentifier];
if (error) {
for (AFImageDownloaderResponseHandler *handler in mergedTask.responseHandlers) {
if (handler.failureBlock) {
dispatch_async(dispatch_get_main_queue(), ^{
handler.failureBlock(request, (NSHTTPURLResponse*)response, error);
});
}
}
} else {
//移除成功后,对图片进行缓存
if ([strongSelf.imageCache shouldCacheImage:responseObject forRequest:request withAdditionalIdentifier:nil]) {
[strongSelf.imageCache addImage:responseObject forRequest:request withAdditionalIdentifier:nil];
}
for (AFImageDownloaderResponseHandler *handler in mergedTask.responseHandlers) {
if (handler.successBlock) {
dispatch_async(dispatch_get_main_queue(), ^{
handler.successBlock(request, (NSHTTPURLResponse*)response, responseObject);
});
}
}
}
}
//更新任务数,并开始下个任务
[strongSelf safelyDecrementActiveTaskCount];
[strongSelf safelyStartNextTaskIfNecessary];
});
}];
// 4) Store the response handler for use when the request completes
AFImageDownloaderResponseHandler *handler = [[AFImageDownloaderResponseHandler alloc] initWithUUID:receiptID
success:success
failure:failure];
//把当前任务添加到合并队列中
AFImageDownloaderMergedTask *mergedTask = [[AFImageDownloaderMergedTask alloc]
initWithURLIdentifier:URLIdentifier
identifier:mergedTaskIdentifier
task:createdTask];
[mergedTask addResponseHandler:handler];
self.mergedTasks[URLIdentifier] = mergedTask;
// 5) Either start the request or enqueue it depending on the current active request count
//如果当前任务数没有超出最大上限,则立即启动任务
if ([self isActiveRequestCountBelowMaximumLimit]) {
[self startMergedTask:mergedTask];
} else {
//按照优先级对任务进行排列
[self enqueueMergedTask:mergedTask];
}
task = mergedTask.task;
});
if (task) {
return [[AFImageDownloadReceipt alloc] initWithReceiptID:receiptID task:task];
} else {
return nil;
}
}
核心思想:数据共用,各自处理各自的响应结果。
对核心思想细化:
1、找到还未执行完的相同任务,如果找到了,就绑定回掉事件,等待任务执行即可。
2、如果缓存策略允许,直接去查图片,返回成功
3、创建一个下载任务,并添加到等待队列中
4、如果当前执行的任务数没有超过并发数,则立即执行,否则按照优先级决定任务放在队前还是队尾
5、执行任务
5.1、从合并任务中找到自己,并移除
5.2、对图片按照缓存策略进行缓存
5.3、更新激活的任务数并开始下一个任务
这个核心思想与上一片中的图片缓存策略合并起来,就是图片缓存原理的一个雏形了