分类： 网络

UploadTask

基础库 1.4.0 开始支持，低版本需做兼容处理。

相关文档: 网络使用说明、局域网通信

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

方法

UploadTask.abort()

中断上传任务

UploadTask.onProgressUpdate(function listener)

监听上传进度变化事件

UploadTask.offProgressUpdate(function listener)

移除上传进度变化事件的监听函数

UploadTask.onHeadersReceived(function listener)

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

UploadTask.offHeadersReceived(function listener)

移除 HTTP Response Header 事件的监听函数

示例代码

const uploadTask = wx.uploadFile({
  url: 'http://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址
  filePath: tempFilePaths[0],
  name: 'file',
  formData:{
    'user': 'test'
  },
  success (res){
    const data = res.data
    //do something
  }
})

uploadTask.onProgressUpdate((res) => {
  console.log('上传进度', res.progress)
  console.log('已经上传的数据长度', res.totalBytesSent)
  console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend)
})

uploadTask.abort() // 取消上传任务

UploadTask wx.uploadFile(Object object)

以 Promise 风格 调用：不支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data。使用前请注意阅读相关说明。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
url string 是 开发者服务器地址
filePath string 是 要上传文件资源的路径 (本地路径)
name string 是 文件对应的 key，开发者在服务端可以通过这个 key 获取文件的二进制内容
header Object 否 HTTP 请求 Header，Header 中不能设置 Referer
formData Object 否 HTTP 请求中其他额外的 form data
timeout number 否 超时时间，单位为毫秒 2.10.0
enableProfile boolean true 否 是否开启 profile。iOS 和 Android 端默认开启，其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。 3.5.0
enableHttp2 boolean false 否 是否开启 http2 2.10.4
enableQuic boolean false 否 是否开启 Quic/h3 协议（iOS 微信目前使用 gQUIC-Q43；Android 微信在 v8.0.54 前使用 gQUIC-Q43，v8.0.54 开始使用 IETF QUIC，即 h3 协议；PC微信使用 IETF QUIC，即 h3 协议） 2.10.4
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明 最低版本
data string 开发者服务器返回的数据
statusCode number 开发者服务器返回的 HTTP 状态码
profile Object 网络请求过程中一些调试信息，查看详细说明。目前 iOS 和 Android 端支持。 3.5.0
结构属性 类型 说明 最低版本
invokeStart number 调用接口的时间。 3.8.10
httpDNSDomainLookUpStart number httpDNS 开始查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持 3.8.9
httpDNSDomainLookUpEnd number httpDNS 完成查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持 3.8.9
queueStart number 开始排队的时间。达到并行上限时才需要排队。 3.8.10
queueEnd number 结束排队的时间。达到并行上限时才需要排队。如果未发生排队，则该字段和 queueStart 字段值相同 3.8.10
redirectStart number 第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算，否则值为 0
redirectEnd number 最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算，否则值为 0
fetchStart number 组件准备好使用 HTTP 请求抓取资源的时间，这发生在检查本地缓存之前
domainLookUpStart number Local DNS 域名查询开始的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
domainLookUpEnd number Local DNS 域名查询完成的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
connectStart number HTTP（TCP） 开始建立连接的时间，如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接开始的时间
connectEnd number HTTP（TCP） 完成建立连接的时间（完成握手），如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接完成的时间。注意这里握手结束，包括安全连接建立完成、SOCKS 授权通过
SSLconnectionStart number SSL建立连接的时间,如果不是安全连接,则值为 0
SSLconnectionEnd number SSL建立完成的时间,如果不是安全连接,则值为 0
requestStart number HTTP请求读取真实文档开始的时间（完成建立连接），包括从本地读取缓存。连接错误重连时，这里显示的也是新建立连接的时间
requestEnd number HTTP请求读取真实文档结束的时间
responseStart number HTTP 开始接收响应的时间（获取到第一个字节），包括从本地读取缓存
responseEnd number HTTP 响应全部接收完成的时间（获取到最后一个字节），包括从本地读取缓存
rtt number 当次请求连接过程中的实时往返时间
estimate_nettype number 评估的网络状态，包括：unknown（未知）、offline（离线）、slow 2g（慢速2G）、2g、3g、4g，对应数值为 0、1、2、3、4、5、6
httpRttEstimate number 协议层根据多个请求评估的当前网络往返时间（仅供参考）
transportRttEstimate number 传输层根据多个请求评估的当前网络往返时间（仅供参考）
downstreamThroughputKbpsEstimate number 评估当前网络的下载速度（单位：千比特每秒）
throughputKbps number 当前网络的实际下载速度（单位：千比特每秒）
peerIP string 当前请求的服务器IP地址
port number 当前请求的端口号
socketReused boolean 是否复用了已有的网络连接
sendBytesCount number 已发送的数据字节数
receivedBytedCount number 已接收的数据字节数
protocol string 使用的网络协议类型，有效值包括：http1.1、h2、quic、unknown（未知）
usingHighPerformanceMode boolean 是否启用了高性能模式。基础库 v3.3.4 起支持。

