微信小程序插件：支持
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
相关文档: 网络使用说明、局域网通信
功能描述
监听 WebSocket 连接打开事件
参数
function listener
WebSocket 连接打开事件的监听函数
参数
Object res
| 属性 | 类型 | 说明 | 最低版本 | |||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| header | object | 连接成功的 HTTP 响应 Header | 2.0.0 | |||||||||||||||||||||||||||||||||||||
| profile | Object | 网络请求过程中一些调试信息 | 2.10.4 | |||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||
分类： 微信小程序开发
SocketTask.onMessage(function listener)
微信小程序插件：支持
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
相关文档: 网络使用说明、局域网通信
功能描述
监听 WebSocket 接收到服务器的消息事件
参数
function listener
WebSocket 接收到服务器的消息事件的监听函数
参数
Object res
| 属性 | 类型 | 说明 |
|---|---|---|
| data | string/ArrayBuffer | 服务器返回的消息 |
SocketTask.onError(function listener)
微信小程序插件：支持
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
相关文档: 网络使用说明、局域网通信
功能描述
监听 WebSocket 错误事件
参数
function listener
WebSocket 错误事件的监听函数
参数
Object res
| 属性 | 类型 | 说明 |
|---|---|---|
| errMsg | string | 错误信息 |
SocketTask.onClose(function listener)
微信小程序插件：支持
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
相关文档: 网络使用说明、局域网通信
功能描述
监听 WebSocket 连接关闭事件
参数
function listener
WebSocket 连接关闭事件的监听函数
参数
Object res
| 属性 | 类型 | 说明 |
|---|---|---|
| code | number | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 |
| reason | string | 一个可读的字符串，表示连接被关闭的原因。 |
SocketTask.close(Object object)
以 Promise 风格 调用：不支持
微信小程序插件：支持
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
相关文档: 网络使用说明、局域网通信
功能描述
关闭 WebSocket 连接
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| code | number | 1000（表示正常关闭连接） | 否 | 一个数字值，表示关闭连接的状态号，用于说明连接被关闭的原因。 |
| reason | string | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
SocketTask
基础库 1.7.0 开始支持，低版本需做兼容处理。
相关文档: 网络使用说明、局域网通信
WebSocket 任务，可通过 wx.connectSocket() 接口创建返回
方法
SocketTask.send(Object object)
通过 WebSocket 连接发送数据
SocketTask.close(Object object)
关闭 WebSocket 连接
SocketTask.onOpen(function listener)
监听 WebSocket 连接打开事件
SocketTask.onClose(function listener)
监听 WebSocket 连接关闭事件
SocketTask.onError(function listener)
监听 WebSocket 错误事件
SocketTask.onMessage(function listener)
监听 WebSocket 接收到服务器的消息事件
wx.closeSocket(Object object)
推荐使用 SocketTask 的方式来管理 WebSocket 连接，每一条链路的生命周期都更加可控。同时存在多个 WebSocket 连接的情况下，使用 wx 前缀的方法可能会带来一些和预期不一致的情况。
以 Promise 风格 调用：支持
微信小程序插件：不支持
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
相关文档: 网络使用说明、局域网通信
功能描述
关闭 WebSocket 连接。
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| code | number | 1000（表示正常关闭连接） | 否 | 一个数字值，表示关闭连接的状态号，用于说明连接被关闭的原因。 |
| reason | string | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。 | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
示例代码
wx.connectSocket({
url: 'test.php'
})
//注意这里有时序问题，
//如果 wx.connectSocket 还没回调 wx.onSocketOpen，而先调用 wx.closeSocket，那么就做不到关闭 WebSocket 的目的。
//必须在 WebSocket 打开期间调用 wx.closeSocket 才能关闭。
wx.onSocketOpen(function() {
wx.closeSocket()
})
wx.onSocketClose(function(res) {
console.log('WebSocket 已关闭！')
})
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 | 错误信息 |