Alamofire断点续传

当我们下载文件时,暂停,继续,取消和断点续传以及失败处理都是必不可少的. 那么我们使用 Alamofire 当然必须要知道应该如何处理.

一 . 单例封装下载管理者

import UIKit
import Alamofire

class LBDowloadManager: NSObject {
    static let shared = LBDowloadManager()
    var currentDownloadRequest: DownloadRequest?
    var resumeData: Data?
    var downloadTasks: Array<URLSessionDownloadTask>?
    var filePath: URL{
        return FileManager.default.urls(for: .documentDirectory, in: FileManager.SearchPathDomainMask.userDomainMask).first!.appendingPathComponent("LBDownload")
    }
    
    
    //MARK: - 单利方便获取
    let manager: SessionManager = {
        let configuration = URLSessionConfiguration.background(withIdentifier: "LB.AlamofireDowload")
        configuration.httpAdditionalHeaders = SessionManager.defaultHTTPHeaders
        configuration.sharedContainerIdentifier = "group.com.LB.AlamofireDowload"
        let manager = SessionManager(configuration: configuration)
        manager.startRequestsImmediately = true
        manager.backgroundCompletionHandler = {
            debugPrint("后台完成回来了")
        }
        return manager
    }()

开始下载

func LBDowload(_ url: URLConvertible) -> DownloadRequest {
    currentDownloadRequest = LBDowloadManager.shared.manager.download(url) { [weak self](url, reponse) -> (destinationURL: URL, options: DownloadRequest.DownloadOptions) in
        let fileUrl = self?.filePath.appendingPathComponent(reponse.suggestedFilename!)
        return (fileUrl!,[.removePreviousFile, .createIntermediateDirectories] )
    }
    return currentDownloadRequest!
}

暂停

func suspend() {
    self.currentDownloadRequest?.suspend()
}

对应的是父类 Request的 suspend 方法.

open func suspend() {
    guard let task = task else { return }

    task.suspend()

    NotificationCenter.default.post(
        name: Notification.Name.Task.DidSuspend,
        object: self,
        userInfo: [Notification.Key.Task: task]
    )
}

继续

func resume() {
    self.currentDownloadRequest?.resume()
}

对应的是父类 Request的 resume 方法.

open func resume() {
    guard let task = task else { delegate.queue.isSuspended = false ; return }

    if startTime == nil { startTime = CFAbsoluteTimeGetCurrent() }

    task.resume()

    NotificationCenter.default.post(
        name: Notification.Name.Task.DidResume,
        object: self,
        userInfo: [Notification.Key.Task: task]
    )
}

取消

func cancel() {
    self.currentDownloadRequest?.cancel()
}

这里调用的不再是父类 Request的 cancel 方法. 因为子类 DownloadRequest 重写了这个方法.

/// Cancels the request.
open override func cancel() {
    downloadDelegate.downloadTask.cancel { self.downloadDelegate.resumeData = $0 }

    NotificationCenter.default.post(
        name: Notification.Name.Task.DidCancel,
        object: self,
        userInfo: [Notification.Key.Task: task as Any]
    )
}

它自动保存了 resumeData.

这个 resumeData 到底是什么, 有兴趣的同学可以开始任务后暂停, 获取一下这个 resumeData, 把其写入到沙盒中, 然后后缀改为 .plist . 然后直接打开查看. 其实里面包含了所有信息, 包括总大小, 已下载数据情况, 下载链接. 等等. 也就是说我们可以根据这个 resumeData 给一个新任务去继续下载之前的任务.

那么我们在取消之后希望继续下载, 保持以前的进度. 则需要在开始方法中增加如下处理.

func LBDowload(_ url: URLConvertible) -> DownloadRequest {
    
     if let resumeData = LBDowloadManager.shared.currentDownloadRequest?.resumeData {
         currentDownloadRequest = LBDowloadManager.shared.manager.download(resumingWith: resumeData)
     }else{
         currentDownloadRequest = LBDowloadManager.shared.manager.download(url) { [weak self](url, reponse) -> (destinationURL: URL, options: DownloadRequest.DownloadOptions) in
             let fileUrl = self?.filePath.appendingPathComponent(reponse.suggestedFilename!)
             return (fileUrl!,[.removePreviousFile, .createIntermediateDirectories] )
         }
     }

    return currentDownloadRequest!
}

即,当 DownloadRequest 有对应的恢复数据时, 则拿到这个数据继续下载.

清理沙盒中数据

func clear() {
    let filePath = NSHomeDirectory()+"/Documents/LBDownload"
    if FileManager.default.fileExists(atPath: filePath) {
        try! FileManager.default.removeItem(at: self.filePath)
        print("清理完成")
    }
}

二 . 用户杀死APP 重新打开续传

当我们实际在下载中关闭app, 然后重新打开操作时, 通过在 TaskDelegate 的 taskDidCompleteWithError 回调代理的断点发现, 它会触发.

那么你想到了什么, 是的,我们在外部自己指定回调触发事件. 这个 request 的流程 , 启动 -> 响应 -> 回调. 不熟悉的可以去阅读一下
Alamofire之Request(二)和队列执行顺序分析
Alamofire之Request(一)

那么我们在单例 manager 中, 增加一个 taskDidComplete 的监听闭包.

// 用户主动关闭app 再重新进来时会触发.
manager.delegate.taskDidComplete = { (seesion,task, error) in
    if let error = error {
        print("taskDidComplete的error情况: \(error)")
        if let resumeData = (error as NSError).userInfo[NSURLSessionDownloadTaskResumeData] as? Data {
            // resumeData 存储
            LBDowloadManager.shared.resumeData = resumeData
            print("来了")
        }
    }else{
        print("taskDidComplete的task情况: \(task)")
    }
}

这里要提一句的是 如何获取已下载的数据 ResumeData. 是通过闭包中返回的 Error 转换成 NSError 中的 userInfo 参数里面获取到的.

那么拿到了 ResumeData, 就好办了. 在开始下载的按钮方法中再增加一个处理

func LBDowload(_ url: URLConvertible) -> DownloadRequest {
    
    if self.resumeData != nil {
        //用户主动关闭 再次打开续传
        currentDownloadRequest = LBDowloadManager.shared.manager.download(resumingWith: self.resumeData!)
    }else{
        if let resumeData = LBDowloadManager.shared.currentDownloadRequest?.resumeData {
            // 用户取消后续传
            currentDownloadRequest = LBDowloadManager.shared.manager.download(resumingWith: resumeData)
        }else{
            //正常开启新任务
            currentDownloadRequest = LBDowloadManager.shared.manager.download(url) { [weak self](url, reponse) -> (destinationURL: URL, options: DownloadRequest.DownloadOptions) in
                let fileUrl = self?.filePath.appendingPathComponent(reponse.suggestedFilename!)
                return (fileUrl!,[.removePreviousFile, .createIntermediateDirectories] )
            }
        }
    }
    return currentDownloadRequest!
}

至此, 主动关闭 APP , 再次打开实现续传就完成了. 那么如果是应用发生闪退呢?

三 . 应用程序发生闪退续传.

通过实验验证发现其实 URLSessionDownloadTask 在程序发生闪退时, 其实还是会继续下载的. 也就是说, 任务不会因为闪退而终止. 那么就不存在续传的问题了.
那么我们如何获取到下载的文件呢?

我们同样新增了一个回调 downloadTaskDidFinishDownloadingToURL , 那么我们来实际操作验证一下.

• 首先在 VC 中创造一个数组越界以便崩溃.

override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
    let array = [1]
    print(array[2])
}

• 然后 manager 增加下载完成回调响应

manager.delegate.downloadTaskDidFinishDownloadingToURL = { (session, downloadTask, url) in

    guard let response = downloadTask.response as? HTTPURLResponse else {return}

    let fileUrl = LBDowloadManager.shared.filePath.appendingPathComponent(response.suggestedFilename!)
    print("转移路径:\(fileUrl)")
    do {
        if FileManager.default.fileExists(atPath: fileUrl.path) {
            try FileManager.default.removeItem(at: fileUrl)
        }
        let directory = fileUrl.deletingLastPathComponent()
        try FileManager.default.createDirectory(at: directory, withIntermediateDirectories: true)

        try FileManager.default.moveItem(at: url, to: fileUrl)
        print("文件移动成功")
    } catch {
        print("文件移动出错了 \(error)")
    }
}

从新任务开始下载, 快下载完成, 点击屏幕, 闪退, 然后重新运行, 等待一会儿发现:

来了! . 看下控制台 以及沙盒文件.

• 完美. 程序 crash 获取下载文件.