WebSocket 在 Spring Boot 中的高级应用指南

WebSocket 在 Spring Boot 中的高级应用指南

深入理解WebSocket协议
深入理解STOMP协议

1. 概述

WebSocket 是一种基于 TCP 的全双工通信协议，允许服务器和客户端之间进行持续的双向通信。与传统的 HTTP 请求-响应模型不同，WebSocket 是一个持久的连接，可以在服务器和客户端之间进行实时数据交换，特别适用于需要频繁更新的场景，比如实时聊天、在线游戏、金融市场数据等。

在 Spring Boot 中，WebSocket 有多种实现方式，开发者可以根据具体的业务需求选择合适的方式。本文将详细介绍以下三种 WebSocket 的实现方式：

  1. 基于注解的 JSR 356 标准实现。
  2. 基于 Spring 的 WebSocketHandler 接口实现。
  3. 基于 STOMP 协议的实现。

通过这些不同的方式，开发者能够灵活地实现实时通信，满足各种场景下的需求。

2. 基于注解的 JSR 356 实现

JSR 356 是 Java 的标准 WebSocket API，它允许开发者使用注解来处理 WebSocket 的连接、消息传递和关闭等事件。JSR 356 的实现方式非常直观，适合轻量级的 WebSocket 应用。

2.1 配置与实现

依赖添加：

在 pom.xml 中添加 WebSocket 相关的依赖：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

WebSocket 配置类：

为了让 Spring Boot 支持 WebSocket，我们需要配置一个 ServerEndpointExporter，它会自动注册所有标注了 @ServerEndpoint 的类。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;@Configuration
public class WebSocketConfig {// 启用 WebSocket 支持，自动扫描并注册 @ServerEndpoint 注解的类@Beanpublic ServerEndpointExporter serverEndpointExporter() {return new ServerEndpointExporter();}
}

WebSocket 服务端实现类：

使用 @ServerEndpoint 注解来指定 WebSocket 端点路径，处理客户端的连接、消息和关闭事件。

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;@ServerEndpoint("/ws")
public class WebSocketServer {// 存储所有的 WebSocket 客户端连接private static final CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<>();private Session session; // 当前会话的连接/*** 客户端连接建立时调用* @param session WebSocket 会话*/@OnOpenpublic void onOpen(Session session) {this.session = session;webSocketSet.add(this); // 将新的连接加入集合System.out.println("新连接建立: " + session.getId());sendMessage("连接成功");}/*** 客户端发送消息时调用* @param message 客户端发来的消息*/@OnMessagepublic void onMessage(String message) {System.out.println("收到消息: " + message + " 来自: " + session.getId());// 广播消息给所有连接的客户端for (WebSocketServer webSocket : webSocketSet) {try {webSocket.sendMessage("服务器收到消息: " + message);} catch (IOException e) {e.printStackTrace();}}}/*** 客户端断开连接时调用* @param session WebSocket 会话*/@OnClosepublic void onClose(Session session) {webSocketSet.remove(this); // 连接关闭时移除System.out.println("连接关闭: " + session.getId());}/*** 发送消息给客户端* @param message 消息内容* @throws IOException 发送失败异常*/private void sendMessage(String message) throws IOException {this.session.getBasicRemote().sendText(message);}
}

客户端页面：

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>WebSocket JSR 356</title>
</head>
<body><h2>WebSocket JSR 356 客户端</h2><button onclick="connect()">连接</button><button onclick="disconnect()">断开连接</button><br><br><input type="text" id="message" placeholder="输入消息"><button onclick="sendMessage()">发送</button><h3>消息：</h3><ul id="messages"></ul><script>var socket;function connect() {socket = new WebSocket("ws://localhost:8080/ws");socket.onmessage = function (event) {var messages = document.getElementById("messages");var message = document.createElement("li");message.appendChild(document.createTextNode(event.data));messages.appendChild(message);};}function disconnect() {if (socket) {socket.close();}}function sendMessage() {var messageInput = document.getElementById("message").value;socket.send(messageInput);}</script>
</body>
</html>

