SocketTaskwx.connectSocket(Object object)

推荐使用 SocketTask 的方式来管理 WebSocket 连接,这样每条链路的生命周期都更加可控。如果同时存在多个 WebSocket 连接,使用 wx 前缀的方法可能会遇到一些和预期不一致的情况。

以 Promise 风格调用:不支持

微信小程序插件:支持,需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

相关文档:网络使用说明、局域网通信

功能描述

创建一个 WebSocket 连接。使用前请仔细阅读相关说明。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
url string 是 开发者服务器的 wss 接口地址
header Object 否 HTTP Header,Header 中不能设置 Referer
protocols Array.<string> 否 子协议数组 1.4.0
tcpNoDelay boolean false 否 建立 TCP 连接时的 TCP_NODELAY 设置 2.4.0
perMessageDeflate boolean false 否 是否开启压缩扩展 2.8.0
timeout number 否 超时时间,单位为毫秒 2.10.0
forceCellularNetwork boolean false 否 强制使用蜂窝网络发送请求 2.29.0
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

返回值

SocketTask

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

WebSocket 任务

并发数

  • 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接。
  • 1.7.0 以下版本,一个微信小程序同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。

示例代码

wx.connectSocket({
  url: 'wss://example.qq.com',
  header:{
    'content-type': 'application/json'
  }
})

wx.onSocketClose(function listener)

推荐使用 SocketTask 的方式来管理 WebSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 WebSocket 链接的情况下,使用 wx 前缀的方法可能会带来一些和预期不一致的情况。

微信小程序插件:不支持

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

相关文档:网络使用说明、局域网通信

功能描述

监听 WebSocket 连接关闭的事件。

参数

function listener

WebSocket 连接关闭事件的监听函数

参数

Object res
属性 类型 说明
code number 一个数字值,表示关闭连接的状态号,用于说明连接被关闭的原因。
reason string 一个可读的字符串,用于说明连接被关闭的原因。

wx.onSocketError(function listener)

推荐使用 SocketTask 的方式来管理 WebSocket 链接,这样每一条链路的生命周期都更加可控。如果同时存在多个 WebSocket 链接,使用 wx 前缀的方法可能会带来一些和预期不一致的情况。

微信小程序插件:不支持

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

相关文档: 网络使用说明、局域网通信

功能描述

监听 WebSocket 错误事件。

参数

function listener

WebSocket 错误事件的监听函数

参数

Object res
属性 类型 说明
errMsg string 错误信息

wx.onSocketMessage(function listener)

推荐使用 SocketTask 的方式来管理 WebSocket 链接,每一条链路的生命周期都更加可控,同时存在多个 WebSocket 链接的情况下,使用 wx 前缀的方法可能会带来一些和预期不一致的情况。

微信小程序插件:不支持

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

相关文档: 网络使用说明、局域网通信

功能描述

监听 WebSocket 接收到服务器的消息事件。

参数

function listener

WebSocket 接收到服务器的消息事件的监听函数

参数

Object res
属性 类型 说明
data string/ArrayBuffer 服务器返回的消息

wx.onSocketOpen(function listener)

推荐使用 SocketTask 的方式来管理 WebSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 WebSocket 链接的情况下,使用 wx 前缀的方法可能会带来一些和预期不一致的情况。

微信小程序插件:不支持

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

相关文档:网络使用说明、局域网通信

功能描述

监听 WebSocket 连接打开事件。

参数

function listener

WebSocket 连接打开事件的监听函数

参数

Object res
属性 类型 说明 最低版本
header object 连接成功的 HTTP 响应 Header 2.0.0

wx.sendSocketMessage(Object object)

推荐使用 SocketTask 的方式来管理 WebSocket 连接,这样每条链路的生命周期都更加可控。如果同时存在多个 WebSocket 连接,使用 wx 前缀的方法可能会遇到一些和预期不一致的情况。

以 Promise 风格 调用:支持

微信小程序插件:不支持

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

相关文档: 网络使用说明、局域网通信

功能描述

通过 WebSocket 连接发送数据。需要先调用 wx.connectSocket,并在 wx.onSocketOpen 回调之后才能发送。

参数

Object object

属性 类型 默认值 必填 说明
data string/ArrayBuffer 是 需要发送的内容
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

let socketOpen = false
let socketMsgQueue = []
wx.connectSocket({
  url: 'test.php'
})

wx.onSocketOpen(function(res) {
  socketOpen = true
  for (let i = 0; i < socketMsgQueue.length; i++){
    sendSocketMessage(socketMsgQueue[i])
  }
  socketMsgQueue = []
})

function sendSocketMessage(msg) {
  if (socketOpen) {
    wx.sendSocketMessage({
      data:msg
    })
  } else {
    socketMsgQueue.push(msg)
  }
}

UploadTask.onProgressUpdate(function listener)

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

微信小程序插件:支持

相关文档: 网络使用说明、局域网通信

功能描述

监听上传进度变化事件

参数

function listener

上传进度变化事件的监听函数

参数

Object res
属性 类型 说明
progress number 上传进度百分比
totalBytesSent number 已经上传的数据长度,单位 Bytes
totalBytesExpectedToSend number 预期需要上传的数据总长度,单位 Bytes

UploadTask.onHeadersReceived(function listener)

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

微信小程序插件:支持

相关文档: 网络使用说明、局域网通信

功能描述

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

参数

function listener

HTTP Response Header 事件的监听函数

参数

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

UploadTask.offProgressUpdate(function listener)

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

微信小程序插件:支持

相关文档: 网络使用说明、局域网通信

功能描述

移除上传进度变化事件的监听函数

参数

function listener

onProgressUpdate 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

UploadTask.onProgressUpdate(listener)
UploadTask.offProgressUpdate(listener) // 需传入与监听时同一个的函数对象

UploadTask.offHeadersReceived(function listener)

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

微信小程序插件:支持

相关文档: 网络使用说明、局域网通信

功能描述

移除 HTTP Response Header 事件的监听函数

参数

function listener

onHeadersReceived 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

UploadTask.onHeadersReceived(listener)
UploadTask.offHeadersReceived(listener) // 需传入与监听时同一个的函数对象