6.6 网络API
6.6.5 WebSocket API
使用WebSocket API可使小程序与服务器建立长连接。小程序端和服务端长时间内可主动向对端发送一些数据
需要先调用wx.connectSocket创建一个连接，返回一个SocketTask对象，然后WebSocket方式通信。
SocketTask对象可建立四监听函数：
监听webSocket连接打开的onOpen函数，
监听webSocket接收到onMessage的onMessage函数，
监听webSocket错误的onError函数，
监听webSocket连接关闭的onClose函数。
SocketTask对象还可调用send函数向服务端发送数据，调用close函数关闭WebSocket连接。示例代码如下：
// 使用一个变量记录WebSocket连接是否已经建立
let socketOpen = false
// 消息队列数组，在WebSocket连接建立之前是不能发送数据的，可以先将数据缓存在这里
const socketMsgQueue = []
// 建立 WebSocket 连接
const socketTask = wx.connectSocket({
url: 'wss://somewebsite.com',
header: {
'content-type': 'application/json'
}
})
// 需要注意，调用建立连接接口后，建立连接需要一定时间，与网络情况有关，大约为数毫秒或数秒
// 封装一个发送数据的函数，如果当前建立连接还未完成，就先将需要发送的数据缓存到消息队列中
function sendSocketMessage(msg) {
if (socketOpen) {
// 当前未建立连接
socketTask.send({
data: msg // 发送的数据需要放到data属性中
})
} else {
// 当前还未建立连接
socketMsgQueue.push(msg)
}
}
// 监听WebSocket连接打开事件
socketTask.onOpen(function(res) {
// 标记连接已经已经建立
socketOpen = true
// 将消息队列中的缓存数据全部发送到服务端，并清空消息队列
for (let i = 0; i < socketMsgQueue.length; i++) {
const element = socketMsgQueue[i];
sendSocketMessage(element)
}
socketMsgQueue = []
})
// 监听webSocket接收到服务器消息的事件
socketTask.onMessage(function(res) {
console.log(res.data)
})
// 监听webSocket错误的事件
socketTask.onError(function(res) {
console.log(res.errMsg) // 错误消息
})
// 监听webSocket关闭事件
socketTask.onClose(function() {
// 标记连接已经关闭
socketOpen = false
})
// 主动关闭 WebSocket连接
socketTask.close({
code: 1000, // 关闭连接的状态号，表示连接被关闭的原因。默认为1000，表示正常关闭连接
reason: '',
success() {
// 标记连接已经关闭
socketOpen = false
}
})
网友评论