微信小程序API 发起请求

2020-07-28 16:16 更新

RequestTask wx.request(Object object)

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

参数

Object object

属性 类型 默认值 必填 说明 最低版本
url string 开发者服务器接口地址
data string/object/ArrayBuffer 请求的参数
header Object 设置请求的 header,header 中不能设置 Referer。
content-type 默认为 application/json
timeout number 超时时间,单位为毫秒 2.10.0
method string GET HTTP 请求方法
dataType string json 返回的数据格式
responseType string text 响应的数据类型 1.7.0
enableHttp2 boolean false 开启 http2 2.10.4
enableQuic boolean false 开启 quic 2.10.4
enableCache boolean false 开启 cache 2.10.4
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

object.method 的合法值

说明 最低版本
OPTIONS HTTP 请求 OPTIONS
GET HTTP 请求 GET
HEAD HTTP 请求 HEAD
POST HTTP 请求 POST
PUT HTTP 请求 PUT
DELETE HTTP 请求 DELETE
TRACE HTTP 请求 TRACE
CONNECT HTTP 请求 CONNECT

object.dataType 的合法值

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

object.responseType 的合法值

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

object.success 回调函数

参数
Object res
属性 类型 说明 最低版本
data string/Object/Arraybuffer 开发者服务器返回的数据
statusCode number 开发者服务器返回的 HTTP 状态码
header Object 开发者服务器返回的 HTTP Response Header 1.2.0
cookies Array.<string> 开发者服务器返回的 cookies,格式为字符串数组 2.10.0
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 收到字节数

返回值

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)...)

示例代码

wx.request({
  url: 'test.php', //仅为示例,并非真实的接口地址
  data: {
    x: '',
    y: ''
  },
  header: {
    'content-type': 'application/json' // 默认值
  },
  success (res) {
    console.log(res.data)
  }
})

RequestTask

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

网络请求任务对象

方法

RequestTask.abort()

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

中断请求任务


RequestTask.offHeadersReceived(function callback)

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

取消监听 HTTP Response Header 事件

参数

function callback

HTTP Response Header 事件的回调函数


RequestTask.onHeadersReceived(function callback)

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

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

参数

function callback

HTTP Response Header 事件的回调函数

参数

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


示例代码

const requestTask = wx.request({
  url: 'test.php', //仅为示例,并非真实的接口地址
  data: {
    x: '' ,
    y: ''
  },
  header: {
    'content-type': 'application/json'
  },
  success (res) {
    console.log(res.data)
  }
})
requestTask.abort() // 取消请求任务


以上内容是否对您有帮助:
前端课程
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号

意见反馈
返回顶部