微信小程序API 上传、下载

wx.uploadFile(OBJECT)

---

将本地资源上传到开发者服务器。如页面通过 wx.chooseImage 等接口获取到一个本地资源的临时文件路径后，可通过此接口将本地资源上传到指定服务器。客户端发起一个HTTPS POST请求，其中Content-Type为multipart/form-data。

OBJECT参数说明：

参数	类型	必填	说明
url	String	是	开发者服务器url
filePath	String	是	要上传文件资源的路径
name	String	是	文件对应的key , 开发者在服务器端通过这个key可以获取到文件二进制内容
header	Object	否	HTTP 请求 Header，header中不能设置Referer
formData	Object	否	HTTP 请求中其他额外的form data
success	Function	否	接口调用成功的回调函数
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

success返回参数说明：

参数	类型	说明
data	String	开发者服务器返回的数据
statusCode	Number	HTTP状态码

示例代码：

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

返回值：

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

返回一个uploadTask对象，通过uploadTask，可监听上传进度变化事件，以及取消上传任务。

uploadTask

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

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

方法：

UploadTask.abort()

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

中断上传任务

UploadTask.offHeadersReceived(function callback)

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

取消监听 HTTP Response Header 事件

参数

function callback

HTTP Response Header 事件的回调函数

UploadTask.offProgressUpdate(function callback)

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

取消监听上传进度变化事件

参数

function callback

上传进度变化事件的回调函数

UploadTask.onHeadersReceived(function callback)

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

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

参数

function callback

HTTP Response Header 事件的回调函数

参数

Object res

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

UploadTask.onProgressUpdate(function callback)

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

监听上传进度变化事件

参数

function callback

上传进度变化事件的回调函数

参数

Object res

属性	类型	说明
progress	number	上传进度百分比
totalBytesSent	number	已经上传的数据长度，单位 Bytes
totalBytesExpectedToSend	number	预期需要上传的数据总长度，单位 Bytes

示例代码：

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

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

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

Bug & Tip

1. tip: 最大并发限制是 10 个
2. tip: 默认超时时间和最大超时时间都是 60s

---

wx.downloadFile(OBJECT)

下载文件资源到本地。客户端直接发起一个HTTP GET请求，返回文件的本地临时路径。

参数

Object object

属性	类型	默认值	必填	说明	最低版本
url	string		是	下载资源的 url
header	Object		否	HTTP 请求的 Header，Header 中不能设置 Referer
timeout	number		否	超时时间，单位为毫秒	2.10.0
filePath	string		否	指定文件下载后存储的路径 (本地路径)	1.8.0
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明	最低版本
tempFilePath	string	临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回，下载后的文件会存储到一个临时文件
filePath	string	用户文件路径 (本地路径)。传入 filePath 时会返回，跟传入的 filePath 一致
statusCode	number	开发者服务器返回的 HTTP 状态码
profile	Object	网络请求过程中一些调试信息	2.10.4

res.profile 的结构

属性	类型	说明
redirectStart	number	第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算，否则值为 0
redirectEnd	number	最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算，否则值为 0
fetchStart	number	组件准备好使用 HTTP 请求抓取资源的时间，这发生在检查本地缓存之前
domainLookupStart	number	DNS 域名查询开始的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
domainLookupEnd	number	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	当次请求连接过程中实时 rtt
estimate_nettype	string	评估的网络状态 slow 2g/2g/3g/4g
httpRttEstimate	number	协议层根据多个请求评估当前网络的 rtt（仅供参考）
transportRttEstimate	number	传输层根据多个请求评估的当前网络的 rtt（仅供参考）
downstreamThroughputKbpsEstimate	number	评估当前网络下载的kbps
throughputKbps	number	当前网络的实际下载kbps
peerIP	string	当前请求的IP
port	number	当前请求的端口
socketReused	boolean	是否复用连接
sendBytesCount	number	发送的字节数
receivedBytedCount	number	收到字节数

返回值

DownloadTask

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

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

示例代码:

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

---

DownloadTask

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

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

方法：

DownloadTask.abort()

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

中断下载任务

DownloadTask.offHeadersReceived(function callback)

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

取消监听 HTTP Response Header 事件

参数

function callback

HTTP Response Header 事件的回调函数

DownloadTask.offProgressUpdate(function callback)

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

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

参数

function callback

下载进度变化事件的回调函数