程序开发之利用原生Api发起HTTP网络请求

网友投稿 346 2024-07-14

发起请求

#request

基础库1.3.9开始支持,iOS版本2.1.23,Android版本2.1.38

小程序开发之利用原生Api发起HTTP网络请求

request(Object object)

利用原生Api发起HTTP网络请求,执行后返回 RequestTask 对象。

参数

Object object

属性类型默认值必填说明
urlstring
开发者服务器接口地址
datastring/object/ArrayBuffer
请求的参数
headerObject
设置请求的 header,header 中不能设置 Referer。content-type 默认为 application/json
methodstringGETHTTP 请求方法
timeoutnumber
超时时间,单位为毫秒
dataTypestringjson返回的数据格式
responseTypestringtext响应的数据类型
forceCellularNetworkbooleanfalsewifi下使用移动网络发送请求(仅安卓支持)
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 Header

示例代码

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

#RequestTask.abort

基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34

RequestTask.abort()

中断请求任务

示例代码

const task = ft.request({
  // some params})// 中断请求task.abort()
        已复制代码

#RequestTask.onHeadersReceived

基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34

RequestTask.onHeadersReceived(function callback)

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

参数

function callback

Header Received 事件的回调函数

回调函数参数

Object res

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

#RequestTask.offHeadersReceived

基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34

RequestTask.offHeadersReceived(function callback)

取消监听 HTTP Response Header 事件。

参数

function callback

Header Received 事件的回调函数

#RequestTask.onChunkReceived

基础库3.2.3开始支持,iOS版本2.43.7,Android版本2.43.7

RequestTask.onChunkReceived(function callback)

监听 Chunk Received 事件,当接收到新的 chunk 时触发

参数

function callback

Chunk Received 事件的回调函数

回调函数参数

Object res

属性类型说明
dataArrayBuffer请求返回的 chunk buffer

#RequestTask.offChunkReceived

基础库3.2.3开始支持,iOS版本2.43.7,Android版本2.43.7

RequestTask.offChunkReceived(function callback)

取消监听 Chunk Received 事件

参数

function callback

Chunk Received 事件的回调函数


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:H5 与小程序存在的区别究竟在何处
下一篇:小程序开发API之下载请求(附代码示例)
相关文章

 发表评论

暂时没有评论,来抢沙发吧~