URLSession 下载任务暂停和继续

下载任务的暂停和继续在网络请求中是一个常见需求,尤其在处理大文件或者长时间下载时。在 iOS 中,URLSession 提供了支持暂停和继续下载的机制,称为 后台下载任务

虽然上述的线程池设计可以用来调度任务并控制任务的暂停/继续,但网络请求的暂停和继续需要结合 URLSessiondownloadTask(with:)resume() / suspend() 方法来实现。

我们可以使用 URLSession 来创建一个下载任务,利用其支持的暂停和恢复功能,来实现下载任务的暂停和继续。

1. 使用 URLSession 实现下载暂停和继续

要支持下载任务的暂停和继续,我们需要:

  • 创建一个 URLSessionDownloadTask
  • 使用 suspend() 方法暂停下载,使用 resume() 方法继续下载。
  • 维护任务的状态,比如当前的下载进度,以便在恢复下载时可以从上次暂停的地方继续。

2. 示例实现

下面是一个基于 URLSession 的下载器实现,可以暂停、继续和取消下载任务:

import Foundation

/// 下载器
class ImageDownloader: NSObject, URLSessionDownloadDelegate {
    
    private var downloadTask: URLSessionDownloadTask?
    private var urlSession: URLSession!
    private var resumeData: Data? // 用于恢复下载的数据
    private var isDownloading = false
    private var taskId: UUID?
    
    override init() {
        super.init()
        
        // 创建 URLSession 配置并设置下载代理
        let configuration = URLSessionConfiguration.default
        urlSession = URLSession(configuration: configuration, delegate: self, delegateQueue: nil)
    }
    
    /// 开始下载图片
    func startDownload(from url: URL, completion: @escaping (UIImage?) -> Void) -> UUID {
        let taskId = UUID() // 为每个任务生成唯一的 ID
        self.taskId = taskId
        
        // 创建下载任务
        downloadTask = urlSession.downloadTask(with: url)
        
        // 开始下载
        downloadTask?.resume()
        isDownloading = true
        
        return taskId
    }
    
    /// 暂停下载
    func pauseDownload() {
        downloadTask?.suspend()
        isDownloading = false
    }
    
    /// 继续下载
    func resumeDownload() {
        if let resumeData = resumeData {
            // 恢复下载任务
            downloadTask = urlSession.downloadTask(withResumeData: resumeData)
            downloadTask?.resume()
            isDownloading = true
        } else {
            // 如果没有保存的暂停数据,重新开始下载
            downloadTask?.resume()
            isDownloading = true
        }
    }
    
    /// 取消下载
    func cancelDownload() {
        downloadTask?.cancel()
        isDownloading = false
    }
    
    // URLSessionDownloadDelegate 方法:处理下载进度和完成
    func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL) {
        guard let taskId = taskId else { return }
        // 下载完成后的处理
        DispatchQueue.main.async {
            if let data = try? Data(contentsOf: location), let image = UIImage(data: data) {
                print("Download completed for task \(taskId)")
                // 调用 UI 更新代码
            } else {
                print("Download failed for task \(taskId)")
            }
        }
    }
    
    // 下载进度更新
    func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didWriteData bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64) {
        let progress = Float(totalBytesWritten) / Float(totalBytesExpectedToWrite)
        print("Download progress: \(progress * 100)%")
    }
    
    // 下载暂停/恢复
    func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didResumeAtOffset fileOffset: Int64, expectedTotalBytes: Int64) {
        print("Download resumed at offset \(fileOffset) of total \(expectedTotalBytes) bytes")
    }
    
    // 保存暂停数据
    func urlSession(_ session: URLSession, task: URLSessionTask, didReceive resumeData: Data) {
        self.resumeData = resumeData
    }
}

3. 使用示例

let imageDownloader = ImageDownloader()

// 图片 URL 示例
let url = URL(string: "https://example.com/largeimage.jpg")!

// 开始下载并获取任务 ID
let taskId = imageDownloader.startDownload(from: url) { image in
    if let image = image {
        print("Image downloaded successfully!")
    } else {
        print("Failed to download image.")
    }
}

// 暂停下载
imageDownloader.pauseDownload()

// 继续下载
imageDownloader.resumeDownload()

// 取消下载
imageDownloader.cancelDownload()

关键点:

  1. 暂停和恢复:通过 URLSessionDownloadTasksuspend()resume() 方法,可以控制下载任务的暂停和恢复。resumeData 用于存储暂停点的下载数据,并且可以通过 downloadTask(withResumeData:) 恢复下载任务。
  2. 下载进度URLSessionDownloadTask 提供了进度回调方法 didWriteData,我们可以通过 totalBytesWrittentotalBytesExpectedToWrite 来计算下载进度,并显示给用户。
  3. 任务管理:每个任务都有唯一的 taskId,用于标识任务,以便在后续操作(暂停、继续、取消)时使用。

4. 关于暂停和继续下载的注意事项:

  • 暂停和恢复时的恢复数据URLSessionDownloadTask 在暂停后会自动生成一个恢复数据(resumeData),这个数据是下载文件的断点信息。你需要存储这个数据,并在恢复时重新使用 downloadTask(withResumeData:) 方法。
  • 恢复点的有效性:并非所有下载任务都能顺利恢复。只有部分下载任务(比如通过 HTTP 协议下载)支持断点续传,对于不支持的协议或任务,可能需要重新开始下载。
  • 取消下载:通过 cancel() 方法,可以取消下载任务。取消后不会生成恢复数据,如果需要恢复,必须重新开始下载。

总结:

通过 URLSessionDownloadTask 的暂停和继续机制,我们可以很方便地在 iOS 中实现下载任务的暂停、继续和取消功能。使用 suspend()resume() 方法结合 resumeData,可以在下载中断后从上次停止的位置恢复下载,提供更好的用户体验。

结合《Swift 实现:三级下载队列》,是否可以实现优雅一点的预下载呢?
https://www.jianshu.com/p/82e88ffb1e67

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

推荐阅读更多精彩内容