Alamofire后台下载

最近在使用Alamofire 后台下载时遇到一个问题, 正在下载任务的程序退出到后台再回到前台UI没有刷新.

为了方便研究,单独写一个Demo:

image.png

demo功能很简单,点击按钮开始下载资源, 进度条显示进度. 为了方便描述,核心逻辑都在 "开始下载"按钮点击事件中.

@IBAction func donwload(_ sender: UIButton) {
        
        NetWorkAPI.shared.manager
            .download(self.urlDownloadStrMP4) { (url, response) -> (destinationURL: URL, options: DownloadRequest.DownloadOptions) in
                let documentUrl = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first
                let fileUrl     = documentUrl?.appendingPathComponent(response.suggestedFilename!)
                return (fileUrl!,[.removePreviousFile,.createIntermediateDirectories])
            }
            .response { (downloadResponse) in
                print("下载回调信息: \(downloadResponse)")
            }
            .downloadProgress { [weak self](progress) in
                print("下载进度 : \(progress)")
                let scale = Float(progress.completedUnitCount) / Float(progress.totalUnitCount);
                self?.progress
                    .setProgress(scale, animated: true)
                sender.isEnabled = scale > 0.999999
        }
        
    
    }

因为要进行后台下载,所以NetworkAPI.shared.manager 返回的是一个用 background 模式 URLSessionConfiguration,创建的 SessionManager.
点击按钮开始下载,并且退到后台一段时间:

image.png
从后台返回:
image.png
可以看到进度条进度明显变化了.
咦?貌似没问题,再试一下,这次在后台状态下等待程序下载完成
这次等待在后台打印了信息:
image.png
说明数据已经下载完成了.回到前台看看UI 情况.
image.png
哇,找到原因了,

问题分析:通过两次的现象可知,再回到前台时,分两种情况:
1.下载任务没有完成: 这个时候由于会继续调用 downloadProgress 闭包,故UI得到了刷新
2.下载任务已经在后台完成: 程序在后台是 downloadProgress 是不会被调用的,但是刚才通过看日志信息, response 回调确实在后台被调用了, 所以在resonpose闭包中 在刷新下UI 是不是可以解决?
修改代码:

@IBAction func donwload(_ sender: UIButton) {
        
        NetWorkAPI.shared.manager
            .download(self.urlDownloadStrMP4) { (url, response) -> (destinationURL: URL, options: DownloadRequest.DownloadOptions) in
                let documentUrl = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first
                let fileUrl     = documentUrl?.appendingPathComponent(response.suggestedFilename!)
                return (fileUrl!,[.removePreviousFile,.createIntermediateDirectories])
            }
            .response { [weak self] (downloadResponse) in
               print("下载回调信息: \(downloadResponse)")

                if downloadResponse.error != nil {
                    self?.progress.setProgress(0.0, animated: true)
                    sender.setTitle("发生了错误,点击重新下载", for:.normal)
                } else { //success
                    self?.progress.setProgress(1.0, animated: true)
                   sender.setTitle("下载完成", for: .normal)
                    sender.isUserInteractionEnabled = false
                }
                sender.isEnabled = true
            }
            .downloadProgress { [weak self] (progress) in
                print("下载进度 : \(progress)")
                let scale = Float(progress.completedUnitCount) / Float(progress.totalUnitCount);
                self?.progress
                    .setProgress(scale, animated: true)
              
        }
        
    
    }

等待下载任务在后台完成后,返回前台:

image.png

问题得到了解决! 控制台的一条信息引起了我的注意:

image.png

从中得知,有一个completion handler 没有被调用,点进去查看方法的说明,
不读不知道,一读吓一跳.关于方法

func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void

的官方文档,感兴趣的同学可以去阅读英文原版.这里是我的理解

1.后台下载时,无论任务成功还是失败,或者需要身份认证时,系统都会调用这个方法.
2.使用这个方法,重新连接URLSession, 来更新UI.
3.在应用程序被杀死后,后台下载的session 会继续下载任务,当任务完成或者失败后,系统会在后台启动APP,以便让应用程序处理事件. 在这种情况下,需要使用系统提供的 identifier 创建
URLSessionConfiguration 和 URLSession. 然后用之前下载或上传时的配置来配置URLSession. 然后URLSession会调用委托来处理相关的事件.
4.如果正在运行或者挂起的应用程序已经有了 指定的 identifier 的session 对象,那么就不需要创建新的session 对象, 挂起的app 进入后台,当程序再次运行时, 带有 identifier 的 session 对象就会继续接收事件,并处理.
5.在应用程序启动时,如果有之前的上传或者下载任务没有完成(例如断网或者其它错误). 则 这个方法不会被调用,如果要在app 界面上表示之前的进度,则必须重新创建 session 对象, 在这种情况下, 需要持久化保存 identifier, 并使用它重新创建session 对象.

本篇的情况,应用程序在后台没有被杀死,并且任务在后台下载完成的情况,故此时的 SessionManager 管理的对象依然还在.
但是, Alamofire如何调用 系统的 completionHandler呢?
Alamofire 的SessionManager 已经为我们提供了属性

open var backgroundCompletionHandler: (() -> Void)?

所以方法实现是:

 func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void) {
       NetWorkAPI.shared.manager.backgroundCompletionHandler = completionHandler
    }

重新测试,问题解决.警告也消失了
后台下载的情况还是比较复杂的.在这个过程中涉及系统与app的交互,还有官方文档中提到的几种情况没有模拟:
1.App存在于后台,此时下载失败.(这个应该和成功时处理差不多)
2.后台下载成功,此时App已经被杀死
3.后台下载失败,此时App已经被杀死

对于情况2和3,目前还不知道该如何模拟,如果有同学知道好的模拟办法,欢迎留言讨论~