返回值

UploadTask

基础库 1.4.0 开始支持，低版本需做兼容处理。

一个可以监听上传进度变化事件和取消上传操作的对象

示例代码

wx.chooseImage({
  success (res) {
    const tempFilePaths = res.tempFilePaths
    wx.uploadFile({
      url: 'https://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址
      filePath: tempFilePaths[0],
      name: 'file',
      formData: {
        'user': 'test'
      },
      success (res){
        const data = res.data
        //do something
      }
    })
  }
})

DownloadTask.onProgressUpdate(function listener)

基础库 1.4.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持

相关文档: 网络使用说明、局域网通信

功能描述

监听下载进度变化事件

参数

function listener

下载进度变化事件的监听函数

参数

Object res
属性 类型 说明
progress number 下载进度百分比
totalBytesWritten number 已经下载的数据长度，单位 Bytes
totalBytesExpectedToWrite number 预期需要下载的数据总长度，单位 Bytes

DownloadTask.onHeadersReceived(function listener)

基础库 2.1.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持

相关文档: 网络使用说明、局域网通信

功能描述

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

参数

function listener

HTTP Response Header 事件的监听函数

参数

Object res
属性 类型 说明
header Object 开发者服务器返回的 HTTP Response Header

DownloadTask.offProgressUpdate(function listener)

基础库 2.1.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持

相关文档: 网络使用说明、局域网通信

功能描述

移除下载进度变化事件的监听函数

参数

function listener

onProgressUpdate 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

DownloadTask.onProgressUpdate(listener)
DownloadTask.offProgressUpdate(listener) // 需传入与监听时同一个的函数对象

DownloadTask.offHeadersReceived(function listener)

基础库 2.1.0 开始支持，低版本需做兼容处理。

微信小程序插件：支持

相关文档: 网络使用说明、局域网通信

功能描述

移除 HTTP Response Header 事件的监听函数

参数

function listener

onHeadersReceived 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

DownloadTask.onHeadersReceived(listener)
DownloadTask.offHeadersReceived(listener) // 需传入与监听时同一个的函数对象

DownloadTask

基础库 1.4.0 开始支持，低版本需做兼容处理。

相关文档: 网络使用说明、局域网通信

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

方法

DownloadTask.abort()

中断下载任务

DownloadTask.onProgressUpdate(function listener)

监听下载进度变化事件

DownloadTask.offProgressUpdate(function listener)

移除下载进度变化事件的监听函数

DownloadTask.onHeadersReceived(function listener)

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

DownloadTask.offHeadersReceived(function listener)

移除 HTTP Response Header 事件的监听函数

示例代码

const downloadTask = wx.downloadFile({
  url: 'http://example.com/audio/123', //仅为示例，并非真实的资源
  success (res) {
    wx.playVoice({
      filePath: res.tempFilePath
    })
  }
})

downloadTask.onProgressUpdate((res) => {
  console.log('下载进度', res.progress)
  console.log('已经下载的数据长度', res.totalBytesWritten)
  console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite)
})

downloadTask.abort() // 取消下载任务

DownloadTaskwx.downloadFile(Object object)

以 Promise 风格 调用：不支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径 (本地路径)，单次下载允许的最大文件为 200MB。使用前请注意阅读相关说明。

