Skip to content

WebSocket 功能 ​


版本 ​

  • = 2.1.0

配置说明 ​

配置位于 ruoyi-resource 目录。

输入图片说明

参数说明:

  • enabled:是否启用
  • path:应用路径
  • allowedOrigins:访问源地址

注意:关闭 WebSocket 时需同步关闭前端开关,否则前端启动会报错。

输入图片说明

补充说明:

  • Cloud 版本的服务端配置实际位于 Nacos 配置 script/config/nacos/ruoyi-resource.yml。
  • 前端仍通过网关下的 /resource/websocket 建立连接,连接参数、通知展示、心跳与自动重连逻辑和 Vue 版本一致。
  • 业务上如果只是服务端通知前端,仍建议优先用 SSE;WebSocket 更适合需要双向交互或自定义消息协议的场景。

前端连接示例 ​

text
ws://后端ip:端口/resource/websocket?clientid=import.meta.env.VITE_APP_CLIENT_ID&Authorization=Bearer <token>

由于 JS 不支持自定义请求头,这里使用参数传输。若前端支持 Header,请优先使用 Header。

Header 示例:

js
headers: {
    Authorization: "Bearer " + getToken(),
    clientid: import.meta.env.VITE_APP_CLIENT_ID
}

连接成功后,登录态获取方式与框架内其他接口一致。

补充说明:

  • 实际部署一般连接网关地址,不建议前端直接访问 ruoyi-resource 服务实例。
  • 连接与前端封装方式可直接参考 Vue 版本说明。

消息发送 ​

  • WebSocketUtils.sendMessage:单机消息(特殊需求)
  • WebSocketUtils.subscribeMessage:订阅分布式消息(默认已订阅)
  • WebSocketUtils.publishMessage:发布分布式消息(推荐)
  • WebSocketUtils.publishAll:群发消息

补充说明:

  • Cloud 项目中如果消息来源分散在多个服务,建议统一通过资源服务承接连接和推送。

砚考 · 让每一次考试都经得起检验