如何使用 wx.connectSocket 创建 WebSocket 连接？

推荐答案

// www.javascriptcn.com code example
// 创建 WebSocket 连接
wx.connectSocket({
  url: 'wss://example.com/socket', // WebSocket 服务器地址
  header: {
    'content-type': 'application/json' // 请求头
  },
  protocols: ['protocol1', 'protocol2'], // 子协议数组
  success(res) {
    console.log('WebSocket 连接成功', res);
  },
  fail(err) {
    console.error('WebSocket 连接失败', err);
  }
});

// 监听 WebSocket 连接打开事件
wx.onSocketOpen(function(res) {
  console.log('WebSocket 连接已打开');
});

// 监听 WebSocket 接收到服务器消息事件
wx.onSocketMessage(function(res) {
  console.log('收到服务器消息:', res.data);
});

// 监听 WebSocket 连接关闭事件
wx.onSocketClose(function(res) {
  console.log('WebSocket 连接已关闭');
});

// 监听 WebSocket 错误事件
wx.onSocketError(function(res) {
  console.error('WebSocket 连接发生错误', res);
});

本题详细解读

1. wx.connectSocket 方法

wx.connectSocket 是微信小程序中用于创建 WebSocket 连接的方法。它接受一个对象作为参数，该对象包含以下属性：

• url: 必填，WebSocket 服务器的地址，通常以 wss:// 或 ws:// 开头。
• header: 可选，设置请求头，通常用于传递认证信息或其他自定义头信息。
• protocols: 可选，子协议数组，用于指定 WebSocket 协议的子协议。
• success: 可选，连接成功后的回调函数。
• fail: 可选，连接失败后的回调函数。

2. WebSocket 事件监听

在创建 WebSocket 连接后，可以通过以下方法监听 WebSocket 的各种事件：

• wx.onSocketOpen: 监听 WebSocket 连接打开事件，当连接成功建立时触发。
• wx.onSocketMessage: 监听 WebSocket 接收到服务器消息事件，当服务器发送消息时触发。
• wx.onSocketClose: 监听 WebSocket 连接关闭事件，当连接关闭时触发。
• wx.onSocketError: 监听 WebSocket 错误事件，当连接发生错误时触发。

3. 使用场景

wx.connectSocket 通常用于需要实时通信的场景，如聊天应用、实时数据更新等。通过 WebSocket，客户端和服务器可以保持长时间的连接，并实现双向通信。

4. 注意事项

• WebSocket 连接是持久化的，除非手动关闭或网络中断，否则连接会一直保持。
• 在不需要 WebSocket 连接时，应调用 wx.closeSocket 方法关闭连接，以节省资源。
• WebSocket 连接可能会因为网络问题或服务器问题而中断，因此需要做好错误处理和重连机制。