Skip to content

UploadTask mpx.uploadFile(Object object)

将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-type 为 multipart/form-data

支持情况: 微信、支付宝

参考文档

参数

Object object

属性类型默认值必填说明最低版本支付宝
urlstring开发者服务器地址
filePathstring要上传文件资源的路径 (本地路径)
namestring文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
headerObjectHTTP 请求 Header,Header 中不能设置 Referer
formDataObjectHTTP 请求中其他额外的 form data
timeoutnumber超时时间,单位为毫秒2.10.0
enableProfilebooleantrue是否开启 profile。iOS 和 Android 端默认开启,其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。3.5.0
enableHttp2booleanfalse是否开启 http22.10.4
enableQuicbooleanfalse是否开启 Quic/h3 协议(iOS 微信目前使用 gQUIC-Q43;Android 微信在 v8.0.54 前使用 gQUIC-Q43,v8.0.54 开始使用 IETF QUIC,即 h3 协议;PC微信使用 IETF QUIC,即 h3 协议)2.10.4
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

参数

Object res

属性类型说明最低版本支付宝
datastring开发者服务器返回的数据
statusCodenumber开发者服务器返回的 HTTP 状态码
profileObject网络请求过程中一些调试信息,查看详细说明。目前 iOS 和 Android 端支持。3.5.0
结构属性:
结构属性类型说明最低版本
invokeStartnumber调用接口的时间。3.8.10
httpDNSDomainLookUpStartnumberhttpDNS 开始查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持3.8.9
httpDNSDomainLookUpEndnumberhttpDNS 完成查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持3.8.9
queueStartnumber开始排队的时间。达到并行上限时才需要排队。3.8.10
queueEndnumber结束排队的时间。达到并行上限时才需要排队。如果未发生排队,则该字段和 queueStart 字段值相同3.8.10
redirectStartnumber第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算,否则值为 0
redirectEndnumber最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算,否则值为 0
fetchStartnumber组件准备好使用 HTTP 请求抓取资源的时间,这发生在检查本地缓存之前
domainLookUpStartnumberLocal DNS 域名查询开始的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等
domainLookUpEndnumberLocal DNS 域名查询完成的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等
connectStartnumberHTTP(TCP) 开始建立连接的时间,如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接开始的时间
connectEndnumberHTTP(TCP) 完成建立连接的时间(完成握手),如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接完成的时间。注意这里握手结束,包括安全连接建立完成、SOCKS 授权通过
SSLconnectionStartnumberSSL建立连接的时间,如果不是安全连接,则值为 0
SSLconnectionEndnumberSSL建立完成的时间,如果不是安全连接,则值为 0
requestStartnumberHTTP请求读取真实文档开始的时间(完成建立连接),包括从本地读取缓存。连接错误重连时,这里显示的也是新建立连接的时间
requestEndnumberHTTP请求读取真实文档结束的时间
responseStartnumberHTTP 开始接收响应的时间(获取到第一个字节),包括从本地读取缓存
responseEndnumberHTTP 响应全部接收完成的时间(获取到最后一个字节),包括从本地读取缓存
rttnumber当次请求连接过程中实时 rtt
estimate_nettypenumber评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6
httpRttEstimatenumber协议层根据多个请求评估当前网络的 rtt(仅供参考)
transportRttEstimatenumber传输层根据多个请求评估的当前网络的 rtt(仅供参考)
downstreamThroughputKbpsEstimatenumber评估当前网络下载的kbps
throughputKbpsnumber当前网络的实际下载kbps
peerIPstring当前请求的IP
portnumber当前请求的端口
socketReusedboolean是否复用连接
sendBytesCountnumber发送的字节数
receivedBytedCountnumber收到字节数
protocolstring使用协议类型,有效值:http1.1, h2, quic, unknown
usingHighPerformanceModeboolean是否走到了高性能模式。基础库 v3.3.4 起支持。

返回值

UploadTask

示例代码

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