Taro.connectSocket(OBJECT)

创建一个 WebSocket 链接。

支持存在最多两个 WebSocket 链接，每次成功调用 Taro.connectSocket 会返回一个新的 SocketTask。

OBJECT 参数说明：

参数类型必填说明
urlString是开发者服务器接口地址，必须是 wss 协议
headerObject否HTTP Header , header 中不能设置 Referer
methodString否默认是 GET，有效值：OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT
protocolsStringArray否子协议数组
successFunction否接口调用成功的回调函数
failFunction否接口调用失败的回调函数
completeFunction否接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

  1. import Taro from '@tarojs/taro'
  3. Taro.connectSocket({
  4.   url: 'ws://echo.websocket.org/echo',
  5.   success: function () {
  6.     console.log('connect success')
  7.   }
  8. }).then(task => {
  9.   task.onOpen(function () {
  10.     console.log('onOpen')
  11.     task.send({ data: 'xxx' })
  12.   })
  13.   task.onMessage(function (msg) {
  14.     console.log('onMessage: ', msg)
  15.     task.close()
  16.   })
  17.   task.onError(function () {
  18.     console.log('onError')
  19.   })
  20.   task.onClose(function (e) {
  21.     console.log('onClose: ', e)
  22.   })
  23. })

API支持度

API微信小程序H5React Native支付宝小程序百度小程序
Taro.connectSocket✔️✔️✔️✔️✔️
SocketTask✔️✔️✔️✔️✔️