如何使用 wx.closeSocket 关闭 WebSocket 连接？

推荐答案

// www.javascriptcn.com code example
wx.closeSocket({
  code: 1000, // 可选，关闭连接的状态码，默认为 1000
  reason: '正常关闭', // 可选，关闭连接的原因
  success: function(res) {
    console.log('WebSocket 关闭成功', res);
  },
  fail: function(err) {
    console.error('WebSocket 关闭失败', err);
  },
  complete: function(res) {
    console.log('WebSocket 关闭完成', res);
  }
});

本题详细解读

1. wx.closeSocket 的作用

wx.closeSocket 是微信小程序中用于关闭 WebSocket 连接的方法。它允许你主动关闭与服务器的 WebSocket 连接，并且可以指定关闭的状态码和原因。

2. 参数说明

• code: 可选参数，表示关闭连接的状态码。默认值为 1000，表示正常关闭。其他常见的状态码包括：

  • 1001: 表示端点离开（例如服务器关闭或浏览器导航到其他页面）。
  • 1002: 表示协议错误。
  • 1003: 表示接收到不支持的数据类型。
  • 1007: 表示数据格式错误。
  • 1008: 表示违反策略。
  • 1009: 表示消息过大。
  • 1010: 表示客户端期望的扩展未实现。
  • 1011: 表示服务器遇到意外情况。

• reason: 可选参数，表示关闭连接的原因。通常是一个简短的字符串，描述关闭的原因。

• success: 可选参数，关闭成功后的回调函数。回调函数会接收到一个 res 参数，包含关闭操作的结果。

• fail: 可选参数，关闭失败后的回调函数。回调函数会接收到一个 err 参数，包含错误信息。

• complete: 可选参数，关闭操作完成后的回调函数。无论成功或失败，都会执行这个回调函数。

3. 使用场景

wx.closeSocket 通常在以下场景中使用：

• 当用户主动断开连接时（例如用户退出小程序）。
• 当服务器发送了关闭请求时。
• 当检测到网络异常或需要重新连接时。

4. 注意事项

• 在调用 wx.closeSocket 之前，确保 WebSocket 连接已经成功建立（即 wx.connectSocket 已经成功）。
• 关闭连接后，WebSocket 对象将不再可用，如果需要重新连接，需要再次调用 wx.connectSocket。
• 如果未指定 code 和 reason，默认情况下会以状态码 1000 正常关闭连接。