AFNetworking 3 批量上传图片的 3 种方法

AFNetworking 在去年年底升级到了 3.0。这个版本更新想必有很多好处,然而让我吃惊的是,它并没有 batch request 接口。之前的 1.x 版本、2.x 版本都实现了这个很常见的需求,不知道作者为何选择在 3.x 中去掉它。

在 AFNetworking 2 中,我们只需一行代码就能解决批量上传的问题:

但 AFNetworking 3 用的是NSURLSession,而不是用NSOperation来包装NSURLConnection,所以把整个AFURLConnectionOperation类都干掉了。上面的方法不能再用,并且也没有给出替代品。因此,我们只能自己动手了。

实现这个功能,有几个要点:

  1. 异步上传。批量请求里的每个请求都应该在不同线程,可以同时上传。
  2. 在所有请求都完成之后,再通知回调。
  3. 尽管异步请求的返回先后顺序没有一定,很可能后发出的请求先返回;但是最后回调的时候,请求返回的结果必须要按请求发出的顺序排列。比如,一个很常见的处理是,上传图片的接口返回该图片的 url;那么回调结果里的 url 顺序显然需要跟上传的图片顺序一一对应上。
  4. 最好传完每张图片也能有一个回调,方便我们告诉用户上传的进度。

同时满足以上要点,主要有3种思路:GCD、NSOperation 以及 promise。这个需求也是示例多线程用法的一个很好的例子,所以我写了这篇比较详细的文章供大家参考。

下面的代码以图片上传为例。测试数据配置了 3 张图片,其中第 2 张图片尺寸最小,往往先上传完毕,用来测试请求发出顺序与返回顺序不一致的情况。

227290-49c6bd2c7d2a877f测试图片之一


方法一:GCD dispatch group

我们知道,GCD dispatch 是多线程处理最简单的方法。全部请求完成后再通知回调的需求,很适合利用 dispatch group 来完成。至于保证返回结果的顺序,我们只好自己来做了。

首先需要一个方法,对于每张图片生成一个上传请求。

在这个方法里,我们首先用UIImageJPEGRepresentationUIImage变为NSData。然后用AFHTTPRequestSerializer来生成NSMutableURLRequest[self uploadUrl]是上传接口的地址。为安全考虑,一般上传的接口都有身份验证的需求,比如在请求 header 中加入 auth 信息,可以在此配置NSMutableURLRequest的 header。最后,我们用 AFURLSessionManagerNSURLRequest 和回调 block 包装成一个NSURLSessionUploadTask

有了生成请求的方法,批量发出请求的方法如下:

可以看到,我们把所有请求放在一个 dispatch_group 里。首先用dispatch_group_create()来创建这个 group。然后,对于每一个 uploadTask,在创建之前先执行dispatch_group_enter(group),在结束回调的 block里执行dispatch_group_leave(group)。结束回调的代码放在dispatch_group_notify里即可。

实际执行中,首先是所有 task 都进入 group,同时开始上传;上传完成之后依次离开 group;最后 group 空了会自动调用传入group_notify的回调,整个过程完成。

那么如何把回调数据排成正确的顺序呢?借助 block 会保存自动变量的特点,我们让每个 task 的回调 block 都自动带上标志请求次序的变量 i,只需把返回结果填入数组的第 i 位即可。所以在开始请求之前,先创建好保存返回结果的数组,元素个数与请求个数相等,每个位置上用[NSNull null]占位。每个请求返回之后,把自己那个位置上的[NSNull null]替换成返回结果。全部请求返回之后,数组里保存的自然是按请求顺序排列的回调数据。

这里注意,因为 NSMutableArray 是线程不安全的,而每个请求返回时是在不同线程操作同一个数组,所以我用@synchronized把操作数组的代码锁住了,锁的对象就用这个数组即可。这样保证所有线程执行到这一句都得串行,避免线程安全问题。

一次测试结果如下:

可以看到,尽管第 2 张图片尺寸最小、最先传完,第 1 张图片后传完,但最后的结果顺序还是正确的。


方法二:NSOperationQueue

能用 dispatch 实现的功能,自然也可以用NSOperationQueue。NSOperation 这一套比 dispatch 写起来要麻烦一些,不过有几个优点:

  1. NSOperation是对象,不像 dispatch 是 c 函数。这就意味着你可以继承它,可以给它加 category,在执行过程中也可以始终管理它,访问到它,查看它的状态等,不像 dispatch 是一撒手就够不着了。
  2. NSOperation执行的任务,执行过程中可以随时取消。dispatch 一经发出是无法取消的。
  3. NSOperationQueue可以限制最大并发数。假如队列里真有 100 个文件要传,开出 100 个线程反而会严重影响性能。NSOperationQueue可以很方便地设置maxConcurrentOperationCount。dispatch 也可以限制最大并发数(参考苹果的文档)不过写起来麻烦很多。

