当前位置: > > > Swift - HTTP网络操作库Alamofire使用详解3(文件下载,断点续传)

Swift - HTTP网络操作库Alamofire使用详解3(文件下载,断点续传)

相关文章系列:(文章代码均已升级至Swift3)
Swift - HTTP网络操作库Alamofire使用详解1(配置,以及数据请求)
Swift - HTTP网络操作库Alamofire使用详解2(文件上传)
[当前文章] Swift - HTTP网络操作库Alamofire使用详解3(文件下载,断点续传)
Swift - HTTP网络操作库Alamofire使用详解4(用户权限认证)


七,使用Alamofire进行文件下载

1,自定义下载文件的保存目录
下面代码将logo图片下载下来保存到用户文档目录下(Documnets目录),文件名不变。
//指定下载路径(文件名不变)
let destination: DownloadRequest.DownloadFileDestination = { _, response in
    let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
    let fileURL = documentsURL.appendingPathComponent(response.suggestedFilename!)
    //两个参数表示如果有同名文件则会覆盖,如果路径中文件夹不存在则会自动创建
    return (fileURL, [.removePreviousFile, .createIntermediateDirectories])
}

//开始下载
Alamofire.download("http://www.hangge.com/blog/images/logo.png", to: destination)
    .response { response in
        print(response)
        
        if let imagePath = response.destinationURL?.path {
            let image = UIImage(contentsOfFile: imagePath)
        }
    }
}
将logo图片下载下来保存到用户文档目录下的file1子目录(Documnets/file1目录),文件名改成myLogo.png。
//指定下载路径和保存文件名
let destination: DownloadRequest.DownloadFileDestination = { _, _ in
    let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
    let fileURL = documentsURL.appendingPathComponent("file1/myLogo.png")
    //两个参数表示如果有同名文件则会覆盖,如果路径中文件夹不存在则会自动创建
    return (fileURL, [.removePreviousFile, .createIntermediateDirectories])
}

//开始下载
Alamofire.download("http://www.hangge.com/blog/images/logo.png", to: destination)
    .response { response in
        print(response)
        
        if let imagePath = response.destinationURL?.path {
            let image = UIImage(contentsOfFile: imagePath)
        }
    }
}

2,使用默认提供的下载路径
Alamofire内置的许多常用的下载路径方便我们使用,简化代码。注意的是,使用这种方式如果下载路径下有同名文件,不会覆盖原来的文件。
比如,下载到用户文档目录下可以改成:
let destination = DownloadRequest.suggestedDownloadDestination(for: .documentDirectory)
Alamofire.download("http://www.hangge.com/blog/images/logo.png", to: destination)

3,下载时附带请求参数

如果下载文件时需要传递一些参数,我们可以将参数拼接在 url 后面。也可以配置在 download 方法里的 parameters 参数中(其实这个方式最终也是拼接到 url 后面)。
//下面这两种方式效果是一样的
Alamofire.download("http://www.hangge.com/blog/images/logo.png?foo=bar", to: destination)
Alamofire.download("http://www.hangge.com/blog/images/logo.png", parameters: ["foo": "bar"],
                   to: destination)

4,下载进度
(1)下面代码在文件下载过程中会不断地打印下载进度,同时下载完成后也会打印完成信息。
Alamofire.download("http://www.hangge.com/favicon.ico", to: destination)
    .downloadProgress { progress in
        print("当前进度: \(progress.fractionCompleted)")
    }
    .responseData { response in
        if let data = response.result.value {
            print("下载完毕!")
            let image = UIImage(data: data)
        }
    }
(2)下载的过程中我们也可以得到已下载部分的大小,以及文件总大小。(单位都是字节)
Alamofire.download("http://www.hangge.com/favicon.ico", to: destination)
    .downloadProgress { progress in
        print("已下载:\(progress.completedUnitCount/1024)KB")
        print("总大小:\(progress.totalUnitCount/1024)KB")
    }
    .responseData { response in
        if let data = response.result.value {
            print("下载完毕!")
            let image = UIImage(data: data)
        }
}

5,断点续传(Resume Data) 
当下载过程中被意外停止时,可以在响应方法中把已下载的部分保存起来,下次再从断点继续下载。
下面通过样例演示如何断点续传:
(1)程序启动后自动开始下载文件
(2)点击“停止下载”,终止下载并把已下载的数据保存起来,进度条停止走动。
(3)点击“继续下载”,从上次终止的地方继续下载,进度条继续走动。
   
import UIKit
import Alamofire

class ViewController: UIViewController {
    