2.2 特点与适用场景

  • 简单直接：通过注解的方式，开发者可以轻松实现 WebSocket 的连接管理和消息处理。
  • 低复杂度：没有引入额外的协议，适合点对点通信的简单场景。
  • 适用场景：适合开发简单的实时聊天、在线客服等应用。

3. 基于 WebSocketHandler 接口的实现

Spring 提供了 WebSocketHandler 接口，用于更灵活地处理 WebSocket 连接。相比于注解方式，这种方式更适合处理复杂的业务逻辑。

3.1 配置与实现

WebSocket 配置类：

我们需要创建一个配置类，实现 WebSocketConfigurer 接口，并注册自定义的 WebSocketHandler。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {private final MyWebSocketHandler myWebSocketHandler;public WebSocketConfig(MyWebSocketHandler myWebSocketHandler) {this.myWebSocketHandler = myWebSocketHandler;}@Overridepublic void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {// 注册自定义的 WebSocketHandlerregistry.addHandler(myWebSocketHandler, "/ws").setAllowedOrigins("*");}
}

WebSocketHandler 实现类：

我们需要实现 TextWebSocketHandler 类，处理文本消息的收发。

import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;import java.io.IOException;
import java.util.concurrent.CopyOnWriteArrayList;public class MyWebSocketHandler extends TextWebSocketHandler {private static final CopyOnWriteArrayList<WebSocketSession> sessions = new CopyOnWriteArrayList<>();/*** 连接建立后的回调方法* @param session WebSocket 会话*/@Overridepublic void afterConnectionEstablished(WebSocketSession session) throws Exception {sessions.add(session); // 保存新的连接session.sendMessage(new TextMessage("连接成功"));System.out.println("新连接建立: " + session.getId());}/*** 处理接收到的文本消息* @param session WebSocket 会话* @param message 接收到的消息*/@Overridepublic void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {String payload = message.getPayload();System.out.println("收到消息: " + payload);// 广播消息for (WebSocketSession webSocketSession : sessions) {if (webSocketSession.isOpen()) {webSocketSession.sendMessage(new TextMessage("服务器收到: " + payload));}}}/*** 连接关闭后的回调方法* @param session WebSocket 会话* @param status 关闭状态*/@Overridepublic void afterConnectionClosed(WebSocketSession session, org.springframework.web.socket.CloseStatus status) throws Exception {sessions.remove(session); // 移除关闭的连接System.out.println("连接关闭: " + session.getId());}
}

客户端页面：

客户端页面和之前的JSR 356方式类似，保持不变。

3.2 特点与适用场景

  • 更高的灵活性：相比于注解方式，使用 WebSocketHandler 可以更细粒度地控制 WebSocket 的行为，例如自定义处理多种消息类型（文本、二进制）。
  • 适用场景：适用于需要复杂的消息处理逻辑和扩展功能的应用，比如需要进行鉴权、拦截等。

4. 基于 STOMP 协议的实现

STOMP（Simple Text Oriented Messaging Protocol）是一个轻量级的消息传输协议，通常与 WebSocket 结合使用，支持发布/订阅模型，适用于多客户端间的消息分发和订阅。

4.1 配置与实现

依赖添加：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

WebSocket 和 STOMP 配置类：

import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;@Configuration
@EnableWebSocketMessageBroker
public class WebSocketStompConfig implements WebSocketMessageBrokerConfigurer {@Overridepublic void configureMessageBroker(MessageBrokerRegistry config) {// 配置消息代理，处理前缀为 /topic 的消息config.enableSimpleBroker("/topic");// 配置应用程序前缀，发送消息的前缀config.setApplicationDestinationPrefixes("/app");}@Overridepublic void registerStompEndpoints(StompEndpointRegistry registry) {// 注册 STOMP 端点，并启用 SockJS 支持registry.addEndpoint("/ws-stomp").withSockJS();}
}

消息控制器：

import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;@Controller
public class WebSocketController {@MessageMapping("/sendMessage")@SendTo("/topic/messages")public String processMessageFromClient(String message) throws Exception {// 接收到客户端消息后，将其发送到 /topic/messagesreturn "服务器收到: " + message;}
}

客户端页面：

使用 STOMP.js 来与服务器进行通信。

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>STOMP WebSocket Test</title><script src="https://cdn.jsdelivr.net/npm/sockjs-client@1.5.0/dist/sockjs.min.js"></script><script src="https://cdn.jsdelivr.net/npm/stompjs@2.3.3/lib/stomp.min.js"></script>
</head>
<body><h2>STOMP WebSocket 客户端</h2><button onclick="connect()">连接</button><button onclick="disconnect()">断开连接</button><br><br><input type="text" id="message" placeholder="输入消息"><button onclick="sendMessage()">发送</button><h3>消息：</h3><ul id="messages"></ul><script>var stompClient = null;function connect() {var socket = new SockJS('/ws-stomp');stompClient = Stomp.over(socket);stompClient.connect({}, function (frame) {console.log('连接成功: ' + frame);stompClient.subscribe('/topic/messages', function (messageOutput) {showMessage(messageOutput.body);});});}function disconnect() {if (stompClient !== null) {stompClient.disconnect();}console.log("断开连接");}function sendMessage() {var messageInput = document.getElementById("message").value;stompClient.send("/app/sendMessage", {}, messageInput);}function showMessage(message) {var messages = document.getElementById("messages");var messageElement = document.createElement("li");messageElement.appendChild(document.createTextNode(message));messages.appendChild(messageElement);}</script>
</body>
</html>

4.2 特点与适用场景

  • 支持发布/订阅模型：STOMP 协议天生支持消息的发布和订阅，非常适合需要多客户端互动的场景。
  • 消息代理与路由：通过配置消息代理，可以轻松实现消息的广播和分发。
  • 适用场景：适用于多客户端的复杂通信场景，比如在线聊天室、股票行情推送等。

5. 三种实现方式的对比

特性基于注解（JSR 356）基于 WebSocketHandler基于 STOMP 协议
实现复杂度简单中等较高
消息路由无无支持消息路由、发布/订阅
灵活性较低高高
扩展性适合简单场景适合自定义处理逻辑适合复杂的多客户端场景
典型应用场景简单的实时通信应用复杂消息处理和控制发布/订阅模型、多人互动的实时应用

6. 结论

Spring Boot 提供了多种 WebSocket 实现方式，开发者可以根据具体需求选择合适的实现。对于简单的点对点通信，基于注解的 JSR 356 实现已经足够；对于需要更高灵活性和复杂业务处理的场景，WebSocketHandler 是一个更好的选择；而如果你需要实现发布/订阅模型，多客户端交互，基于 STOMP 协议的 WebSocket 实现是最佳选择。

开发者可以根据项目需求，合理使用 WebSocket，实现实时通信功能，让应用更加智能、高效。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/880791.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Linux 进程的基本概念及描述

Linux 进程的基本概念及描述

目录 0.前言 1. 什么是进程 1.1 进程的定义与特性 1.2 进程与线程的区别 2.描述进程 2.1 PCB (进程控制块) 2.2 task_struct 3.查看进程 3.1 查看进程信息 3.1.1 /proc 文件系统 3.1.2 ps 命令 3.1.2 top 和 htop 命令 3.2 获取进程标识符 3.2.1使用命令获取PID 3.2.2 使用C语言…
阅读更多...
加密与安全_HTOP 一次性密码生成算法

加密与安全_HTOP 一次性密码生成算法

文章目录 HOTP 的基础原理HOTP 的工作流程HOTP 的应用场景HOTP 的安全性安全性增强措施Code生成HOTP可配置项校验HOTP可拓展功能计数器&#xff08;counter&#xff09;计数器在客户端和服务端的作用计数器的同步机制客户端和服务端中的计数器表现服务端如何处理计数器不同步计…
阅读更多...
AIGC学习笔记—minimind详解+训练+推理

AIGC学习笔记—minimind详解+训练+推理

前言 这个开源项目是带我的一个导师&#xff0c;推荐我看的&#xff0c;记录一下整个过程&#xff0c;总结一下收获。这个项目的slogan是“大道至简”&#xff0c;确实很简。作者说是这个项目为了帮助初学者快速入门大语言模型&#xff08;LLM&#xff09;&#xff0c;通过从零…
阅读更多...
vue3学习记录-computed

vue3学习记录-computed

vue3学习记录-computed 1.为什么要用computed2.使用方法2.1 基本实例2.2 可写计算属性 1.为什么要用computed 写个购物车的案例 <script setup> import { ref, reactive,computed } from "vue" const tableData reactive([{ name: 商品1, price: 10, num: 1…
阅读更多...
3. 轴指令（omron 机器自动化控制器）——＞MC_MoveRelative

3. 轴指令（omron 机器自动化控制器）——＞MC_MoveRelative

机器自动化控制器——第三章 轴指令 5 MC_MoveRelative变量▶输入变量▶输出变量▶输入输出变量 功能说明▶指令详情▶时序图▶重启运动指令▶多重启动运动指令▶异常 MC_MoveRelative 指定自指令当前位置起的移动距离&#xff0c;进行定位。 指令名称FB/FUN图形表现ST表现MC…
阅读更多...
JVM(HotSpot)：字符串常量池(StringTable)

JVM(HotSpot)：字符串常量池(StringTable)

文章目录 一、内存结构图二、案例讲解三、总结 一、内存结构图 JDK1.6 JDK1.8 我们发现&#xff0c;StringTable移入了Heap里面。所以&#xff0c;应该想到&#xff0c;StringTable将受到GC管理。 其实&#xff0c;1.6中&#xff0c;在方法区中的时候&#xff0c;也是受GC管…
阅读更多...
从底层理解为什么常量区中的代码不能被修改？

从底层理解为什么常量区中的代码不能被修改？

目录 前言&#xff1a;一、了解虚拟地址二、页表映射三、常量区不能被修改的原理四、常量区不可修改的意义 前言&#xff1a; 平时我们在编写代码时都会用到或遇到所谓的常量区或者不可修改的代码&#xff0c;比如说用双引号包起来字符串&#xff08;“Hello World”&#xff…
阅读更多...
微服务SpringSession解析部署使用全流程

微服务SpringSession解析部署使用全流程

目录 1、SpringSession简介 2、实现session共享的三种方式 1、修改Tomcat配置文件 2、Nginx负载均衡策略 3、redis统一存储 0、准备工作 1、本地服务添加依赖 2、修改本地服务配置文件 3、添加application.properties文件 4、添加nacos - redis配置 5、修改本地项目…
阅读更多...
Linux启动mysql报错

Linux启动mysql报错

甲方公司意外停电&#xff0c;所有服务器重启后&#xff0c;发现部署在Linux上的mysql数据库启动失败.再加上老员工离职&#xff0c;新接手项目&#xff0c;对Linux系统了解不多&#xff0c;解决起来用时较多&#xff0c;特此记录。 1.启动及报错 1.1 启动语句1 启动语句1&a…
阅读更多...
全站最详细的Python环境配置步骤

全站最详细的Python环境配置步骤

1、官网下载IDE JetBrains下载 2、IDE下载、安装步骤 这里展示的是如何在Windows上下载、安装Pycharm工具&#xff0c;Linux的步骤类似。 2.1、选择开发者工具 选择开发者工具 2.2、选择Pycharm 选择Pycharm 2.3、选择下载 选择下载 2.4、选择社区版 一般而言&#xff…
阅读更多...
基于SpringBoot+Vue的留守儿童爱心网站系统

基于SpringBoot+Vue的留守儿童爱心网站系统

作者&#xff1a;计算机学姐 开发技术&#xff1a;SpringBoot、SSM、Vue、MySQL、JSP、ElementUI、Python、小程序等&#xff0c;“文末源码”。 专栏推荐&#xff1a;前后端分离项目源码、SpringBoot项目源码、Vue项目源码、SSM项目源码、微信小程序源码 精品专栏&#xff1a;…
阅读更多...
MyBatis的注入问题

MyBatis的注入问题

对之前文章的补充&#xff1a;MyBatis中的#{}与${}注入问题----原文链接 前言&#xff1a; MyBatis是一个流行的Java持久层框架&#xff0c;用于将对象与数据库中的数据进行映射。然而&#xff0c;如果不当使用&#xff0c;MyBatis也可能受到诸如SQL注入这类的安全问题的影响。…
阅读更多...
解决VRM格式模型在Unity中运行出现头发乱飞等问题

解决VRM格式模型在Unity中运行出现头发乱飞等问题

1、问题 通过VRoidStudio制作导出的vrm格式的模型&#xff0c;放在unity中使用时&#xff0c;一运行就会出现头发乱飞&#xff0c;没有自然下垂的问题 2、解决方法 将模型下的secondary中的所有VRM Spring Bone脚本中的Drag Force改为1&#xff0c;Hit Radius改为0 修改后…
阅读更多...
JAVA笔记 | 实际上用到的策略模式(可直接套用)

JAVA笔记 | 实际上用到的策略模式(可直接套用)

自己开发中用到了策略模式&#xff0c;这样写不一定是最好的&#xff0c;但是满足了业务场景跟使用要求&#xff0c;做个笔记&#xff0c;下次有用到可以快速复习跟套用 假设使用场景&#xff1a;有几只宠物&#xff0c;猫跟狗等&#xff0c;要求他们做各种动作&#xff0c;比如…
阅读更多...
828华为云征文 | 华为云Flexus云服务器X实例搭建Zabbix网络设备监视系统（Ubuntu服务器运维）

828华为云征文 | 华为云Flexus云服务器X实例搭建Zabbix网络设备监视系统（Ubuntu服务器运维）

前言 Flexus X实例内嵌智能应用调优算法&#xff0c;性能强悍&#xff0c;基础模式GeekBench单核及多核跑分可达同规格独享型实例的1.6倍&#xff0c;性能模式更是超越多系列旗舰型云主机&#xff0c;为企业业务提供强劲动力。 &#x1f4bc; Flexus X Zabbix&#xff1a;打造…
阅读更多...
PWM驱动LED呼吸灯

PWM驱动LED呼吸灯

背景知识&#xff1a;TIM输出比较-CSDN博客 stm32f10x_tim.h函数 // *** OC是Output Compare输出比较函数 void TIM_OC1Init(TIM_TypeDef* TIMx, TIM_OCInitTypeDef* TIM_OCInitStruct); void TIM_OC2Init(TIM_TypeDef* TIMx, TIM_OCInitTypeDef* TIM_OCInitStruct); void TI…
阅读更多...
苹果盛宴：iPhone 16系列领衔，智能穿戴新潮流来袭

苹果盛宴：iPhone 16系列领衔，智能穿戴新潮流来袭

在科技界备受瞩目的苹果秋季发布会上&#xff0c;众多新品悉数亮相&#xff0c;从全新的Apple Watch系列到AirPods系列&#xff0c;再到备受期待的iPhone 16系列&#xff0c;每一款产品都以其独特的创新和卓越的性能&#xff0c;再次定义了智能设备的高标准。 本文将带您领略这…
阅读更多...
实验5 预备实验2-配置单个的路由器

实验5 预备实验2-配置单个的路由器

配置单个的路由器 一、实验目的 此次试验目的是了解思科网络设备的配置基本特点及IOS命令基本操作方法。这些是配置思科设备的重要前提。 二、实验内容及结果 1、实验环境搭建 添加一个模块化的路由器&#xff0c;单击Packet Tracer 5.3的工作区中刚添加的路由器&#xff0c;…
阅读更多...
Go实现RabbitMQ消息模式

Go实现RabbitMQ消息模式

【目标】 go实现RabbitMQ简单模式和work工作模式 go实现RabbitMQ 消息持久化和手动应答 go实现RabbitMQ 发布订阅模式 go使用MQ实现评论后排行榜更新 1. go实现简单模式 编写路由实现生产消息 实现生产消息 MQ消息执行为命令行执行&#xff0c;所以创建命令行执行函数mai…
阅读更多...
【React】react项目中的redux使用

【React】react项目中的redux使用

1. store目录结构设计 2. react组件中使用store中的数据——useSelector 3. react组件中修改store中的数据——useDispatch 4. 示例 react-basic\src\store\moduels\counterStore.js import { createSlice } from reduxjs/toolkitconst counterStore createSlice({name: cou…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023