就我们的需求而言,用 NSOperation 有一个很方便的特点:dispatch 里的任务各自为政,而NSOperation之前是可以有依赖关系的。我们就可以利用这一点,来发起所有任务上传完成后的回调:把这个完成回调也做成一个NSOperation,让这个NSOperation前置依赖所有上传的NSOperation,这样等到所有上传的NSOperation完成之后,这个回调NSOperation才会开始执行。

然而,用NSOperation也有一个很不方便的特点:NSOperationQueue是用 KVO 观察NSOperation状态来判断任务是否已结束的。而我们请求用的NSURLSessionTask,它长得很像一个NSOperation,但却并不是NSOperation的子类。所以,这一套方法最麻烦的地方就在于我们需要写一个自定义的NSOperation子类,只是为了跟踪NSURLSessionTask的状态。

自定义的NSOperation代码如下:

HAMURLSessionWrapperOperation.h

HAMURLSessionWrapperOperation.m

代码有点长,但没办法。我们的目标是对每个NSURLSessionTask都包装出一个HAMURLSessionWrapperOperation,这个NSOperation完全随着NSURLSessionTask的状态而动,在 Task 结束之后发出 KVO 的通知,通知NSOperationQueue这个任务结束。

系统NSOperationfinished属性是只读的,不能修改;为了记录值和发出 KVO 的通知,我们只能在旁再定义一个finished的成员变量,通过重写- (BOOL)isFinished等 getter 方法,盖掉原来的finished属性。现在几乎全用 property,这种成员变量的写法好久没看见过了,没想到还有这种用处,这种特殊的写法还是从苹果文档学来的(参考这里)。

这里 start 方法照抄苹果文档,在新线程调起 main 方法。main 方法里就两件事:开始 KVO 观察上传 task 的 state 属性,然后启动 task。一旦 task 完成(或失败),接到 KVO 的通知,我们停止对 task 的观察,然后发出自己的 KVO 通知去通知NSOperationQueue。这里我们手动调起了[self willChangeValueForKey:@"isFinished"];[self didChangeValueForKey:@"isFinished"];,又重写了- (BOOL)isFinished方法,就把只读的finished属性偷天换日变成我们自己定义的finished成员变量了。

自定义NSOperation说完了,下面我们来看看怎么使用这个类。我们同样要利用上面 dispatch 一节写的那个uploadTaskWithImage:completion方法,根据图片生成请求。发出请求的代码如下:

保持结果顺序的方法与 dispatch 相同,都是我们自己完成的。我们把maxConcurrentOperationCount定成 5,避免并发过多竞争资源。先创建结束回调的 operation,再让它依赖后面创建的每一个上传 operation。因为一般回调都要涉及到更新 UI,所以让它回到主线程执行。后面根据每张图片逐一创建 task、包装成 operation。创建好之后,加进 operationQueue 里就开始跑了。

一次测试结果如下:

结果也是正确的。


方法三:promise

上面的两种方法,我们都是自己用数组、占位、逐位替换的方法,自己写代码保证返回数据顺序正确的。其实这种需要多个线程执行、全部结束后回调、结果顺序保证正确的需求,一般最适合用 promise 来做。各个语言都有自己的 promise 实现,iOS 也有好几种。这里我们试用一下 iOS 最著名的实现 PromiseKit

在 github 上 5000 多个 star,这个 lib 是 Objective-C 、Swift 通用的,两套代码都有。在网络请求方面,它要依赖同一个作者写的另一个库 OMGHTTPURLRQ,导入的时候小费周折。PromiseKit 这一套方法与 AFNetworking 库就没关系了,可能有些离题,但是用起来是最为方便的。

这里我们不再需要上面那个生成NSURLSessionTask的方法了,现在我们需要把NSURLRequest包装成AnyPromise

这里可以看到 promise 的.then语法。它是一个 C 函数,传进的参数是这项 promise 完成之后下一步需要执行的 block,返回值仍然是AnyPromise,所以可以一直.then().then()……这样链式调用下去。我们在这里让它上传完单张图片之后执行单张图片的回调,把回调 block『附身』在上传的 promise 之后。

上面就是创建 promise 的过程。那么执行 promise 的代码怎么写呢?

可以看到代码非常简洁,可读性又好,比前两种方法都省去不少代码,这是 promise 的一大优势。我们只需把针对每张图片创建一个 promise ,放进一个 promises 数组,然后PMKWhen(promises).then()就能帮我们搞定一切了——是不是很神奇呢?每个任务单开线程、等待全部任务执行完、结果正确排序等诸多工序,全都由这一行代码搞定了。看看测试结果:

同样是正确的。

所以看起来用 promise 还是非常方便的。不过这是我第一次尝试用它,还不知道在工程中实际应用会有什么缺点。

以上就是多线程批量上传图片的 3 种方法。思路最初来自 stackoverflow 的这个问题How to send batch request by using AFNetworking 3.0,感谢这位回答的大神~

2 10 收藏 评论

可能感兴趣的话题



直接登录
跳到底部
返回顶部