NSURLSession 之 background session

之前有需求需要用到 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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342