    //停止下载按钮
    @IBOutlet weak var stopBtn: UIButton!
    //继续下载按钮
    @IBOutlet weak var continueBtn: UIButton!
    //下载进度条
    @IBOutlet weak var progress: UIProgressView!
    
    //下载文件的保存路径(
    var destination:DownloadRequest.DownloadFileDestination!
    //用于停止下载时,保存已下载的部分
    var cancelledData: Data?
    
    //下载请求对象
    var downloadRequest: DownloadRequest!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        //设置下载路径。保存到用户文档目录,文件名不变,如果有同名文件则会覆盖
         self.destination = { _, response in
            let documentsURL = FileManager.default.urls(for: .documentDirectory,
                                                        in: .userDomainMask)[0]
            let fileURL = documentsURL.appendingPathComponent(response.suggestedFilename!)
            //两个参数表示如果有同名文件则会覆盖,如果路径中文件夹不存在则会自动创建
            return (fileURL, [.removePreviousFile, .createIntermediateDirectories])
        }
        
        //页面加载完毕就自动开始下载
        self.downloadRequest =  Alamofire.download(
            "http://dldir1.qq.com/qqfile/qq/QQ7.9/16621/QQ7.9.exe", to: destination)
        self.downloadRequest.downloadProgress(queue: DispatchQueue.main,
                                              closure: downloadProgress) //下载进度
        self.downloadRequest.responseData(completionHandler: downloadResponse) //下载停止响应
    }
    
    //下载过程中改变进度条
    
    func downloadProgress(progress: Progress) {
        //进度条更新
        self.progress.setProgress(Float(progress.fractionCompleted), animated:true)
        print("当前进度:\(progress.fractionCompleted*100)%")
    }
    
    
    //下载停止响应(不管成功或者失败)
    func downloadResponse(response: DownloadResponse<Data>) {
        switch response.result {
        case .success(let data):
            //self.image = UIImage(data: data)
            print("文件下载完毕: \(response)")
        case .failure:
            self.cancelledData = response.resumeData //意外终止的话,把已下载的数据储存起来
        }
    }
    
    //停止按钮点击
    @IBAction func stopBtnClick(_ sender: AnyObject) {
        self.downloadRequest?.cancel()
        self.stopBtn.isEnabled = false
        self.continueBtn.isEnabled = true
    }
    
    //继续按钮点击
    @IBAction func continueBtnClick(_ sender: AnyObject) {
        if let cancelledData = self.cancelledData {
            self.downloadRequest = Alamofire.download(resumingWith: cancelledData,
                                                      to: destination)
            self.downloadRequest.downloadProgress(queue: DispatchQueue.main,
                                                  closure: downloadProgress) //下载进度
            self.downloadRequest.responseData(completionHandler: downloadResponse) //下载停止响应
            self.stopBtn.isEnabled = true
            self.continueBtn.isEnabled = false
        }
    }
    
    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
    }
}
源码下载:
hangge_972.zip(2015-12-06)
hangge_972.zip(2016-09-23 Swift3最新版)
评论16
  • 16楼
    2017-12-11 10:38
    tangjiarao

    我想请教两个问题
    1.多次停止下载,再重新开始,resumedata并不能定位到原来的位置,好像是ios11出现的问题,这个怎么解决呢?
    2.如果退出程序,怎么获取resumeData? applicationWillTerminate这个方法是不能得到返回的resumedata

    站长回复

    1,多次停止、继续下载如果是iOS11的问题只能等Alamofire更新解决了。

    2,可以得到啊,你说的resumedata应该是样例里的cancelledData吧,退出时把它先保存到临时文件中,程序启动后再加载进来。

  • 15楼
    2017-11-02 16:29
    Hunter

    我也是这么写的,但是不知道为啥参数传不到后台~~~

    站长回复

    那就奇怪了,我测试过是没问题的。你拿个抓包工具抓取下请求,看看参数传过去了没有。

  • 14楼
    2017-10-24 11:39
    Hunter

    你好,Alamofire带参数下载文件要怎么写呢?
    貌似要用到这个方法:
    Alamofire.download(<#T##url: URLConvertible##URLConvertible#>, method: <#T##HTTPMethod#>, parameters: <#T##Parameters?#>, encoding: <#T##ParameterEncoding#>, headers: <#T##HTTPHeaders?#>, to: <#T##DownloadRequest.DownloadFileDestination?##DownloadRequest.DownloadFileDestination?##(URL, HTTPURLResponse) -> (destinationURL: URL, options: DownloadRequest.DownloadOptions)#>),请问这个方法要怎么用啊?

    站长回复

    我在文章中补充了相关内容,你可以再看下。

  • 13楼
    2017-09-13 08:55
    男人海洋

    谢谢分享

    站长回复

    不客气。

  • 12楼
    2017-08-29 15:21

    你好,我这有个问题描述下:我要下载的是一个pdf文件,后台给的下载url路径因为里面有中文,所以我用url.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)!给转换了,下载完成以后获取文件路径打开以后文档的名字也变成了被转码的符号名(就这样的:%E5%E6%A1%A3--2017.08.09),然后我用webview加载的时候NSURL.fileURL(withPath: path!)就会报错,请问这种情况整体来说怎么处理比较好呢?

    站长回复

    可以把下载文件保存的文件名指定为:时间戳.pdf。这样加载肯定不会有问题。

  • 11楼
    2017-08-20 07:57
    大拿

    这个太奇怪了,使用这个下载的文件,如果遍历下载目录的是可以看到的,但是 fileManager.fileExists(atPath: filePath)为false

    站长回复

    这个问题我倒没遇到过,不知道你那边是什么情况。

  • 10楼
    2017-08-19 18:36
    就真

    下载的文件并没有保存起来,是需要自己去保存吗?

    站长回复

    有保存的,文章里的代码我是保存到应用的用户文档目录中,你也可以修改成其它目录。

  • 9楼
    2017-03-27 17:59
    老王

    你好 能不能写个 退出app 回来再下载还是 这样的断点续传呢

    站长回复

    这个原理是一样的,文章中是通过点击按钮来停止或者继续下载。我们可以把这个逻辑写在在AppDelegate中相关方法中,比如进入后台或退出时停止当前下载任务,启动时又继续下载。

  • 8楼
    2017-03-14 15:55
    老顾

    你好,我断点下载一直成功不了:
    //下载停止响应(不管成功或者失败)
    func downloadResponse(response: DownloadResponse<Data>) {
    switch response.result {
    case .success(let data):
    //self.image = UIImage(data: data)
    print("文件下载完毕: \(response)")
    case .failure:
    self.cancelledData = response.resumeData //意外终止的话,把已下载的数据储存起来
    }
    }

    就是response.resumeData一直为nil,不知道为什么。。

    站长回复

    我又测试了下我上面提供的工程项目,可以断点下载的啊?

  • 7楼
    2016-12-27 15:27
    GV而我的号给我vgd

    站长怎么获取下载文件的大小呢?

    站长回复

    可以得到的,文章相关内容已更新,你可以再看下。

  • 6楼
    2016-07-20 09:52
    菜鸟程序员

    站长你好!怎样读取已经下载好的数据呢!以本demo为例!

    站长回复

    参考我原来写的这篇文章:Swift - 文件,文件夹操作大全

  • 5楼
    2016-04-04 21:26
    果啤

    hangge你的源码里没有Alamofire.xcodeproj 源码运行不了 而且按照你Alamofire使用详解1中引入alamofire的方法 还是提示没有Alamofire 并且现在从git上下载alamofire后选择alamofire.framework的时候有三个版本了 需要选择ios的版本 希望你补充一片引入alamofire的文章 多谢了

    站长回复

    为了让源码包体积小点,所以就没把Alamofire也一起打包进来。谢谢你的提醒与建议,我把Alamofire使用详解1文章再补充下。

  • 4楼
    2016-02-25 12:01
    zheng

    我想请问下 在样例1中,如何手动保存路径和文件名。因为刚接触到swift,公司要求做这个项目 有点急。比如我想把我的路径设置成 比如我想保存在他默认路径的子目录下的文件名(zheng)中,请问如何设置,谢谢了哈。情况有点急 麻烦您了哈。

    站长回复

    根据你的需求,我在样例1下面补充了相关样例代码,你可以看下。

  • 3楼
    2015-12-24 09:03
    aoxiaomi

    站长你好。请问通过【self.downloadRequest = Alamofire.download(.GET "http://www.baidu.com/favicon.ico", destination: destination)】下载,能否手动更改所下载的图片的文件名?谢谢!

    站长回复

    这种方式下载下来的文件名就是原始文件名,要修改的话只能下载完毕后在完成响应函数中修改(样例4中的downloadResponse()方法)
    如果想要在下载前就更改名字,只能像样例1那样手动设置保存路径和文件名。

  • 2楼
    2015-12-10 01:25
    这快显卡有点冷

    希望给博客添加RSS订阅

    站长回复

    近期可能没时间修改网站了。我先记下来,等后面网站改版时看看是否添加。

  • 1楼
    2015-12-09 15:43
    qiangai_001@163.com

    给力,加油站长!向你学习.

    站长回复

    谢谢鼓励,大家共同进步^_^