iOS NSURLSession 之 background session

Posted on Edited on

之前有需求需要用到 NSURLSession 的 background session 特性，所以对其做了一波研究并记录下来。主要针对在不同场景下的相关接口回调顺序做些总结。

一、完全挂起场景

在app完全挂起时（调用exit(0)可以保证后台完全挂起），如果仍有background session未完成，当session 的所有task完成下载时（不管成功或失败），系统会先唤起app，并调用 appDelegate 的 

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

然后调用以下方法通知系统处理完成。

- (void)application:(UIApplication *)application handleEventsForBackgroundURLSession:(NSString *)identifier completionHandler:(void (^)())completionHandler

在该方法中，通常做法是 根据identifier 创建一个和前台下载时相同配置的background session，并且赋值delegate，这样NSURLSession的一些下载回调才会被调起。同时缓存 completionHandler ，在确认处理已经结束后，调用 completionHandler 以通知系统完成操作。

- (void)application:(UIApplication *)application handleEventsForBackgroundURLSession:(NSString *)identifier completionHandler:(void (^)())completionHandler {
    // 你必须重新建立一个后台 seesion 的实例
    // 否则 NSURLSessionDownloadDelegate 和 NSURLSessionDelegate 方法会因为
    // 没有 对 session 的 delegate 设定而不会被调用。参见上面的 backgroundURLSession
    NSURLSession *backgroundSession = [self backgroundURLSession];
    
    NSLog(@"handleEventsForBackgroundURLSession Rejoining session with identifier %@ %@", identifier, backgroundSession);
    
    // 保存 completion handler 以在处理 session 事件后更新 UI
    [self addCompletionHandler:completionHandler forSession:identifier];
}

下载时 delegate 回调的顺序：

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location;

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error;

// app 在前台时不会回调该方法
- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession *)session;

通常可以在 - (void)URLSessionDidFinishEventsForBackgroundURLSession: 调用 -(void)application: handleEventsForBackgroundURLSession: completionHandler: 返回的completionHandler通知系统处理完成。

当app 本身在前台时，**- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession )session* 不会被回调。

运行日志如下：

二、退后台未挂起时

退后台未挂起时，下载完成时，不再调用 **- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions**， 而会直接调用以下方法通知下载成功，并根据 identifier 对应的session delegate 调用相关回调。

- (void)application:(UIApplication *)application handleEventsForBackgroundURLSession:(NSString *)identifier completionHandler:(void (^)())completionHandler

未完全挂起时，app 可能持有 identifier 对应的 session 实例，此时若不设置session 的delegate，系统会根据session 当前的 delegate 回调相关方法。但是为了防止混乱，建议使用同一个delegate对象。
回调的方法顺序和 完全挂起场景 保持一致，详细如下：

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location;

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error;

// app 在前台时不会回调该方法
- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession *)session;

注意退后台时仍会收到一些进度回调，但是回调进度并不准确，可以用来刷新UI，所以不能当作判断依据。

运行日志如下：

三、 退后台未挂起未下载完成时再进前台

未挂起时，再进前台，会正常收到进度及完成回调，不会收到 -(void)application: handleEventsForBackgroundURLSession: completionHandler: 和 - (void)URLSessionDidFinishEventsForBackgroundURLSession: 回调。

回调顺序如下：

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite;

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location;

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error;

运行日志如下：

四、退后台挂起时未下载完成再进前台

挂起后，再唤起app进前台，此时若通过identifier 创建相同configure的background session，会跟进session 的delegate正常收到进度及完成回调，完成时不会收到 -(void)application: handleEventsForBackgroundURLSession: completionHandler: 和 -(void)URLSessionDidFinishEventsForBackgroundURLSession: 回调。

运行日志如下：

五、手动杀进程时

用户手动杀进程时，background session 会被系统取消，handleEventsForBackgroundURLSession 不再回调。
当再次唤起app时，会根据 identifier 对应的session delegate 回调 - (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error ，error 为 -999 失败。

运行日志：

其他问题

  1. 在退后台或者挂起时，下载失败，可以使用相同的identifier 创建background session 重试。重试时下载完成（失败或者成功），根据当前app状态进入上述对应流程。
  2. application:handleEventsForBackgroundURLSession:completionHandler: 的completionHandler必须在主线程中调用。

参考资料：
Downloading Files in the Background
NSURLSession upload task with background session
[iOS] Unzip in URLSessionDidFinishEventsForBackgroundURLSession
NSURLSession 拾遗
NSURLSession
iOS 后台下载及管理库
YCDownloadSession
iOS Background Tasks
NSURLSession使用说明及后台工作流程分析
iOS使用NSURLSession进行下载
NSURLSession’s Resume Rate Limiter