微信小程序API 上傳、下載

wx.uploadFile(OBJECT)

將本地資源上傳到開(kāi)發(fā)者服務(wù)器。如頁(yè)面通過(guò) wx.chooseImage 等接口獲取到一個(gè)本地資源的臨時(shí)文件路徑后，可通過(guò)此接口將本地資源上傳到指定服務(wù)器?？蛻舳税l(fā)起一個(gè)HTTPS POST請(qǐng)求，其中Content-Type為multipart/form-data。

OBJECT參數(shù)說(shuō)明：

success返回參數(shù)說(shuō)明：

示例代碼：

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

返回值：

基礎(chǔ)庫(kù) 1.4.0 開(kāi)始支持，低版本需做兼容處理。

返回一個(gè)uploadTask對(duì)象，通過(guò)uploadTask，可監(jiān)聽(tīng)上傳進(jìn)度變化事件，以及取消上傳任務(wù)。

uploadTask

基礎(chǔ)庫(kù) 1.4.0 開(kāi)始支持，低版本需做兼容處理。

一個(gè)可以監(jiān)聽(tīng)上傳進(jìn)度變化事件，以及取消上傳任務(wù)的對(duì)象

方法：

UploadTask.abort()

基礎(chǔ)庫(kù) 1.4.0 開(kāi)始支持，低版本需做兼容處理。

中斷上傳任務(wù)

UploadTask.offHeadersReceived(function callback)

基礎(chǔ)庫(kù) 2.1.0 開(kāi)始支持，低版本需做兼容處理。

取消監(jiān)聽(tīng) HTTP Response Header 事件

參數(shù)

function callback

HTTP Response Header 事件的回調(diào)函數(shù)

UploadTask.offProgressUpdate(function callback)

基礎(chǔ)庫(kù) 2.1.0 開(kāi)始支持，低版本需做兼容處理。

取消監(jiān)聽(tīng)上傳進(jìn)度變化事件

參數(shù)

function callback

上傳進(jìn)度變化事件的回調(diào)函數(shù)

UploadTask.onHeadersReceived(function callback)

基礎(chǔ)庫(kù) 2.1.0 開(kāi)始支持，低版本需做兼容處理。

監(jiān)聽(tīng) HTTP Response Header 事件。會(huì)比請(qǐng)求完成事件更早

參數(shù)

function callback

HTTP Response Header 事件的回調(diào)函數(shù)

參數(shù)

Object res

UploadTask.onProgressUpdate(function callback)

基礎(chǔ)庫(kù) 1.4.0 開(kāi)始支持，低版本需做兼容處理。

監(jiān)聽(tīng)上傳進(jìn)度變化事件

參數(shù)

function callback

上傳進(jìn)度變化事件的回調(diào)函數(shù)

參數(shù)

Object res

示例代碼：

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

uploadTask.onProgressUpdate((res) => {
    console.log('上傳進(jìn)度', res.progress)
    console.log('已經(jīng)上傳的數(shù)據(jù)長(zhǎng)度', res.totalBytesSent)
    console.log('預(yù)期需要上傳的數(shù)據(jù)總長(zhǎng)度', res.totalBytesExpectedToSend)
})

uploadTask.abort() // 取消上傳任務(wù)

Bug & Tip

1. tip: 最大并發(fā)限制是 10 個(gè)
2. tip: 默認(rèn)超時(shí)時(shí)間和最大超時(shí)時(shí)間都是 60s

wx.downloadFile(OBJECT)

下載文件資源到本地。客戶端直接發(fā)起一個(gè)HTTP GET請(qǐng)求，返回文件的本地臨時(shí)路徑。

參數(shù)

Object object

object.success 回調(diào)函數(shù)

參數(shù)

Object res

res.profile 的結(jié)構(gòu)

返回值

DownloadTask

基礎(chǔ)庫(kù) 1.4.0 開(kāi)始支持，低版本需做兼容處理。

一個(gè)可以監(jiān)聽(tīng)下載進(jìn)度變化事件和取消下載的對(duì)象

示例代碼:

wx.downloadFile({
  url: 'https://example.com/audio/123', //僅為示例，并非真實(shí)的資源
  success (res) {
    // 只要服務(wù)器有響應(yīng)數(shù)據(jù)，就會(huì)把響應(yīng)內(nèi)容寫(xiě)入文件并進(jìn)入 success 回調(diào)，業(yè)務(wù)需要自行判斷是否下載到了想要的內(nèi)容
    if (res.statusCode === 200) {
      wx.playVoice({
        filePath: res.tempFilePath
      })
    }
  }
})

DownloadTask

基礎(chǔ)庫(kù) 1.4.0 開(kāi)始支持，低版本需做兼容處理。

一個(gè)可以監(jiān)聽(tīng)下載進(jìn)度變化事件，以及取消下載任務(wù)的對(duì)象

方法：

DownloadTask.abort()

基礎(chǔ)庫(kù) 1.4.0 開(kāi)始支持，低版本需做兼容處理。

中斷下載任務(wù)

DownloadTask.offHeadersReceived(function callback)

基礎(chǔ)庫(kù) 2.1.0 開(kāi)始支持，低版本需做兼容處理。

取消監(jiān)聽(tīng) HTTP Response Header 事件

參數(shù)

function callback

HTTP Response Header 事件的回調(diào)函數(shù)

DownloadTask.offProgressUpdate(function callback)

基礎(chǔ)庫(kù) 2.1.0 開(kāi)始支持，低版本需做兼容處理。

取消監(jiān)聽(tīng)下載進(jìn)度變化事件

參數(shù)

function callback

下載進(jìn)度變化事件的回調(diào)函數(shù)