微信小程序API 上传、下载

wx.uploadFile(OBJECT)

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

OBJECT参数说明：

success返回参数说明：

示例代码：

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

UploadTask.onProgressUpdate(function callback)

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

监听上传进度变化事件

参数

function callback

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

参数

Object res

示例代码：

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

object.success 回调函数

参数

Object res

res.profile 的结构

返回值

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

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

DownloadTask.onHeadersReceived(function callback)

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

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

参数

function callback

HTTP Response Header 事件的回调函数

参数

Object res

DownloadTask.onProgressUpdate(function callback)

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

监听下载进度变化事件

参数

function callback

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

参数

Object res