URL会话的生命周期 <- URL会话编程指南
你可以用两种方式使用NSURLSession API:系统提供的委托或自定义的委托。通常情况下,如果app由下面的任何行为,你就必须使用自定义的委托:
- 在app不运行的时候,使用后台会话来下载或上传内容
- 执行自定义的身份验证。
- 执行自定义的SSL证书验证。
- 根据服务器返回的MIME类型或其他类似的标准,决定是否应该把传输的内容下载到磁盘或者显示。
- 从body流(而不是NSData对象)上传数据
- 以编程的方式限制缓存。
- 以编程的方式限制HTTP重定向。
如果app不需要做以上行为,app可以使用系统提供的委托。基于你选择的技术阅读文档的不同部分:
- 使用系统提供委托的URL会话的生命周期,提供如何使用代码创建和使用URL会话的一个简单观察。如果你打算自己编写委托,你应该阅读这个部分。因为它把代码必须进行的配置和使用对象的内容提供给你。
- 使用自定义委托的URL会话的生命周期,提供URL会话操作中的每个步骤的完整观察。你应该参考这个部分来帮助你理解会话如何和它的委托交互。特别是,当每个委托方法被调用时的解释。
使用系统提供委托的URL会话的生命周期
如果你不提供委托对象的情况下使用NSURLSession类,系统提供的委托就会为你处理许多具体事宜。以下是app必须要执行的方法调用的基本顺序,以及当使用带有系统提供委托的NSURLSession的时候app接收到的完成处理程序调用:
- 创建会话配置。对于后台会话,该配置必须包含唯一的标识符。保存该标识符,如果app崩溃或者它被终止或挂起,使用该标识符来从新关联会话。
- 创建会话,指定配置对象,委托为nil。
- 在会话中创建任务对象,每个会话代表一个请求。当app调用任务的resum方法,它开始下载指定的资源。任务对象是NSURLSessionTask—NSURLSessionDataTask, NSURLSessionUploadTask, 或 NSURLSessionDownloadTask,的子类,具体取决于你尝试的实现的行为。
尽管app可以(通常也应该)在一个会话中添加多个任务,为了简单起见,剩下的步骤是以单个任务来描述生命周期。Although your app can (and typically should) add more than one task to a session, for simplicity, the remaining steps describe the life cycle in terms of a single task.
重要:如果你在没有提供委托的情况下使用NSURLSession类,app必须使用一个使用completionHandler参数的调用来创建任务,否则它不能从该类获取数据。Important: If you are using the NSURLSession class without providing delegates, your app must create tasks using a call that takes a completionHandler parameter, because otherwise it cannot obtain data from the class.
- 对于下载任务,在从服务器传输期间,如果用户告诉app暂停下载,通过调用cancelByProducingResumeData:方法来取消任务。之后,传递返回的恢复数据给downloadTaskWithResumeData: 或 downloadTaskWithResumeData:completionHandler:方法来创建新的下载任务来继续下载。
- 当任务完成的时候,NSURLSession对象调用该任务的完成处理程序。
注意:NSURLSession不会通过error参数报考服务器的错误。这个错误只接收客户端的错误,例如不能解析主机名或者不能连接主机。该error代码在URL加载系统错误代码(URL Loading System Error Codes)中描述。服务器端的错误通过在NSHTTPURLResponse对象中的HTTP状态码来报告。更多详情,请阅读NSHTTPURLResponse 和 NSURLResponse类的文档。
- 当app不再需要会话的时候,通过调用invalidateAndCancel (以取消未完成的任务) 或 finishTasksAndInvalidate(以使未完成的任务在使之无效之前完成)来使它无效。
使用自定义委托的URL会话的生命周期
你可以经常使用不带有委托的NSURLSession API。但是,如果你要把NSURLSession API用于后台的下载和上传,或者你需要处理验证或以非默认的方式处理缓存,你必须提供最受某些委托协议的委托,这些委托协议包括会话委托协议、一个或多个任务委托协议、或者是一些协议的混合。委托有很多用途:
- 当使用下载任务时,NSURLSession对象使用委托来向app提供可以获取下载数据的文件URL。所有的后台下载和上传都要求有委托。这些委托必须提供所有NSURLSessionDownloadDelegate协议中的委托方法。
- 委托可以处理某些验证挑战。
- 委托可以为上传基于流的数据提供body流,以上传到远程服务器。
- 委托可以决定是否采用HTTP的重定向。
- NSURLSession对象使用委托来给app提供每次传输的状态。数据任务委托可以接收初始调用(你可以将请求转换为下载)和后继调用(提供从远程服务器接收到的数据片段)。
- 委托是NSURLSession对象告诉app何时传输完成的一种方式。
如果你使用具有URL会话(后台任务所需的)的自定义委托,URL会话的完整生命周期会更加复杂。以下是方法调用和委托调用的基本顺序,这里的方法是app必须制作的,而这里的委托是在使用具有自定义委托的NSURLSession时app接收到的。
- 创建会话配置。对于后台会话,配置必须包含唯一标识符。存储该标识符,如果app鹏辉或终止或挂起了,可以使用它重新和该会话进行关联。
- 创建会话,指定配置对象和委托(可选)。
- 在会话中创建任务对象,它们每个都代表一个资源请求。每个任务都从挂起状态开始。在app调用任务的resume方法之后,它开始下载指定的资源。该任务对象是 NSURLSessionTask—NSURLSessionDataTask, NSURLSessionUploadTask, 或 NSURLSessionDownloadTask的子类,具体是哪个类的子类要依据你正才尝试实现的行为。
尽管app可以添加多个任务到会话,但为了简单起见,剩余的步骤只描述单一任务的生命周期。 - 如果远程服务器返回的状态码表示需要验证,并且如果验证请求是连接级别的口令盘问(例如SSL客户端证书),NSURLSession会调用一个验证口令盘问委托方法。
- 对于会话级别的口令盘问(challenge)—— NSURLAuthenticationMethodNTLM, NSURLAuthenticationMethodNegotiate, NSURLAuthenticationMethodClientCertificate, 或 NSURLAuthenticationMethodServerTrust ——,NSURLSession对象调用会话委托的URLSession:didReceiveChallenge:completionHandler:方法。如果app不提供会话委托方法,NSURLSession对象调用任务委托的URLSession:task:didReceiveChallenge:completionHandler:方法来处理口令盘问。
- 对于非会话级别的口令盘问(其他所有),NSURLSession对象调用会话委托的URLSession:task:didReceiveChallenge:completionHandler:方法来处理口令盘问。如果app提供会话委托,并且你需要处理验证,你必须在任务级别处理验证,或者提供任务级别处理(明确的调用每个会话处理器程序)。对于非会话级别的口令潘薇,会话委托的URLSession:didReceiveChallenge:completionHandler:方法不会被调用。
注意:Kerberos口令验证会被显式处理。
如果上传任务验证失败,且如果该任务的数据是通过数据流提供的,NSURLSession对象会调用委托的URLSession:task:needNewBodyStream:方法。该委托必须提供新的NSInputStream对象来给新请求提供body数据。更多关于为NSURLSession编写验证委托方法的信息,请阅读Authentication Challenges and TLS Chain Validation。
- 在接收到HTTP重定向的响应后,NSURLSession对象会调用委托的URLSession:task:willPerformHTTPRedirection:newRequest:completionHandler:方法。该委托方法调用提供的完成处理程序,该处理程序使用提供的NSURLRequest对象(对于遵行重定向的),或一个新的NSURLRequest对象(对于重定向到不同URL的),或者nil(把该重定向的响应体做为有效响应,并把它作为结果返回)。
- 如果遵循重定向,返回到第4部(验证口令盘问处理)。
- 如果委托没有实现该方法,重定向将遵循最大重定向次数进行。
- 对于一个通过调用downloadTaskWithResumeData: 或 downloadTaskWithResumeData:completionHandler:方法创建的(重)下载任务,NSURLSession使用该新的对象调用委托的URLSession:downloadTask:didResumeAtOffset:expectedTotalBytes:方法。
- 对于数据任务,NSURLSession对象会调用委托的URLSession:dataTask:didReceiveResponse:completionHandler:方法。先决定是否将数据任务转换成下载任务,然后调用完成回调来继续接收数据或下载数据。如果app选择将数据任务转换成下载任务,NSURLSession要使用新的下载任务来调用委托的URLSession:dataTask:didBecomeDownloadTask:方法。在该调用之后,委托不会从数据任务接收进一步回调,并且开始接收来自下载任务的回调。
- 如果任务是使用uploadTaskWithStreamedRequest:被创建的,NSURLSession调用委托的URLSession:task:needNewBodyStream:方法来提供body数据。
- 在将body内容上传到服务器期间(如果适用),委托会定期收到URLSession:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:回调,它报告了上传的进度。
- 在从服务器传输期间,任务委托会定期收到回调了报告传输的进度。对于下载任务,这个会话使用成功写人磁盘的字节数来调用委托的URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:方法。对于数据任务,该会话会使用真实接收到的数据来调用委托的URLSession:dataTask:didReceiveData:方法。对于下载任务,在从服务器传输期间,如果用户暂停了下载,通过调用cancelByProducingResumeData:方法来取消任务。之后,如果用户要求app恢复下载,传递返回的恢复数据给downloadTaskWithResumeData: 或 downloadTaskWithResumeData:completionHandler:方法,来创建一个新的下载任务来继续下载,然后回到第三步(创建并恢复任务对象)。
- 对于数据任务,NSURLSession对象调用委托的URLSession:dataTask:willCacheResponse:completionHandler:方法。随后app应该决定是否允许缓存。如果你不实现这个方法,默认的行为是使用在会话的配置对象中指定的缓存策略。
- 如果下载任务成功完成,NSURLSession对象会使用临时文件的位置来调用任务的URLSession:downloadTask:didFinishDownloadingToURL:方法。App必须从该文件读取响应数据,或者在该委托返回之前,将它移动到app沙盒相应目录中的永久性位置。
- 当任何任务完成,NSURLSession对象使用error对象或nil(如果任务成功完成)来调用委托的URLSession:task:didCompleteWithError:方法。rg任务失败,大多数app应该重试请求直到用户取消下载或服务器返回一个错误表示该请求不会成功。但是,App不应该马上重试。而是应该使用可达性API来确定服务器是否是可达的,应该在它接收到可达性改变了通知的时候创建一个新的请求。
如果下载任务能够恢复,NSError对象的userInfo字典会包含NSURLSessionDownloadTaskResumeData键的值。App应该把这个值传递给调用的downloadTaskWithResumeData: 或 downloadTaskWithResumeData:completionHandler:方法,来创建新的下载任务,以便继续已有的下载。
如果任务没有被恢复,app应该创建一个新的下载任务,从头开始传输。
在任一情况下,如果由于服务器错误以外的原因导致的传输失败,回到第三步(创建和恢复任务对象)。
注意:NSURLSession不通过error参数来报告服务器错误。通过error参数传递的只是你的委托接收的客户端的错误,例如不能解析主机名或者不能连接主机。该error代码在URL Loading System Error Codes中被描述,
服务器端的错误通过在NSHTTPURLResponse对象中的HTTP状态来报告。更多信息,请阅读NSHTTPURLResponse 和 NSURLResponse类的文档。
- 如果响应是多重编码的,会话可以再次调用委托的didReceiveResponse方法,然后是零个或多个额外的didReceiveData调用。如果发生了这中情况,回调第七步(处理didReceiveResponse的调用)。
- 当你不再需要会话的时候,通过调用invalidateAndCancel (取消未完成的任务) 或 finishTasksAndInvalidate(允许未完成的任务在该对象无效之前完成)来使其无效。在无效化该会话之后,当所有未完成的任务已经被取消,或者已经完成,该会话发送给委托一个URLSession:didBecomeInvalidWithError:消息,当该委托方法返回时,该会话会清除该委托的强引用。
重要:会话对象保持委托的强引用,直到app明确的使该会话无效了。如果你不对会话进行无效化处理,app会发生内存泄漏。
如果app取消在进程中的下载,NSURLSession对象会调用委托的URLSession:task:didCompleteWithError:方法,就像发生了错误一样。