注意：请在服务端响应的 header 中指定合理的 Content-Type 字段，以保证客户端正确处理文件类型。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
url string 是 下载资源的 url
header Object 否 HTTP 请求的 Header，Header 中不能设置 Referer
timeout number 60000 否 超时时间，单位为毫秒，默认值为 60000 即一分钟。 2.10.0
filePath string 否 指定文件下载后存储的路径 (本地路径) 1.8.0
enableProfile boolean true 否 是否开启 profile。iOS 和 Android 端默认开启，其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。
enableHttp2 boolean false 否 是否开启 http2 2.10.4
enableQuic boolean false 否 是否开启 Quic/h3 协议（iOS 微信目前使用 gQUIC-Q43；Android 微信在 v8.0.54 前使用 gQUIC-Q43，v8.0.54 开始使用 IETF QUIC，即 h3 协议；PC微信使用 IETF QUIC，即 h3 协议） 2.10.4
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明 最低版本
tempFilePath string 临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回，下载后的文件会存储到一个临时文件
filePath string 用户文件路径 (本地路径)。传入 filePath 时会返回，跟传入的 filePath 一致
statusCode number 开发者服务器返回的 HTTP 状态码
profile Object 网络请求过程中一些调试信息，查看详细说明。目前 iOS 和 Android 端支持。 2.10.4
结构属性 类型 说明 最低版本
invokeStart number 调用接口的时间。 3.8.10
httpDNSDomainLookUpStart number httpDNS 开始查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持 3.8.9
httpDNSDomainLookUpEnd number httpDNS 完成查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持 3.8.9
queueStart number 开始排队的时间。达到并行上限时才需要排队。 3.8.10
queueEnd number 结束排队的时间。达到并行上限时才需要排队。如果未发生排队，则该字段和 queueStart 字段值相同 3.8.10
redirectStart number 第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算，否则值为 0
redirectEnd number 最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算，否则值为 0
fetchStart number 组件准备好使用 HTTP 请求抓取资源的时间，这发生在检查本地缓存之前
domainLookUpStart number Local DNS 域名查询开始的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
domainLookUpEnd number Local DNS 域名查询完成的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
connectStart number HTTP（TCP） 开始建立连接的时间，如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接开始的时间
connectEnd number HTTP（TCP） 完成建立连接的时间（完成握手），如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接完成的时间。注意这里握手结束，包括安全连接建立完成、SOCKS 授权通过
SSLconnectionStart number SSL建立连接的时间,如果不是安全连接,则值为 0
SSLconnectionEnd number SSL建立完成的时间,如果不是安全连接,则值为 0
requestStart number HTTP请求读取真实文档开始的时间（完成建立连接），包括从本地读取缓存。连接错误重连时，这里显示的也是新建立连接的时间
requestEnd number HTTP请求读取真实文档结束的时间
responseStart number HTTP 开始接收响应的时间（获取到第一个字节），包括从本地读取缓存
responseEnd number HTTP 响应全部接收完成的时间（即获取到最后一个字节的时间），包括从本地读取缓存的时间
rtt number 当次请求连接过程中的实时往返时间
estimate_nettype number 评估的网络状态，可选值包括：unknown（未知）、offline（离线）、slow 2g（慢速2G）、2g、3g、4g，对应数值为 0、1、2、3、4、5、6
httpRttEstimate number 协议层根据多个请求评估的当前网络往返时间（仅供参考）
transportRttEstimate number 传输层根据多个请求评估的当前网络往返时间（仅供参考）
downstreamThroughputKbpsEstimate number 评估的当前网络下载速度（单位：千比特每秒）
throughputKbps number 当前网络的实际下载速度（单位：千比特每秒）
peerIP string 当前请求的服务器 IP 地址
port number 当前请求的端口号
socketReused boolean 是否复用了已有的连接
sendBytesCount number 发送的字节数
receivedBytedCount number 接收到的字节数
protocol string 使用的协议类型，有效值包括：http1.1、h2、quic、unknown（未知）
usingHighPerformanceMode boolean 是否使用了高性能模式。基础库 v3.3.4 起支持。

返回值

DownloadTask

基础库 1.4.0 开始支持，低版本需做兼容处理。

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

示例代码

wx.downloadFile({
  url: 'https://example.com/audio/123', //仅为示例，并非真实的资源
  success (res) {
    // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
    if (res.statusCode === 200) {
      wx.playVoice({
        filePath: res.tempFilePath
      })
    }
  }
})