[iOS-Foundation] NSURLSessionTas
在 URL session 中,一个 task 代表了一次特定的请求,通过NSURLSession
对象的方法可以创建不同种类的 task。NSURLSessionTask 类是所有不同的 task 类的基类,它的子类包括
NSURLSessionDataTask
,NSURLSessionUploadTask
,NSURLSessionDownloadTask
,NSURLSessionStreamTask
。
-
NSURLSessionDataTask
将响应内容以NSData
对象的形式返回,不能用在 background session 中。 -
NSURLSessionUploadTask
是NSURLSessionDataTask
的子类,同样将响应内容以NSData
对象的形式返回,区别是通过代理可以查看请求时上传内容的过程,且该 task 可用在 background session 中。 -
NSURLSessionDownloadTask
则是将资源以文件的形式下载到硬盘中,没有 session 类型的限制。 -
NSURLSessionStreamTask
则是建立了一个 TCP/IP 连接。
控制 task 的状态
task 的当前状态由枚举类型NSURLSessionTaskState
的属性 state 表示,包含以下几种可能的值:
typedef NS_ENUM(NSInteger, NSURLSessionTaskState) {
NSURLSessionTaskStateRunning = 0,
NSURLSessionTaskStateSuspended = 1,
NSURLSessionTaskStateCanceling = 2, /*当向task发送cancel消息后,会转变为该状态,代理会收到- URLSession:task:didCompleteWithError:消息*/
NSURLSessionTaskStateCompleted = 3, /*完成状态不包括被取消的情况*/
};
通过NSURLSession
创建的 task 默认是状态是 suspended,调用- resume
方法后,task 的状态变为 running。通过- suspend
方法可以将 task 重新变为挂起状态,当恢复 running 状态时,download task 可以从中断的地方继续传输,而其他 task 都需要重新开始。当调用- cancel
方法后,task 变为 canceling 状态,在发送给 delegate 的URLSession:task:didCompleteWithError:
消息中,error 参数的 domain 为NSURLErrorDomain
,code 为NSURLErrorCancelled
。
相关信息
-
originalRequest
,创建 task 时对应的请求对象。 -
currentRequest
,当响应为重定向到其他 URL 时,该值会改变。 -
response
,服务端返回的NSURLResponse
对象。 -
taskIdentifier
,NSUInteger
类型,task 在 session 内的唯一标识。 -
error
,当任务失败时的NSError
对象。 -
taskDescription
,可给任务设置一个可读的描述,在如果需要界面展示时使用。
进度信息
-
countOfBytesExpectedToSend
,请求体的字节数,系统根据 header 中的 Content-Length 字段,或者作为请求体的NSData
或文件的大小来设置该值。 -
countOfBytesSent
,已发送的请求体字节数,当该值变化,会触发代理方法
-URLSession:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:
-
countOfBytesExpectedToReceive
,响应体期望收到的字节数,根据响应 header 中的 Content-Length 字段,若未指明,则该值为
NSURLSessionTransferSizeUnknown
(-1) -
countOfBytesReceived
,已收到的响应体字节数,当该值变化,会触发代理方法- URLSession:dataTask:didReceiveData:
或
URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:
优先级
task 有一个priority
属性,接受0到1之间的浮点数,通过每一个 task 不同的 priority 值,可以提示系统 task 执行的优先级,1为最高,0为最低。默认值是NSURLSessionTaskPriorityDefault
,即 0.5。系统提供了3个常量值:
NSURLSessionTaskPriorityDefault //0.5
NSURLSessionTaskPriorityLow // 0
NSURLSessionTaskPriorityHigh // 1
Task 子类
NSURLSessionDataTask
和NSURLSessionUploadTask
都没有再实现额外的方法,它们只是用来区分不同的 task。而NSURLSessionDownloadTask
除了用来区分 task,还额外实现了一个方法- cancelByProducingResumeData:
,这个方法调用了基类NSURLSessionTask
中的- cancel
方法,参数 completionHandler 要求传入一个 block,用来处理已传输的数据 resume data,这个 resume data 将来可用于 session 的- downloadTaskWithResumeData:
方法,以便继续中断的下载。