uniapp链接WebSocket 常用的API

翻斗花园-图图2023-11-30 12:42

UniApp是一个基于Vue语法的跨平台应用开发框架，它支持使用WebSocket来实现实时双向通信。WebSocket是一种在单个TCP连接上进行全双工通信的协议，它可以在客户端和服务器之间建立持久性的连接，并允许双向通信。在UniApp中，你可以使用WebSocket来实现实时消息推送、实时聊天等功能。要使用WebSocket，在UniApp中你需要调用相关的API来创建WebSocket连接，并处理相关的消息事件。通过WebSocket，你可以实现更加即时和高效的通信，为你的应用增加更多的实时交互体验。

当使用uni-app链接WebSocket时，常用的API包括：

uni.connectSocket(Object object)- 创建一个 WebSocket 连接:

javascript 复制代码

uni.connectSocket({
  url: 'wss://your_websocket_url',
  success(res) {
    console.log('WebSocket连接成功', res)
  }
})

uni.onSocketOpen(callback) - 监听WebSocket连接打开事件:

javascript 复制代码

uni.onSocketOpen(function (res) {
  console.log('WebSocket连接已打开', res)
})

uni.sendSocketMessage(Object object) - 通过 WebSocket 连接发送数据:

javascript 复制代码

uni.sendSocketMessage({
  data: 'Hello, WebSocket!',
  success(res) {
    console.log('数据发送成功', res)
  }
})

uni.onSocketMessage(callback) - 监听WebSocket接收到服务器的消息事件:

javascript 复制代码

uni.onSocketMessage(function (res) {
  console.log('收到服务器消息', res)
})

uni.onSocketError(callback)- 监听WebSocket错误事件:

javascript 复制代码

uni.onSocketError(function (res) {
  console.log('WebSocket连接出现错误', res)
})

uni.closeSocket(Object object) - 关闭WebSocket连接:

javascript 复制代码

uni.closeSocket({
  code: 1000,
  reason: '用户关闭连接',
  success(res) {
    console.log('WebSocket连接已关闭', res)
  }
})