RequestTask wx.request(Object object)

本接口从基础库版本 1.9.6 起支持在小程序插件中使用

发起 HTTPS 网络请求。使用前请注意阅读相关说明

参数

Object object

属性类型默认值必填说明最低版本
urlstring开发者服务器接口地址
datastring/object/ArrayBuffer请求的参数
headerObject设置请求的 header,header 中不能设置 Referer。
content-type 默认为 application/json
timeoutnumber超时时间,单位为毫秒2.10.0
methodstringGETHTTP 请求方法
dataTypestringjson返回的数据格式
responseTypestringtext响应的数据类型1.7.0
enableHttp2booleanfalse开启 http22.10.4
enableQuicbooleanfalse开启 quic2.10.4
enableCachebooleanfalse开启 cache2.10.4
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.method 的合法值

说明最低版本
OPTIONSHTTP 请求 OPTIONS
GETHTTP 请求 GET
HEADHTTP 请求 HEAD
POSTHTTP 请求 POST
PUTHTTP 请求 PUT
DELETEHTTP 请求 DELETE
TRACEHTTP 请求 TRACE
CONNECTHTTP 请求 CONNECT

object.dataType 的合法值

说明最低版本
json返回的数据为 JSON,返回后会对返回的数据进行一次 JSON.parse
其他不对返回的内容进行 JSON.parse

object.responseType 的合法值

说明最低版本
text响应的数据为文本
arraybuffer响应的数据为 ArrayBuffer

object.success 回调函数

参数
Object res
属性类型说明最低版本
datastring/Object/Arraybuffer开发者服务器返回的数据
statusCodenumber开发者服务器返回的 HTTP 状态码
headerObject开发者服务器返回的 HTTP Response Header1.2.0
cookiesArray.<string>开发者服务器返回的 cookies,格式为字符串数组2.10.0
profileObject网络请求过程中一些调试信息2.10.4

res.profile 的结构

属性类型说明
redirectStartnumber第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算,否则值为 0
redirectEndnumber最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算,否则值为 0
fetchStartnumber组件准备好使用 HTTP 请求抓取资源的时间,这发生在检查本地缓存之前
domainLookupStartnumberDNS 域名查询开始的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等
domainLookupEndnumberDNS 域名查询完成的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等
connectStartnumberHTTP(TCP) 开始建立连接的时间,如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接开始的时间
connectEndnumberHTTP(TCP) 完成建立连接的时间(完成握手),如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接完成的时间。注意这里握手结束,包括安全连接建立完成、SOCKS 授权通过
SSLconnectionStartnumberSSL建立连接的时间,如果不是安全连接,则值为 0
SSLconnectionEndnumberSSL建立完成的时间,如果不是安全连接,则值为 0
requestStartnumberHTTP请求读取真实文档开始的时间(完成建立连接),包括从本地读取缓存。连接错误重连时,这里显示的也是新建立连接的时间
requestEndnumberHTTP请求读取真实文档结束的时间
responseStartnumberHTTP 开始接收响应的时间(获取到第一个字节),包括从本地读取缓存
responseEndnumberHTTP 响应全部接收完成的时间(获取到最后一个字节),包括从本地读取缓存
rttnumber当次请求连接过程中实时 rtt
estimate_nettypestring评估的网络状态 slow 2g/2g/3g/4g
httpRttEstimatenumber协议层根据多个请求评估当前网络的 rtt(仅供参考)
transportRttEstimatenumber传输层根据多个请求评估的当前网络的 rtt(仅供参考)
downstreamThroughputKbpsEstimatenumber评估当前网络下载的kbps
throughputKbpsnumber当前网络的实际下载kbps
peerIPstring当前请求的IP
portnumber当前请求的端口
socketReusedboolean是否复用连接
sendBytesCountnumber发送的字节数
receivedBytedCountnumber收到字节数

返回值

RequestTask

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

请求任务对象

data 参数说明

最终发送给服务器的数据是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String 。转换规则如下:

  • 对于 GET 方法的数据,会将数据转换成 query string(encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...
  • 对于 POST 方法且 header['content-type']application/json 的数据,会对数据进行 JSON 序列化
  • 对于 POST 方法且 header['content-type']application/x-www-form-urlencoded 的数据,会将数据转换成 query string (encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...)

示例代码

  1. wx.request({
  2. url: 'test.php', //仅为示例,并非真实的接口地址
  3. data: {
  4. x: '',
  5. y: ''
  6. },
  7. header: {
  8. 'content-type': 'application/json' // 默认值
  9. },
  10. success (res) {
  11. console.log(res.data)
  12. }
  13. })