小程序开发API之下载wx.downloadFile、DownloadTask监听下载进度及取消下载任务的对象

wx.downloadFile(Object object)

下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径。使用前请注意阅读相关说明。
注意：请在服务端响应的 header 中指定合理的 Content-Type 字段，以保证客户端正确处理文件类型。

wx.downloadFile参数

object.success 回调函数参数

返回值
DownloadTask
一个可以监听下载进度变化事件和取消下载的对象

例如：

/*
  url       下载资源的 url
  header    HTTP 请求的 Header，Header 中不能设置 Referer
  filePath  指定文件下载后存储的路径
  下载成功属性
    tempFilePath  临时文件路径。如果没传入 filePath 指定文件存储路径，则下载后的文件会存储到一个临时文件
    statusCode   开发者服务器返回的 HTTP 状态码
*/


Page({
  data: {
    
  },
  onLoad: function (options) {

    wx.downloadFile({
      url: 'https://example.com/audio/123', 
      filePath: '',
      success(res) {
      // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
        console.log('下载成功')
        console.log('存放路径:',res.tempFilePath)
        console.log('状态码:', res.statusCode)
      },
      fail(err){
        console.log('下载失败:',err)
      }
    })
  }
})

打印结果：

下载成功
存放路径: http://tmp/wx6d1f8baf4b829d12.o6zAJswNSu8Lcf1fPq5VXiSxQTH8.XQOLUBX49vdh09b9c392dc1f6e914cea287cb6be34b0.html
状态码: 404

DownloadTask

一个可以监听下载进度变化事件，以及取消下载任务的对象

DownloadTask方法

DownloadTask.abort()

中断下载任务

DownloadTask.onProgressUpdate(function callback)

监听下载进度变化事件

DownloadTask.offProgressUpdate(function callback)

取消监听下载进度变化事件

DownloadTask.onHeadersReceived(function callback)

监听 HTTP Response Header 事件。会比请求完成事件更早
Object res属性

DownloadTask.offHeadersReceived(function callback)

取消监听 HTTP Response Header 事件
Object res属性

例如：
index.wxml

<button bindtap='btnClick1' type="primary">下载进度</button>
<button bindtap='btnClick2' type="primary">取消下载任务</button>

index.js

/*
  url       下载资源的 url
  header    HTTP 请求的 Header，Header 中不能设置 Referer
  filePath  指定文件下载后存储的路径
  下载成功属性
    tempFilePath  临时文件路径。如果没传入 filePath 指定文件存储路径，则下载后的文件会存储到一个临时文件
    statusCode   开发者服务器返回的 HTTP 状态码
*/
Page({
  data: {
  },
  onLoad: function (options) {
    const downloadTask = wx.downloadFile({
      url: 'https://example.com/audio/123', 
      filePath: '',
      success(res) {
      // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
        console.log('下载成功')
        console.log('存放路径:',res.tempFilePath)
        console.log('状态码:', res.statusCode)
      },
      fail(err){
        console.log('下载失败:',err)
      }
    })
  },
  btnClick1:function(){
    downloadTask.onProgressUpdate((res) => {
      console.log('下载进度', res.progress)
      console.log('已经下载的数据长度', res.totalBytesWritten)
      console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite)
    })
  },
  btnClick2: function () {
    downloadTask.abort() // 取消下载任务
  }
})