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

已于 2024-10-10 11:09:24 修改
阅读量1.1k 收藏 22
点赞数 28
分类专栏： SpringBoot实战教程 文章标签： websocket spring boot 网络协议
于 2024-09-27 16:42:56 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/print_helloword/article/details/142597383
版权

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 注解的类
    @Bean
    public 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 会话
     */
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        webSocketSet.add(this); // 将新的连接加入集合
        System.out.println("新连接建立: " + session.getId());
        sendMessage("连接成功");
    }

    /**
     * 客户端发送消息时调用
     * @param message 客户端发来的消息
     */
    @OnMessage
    public 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 会话
     */
    @OnClose
    public 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;
    }

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 注册自定义的 WebSocketHandler
        registry.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 会话
     */
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        sessions.add(session); // 保存新的连接
        session.sendMessage(new TextMessage("连接成功"));
        System.out.println("新连接建立: " + session.getId());
    }

    /**
     * 处理接收到的文本消息
     * @param session WebSocket 会话
     * @param message 接收到的消息
     */
    @Override
    public 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 关闭状态
     */
    @Override
    public 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 {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
        // 配置消息代理，处理前缀为 /topic 的消息
        config.enableSimpleBroker("/topic");
        // 配置应用程序前缀，发送消息的前缀
        config.setApplicationDestinationPrefixes("/app");
    }

    @Override
    public 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/messages
        return "服务器收到: " + 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，实现实时通信功能，让应用更加智能、高效。

推荐阅读

基于STOMP 协议的 WebSocket 实现传输长字符串

愤怒的代码
关注
专栏目录
Spring Boot 中文参考指南
分享技术干货和灵感、推荐新书和好玩的项目、分享Java面试题
02-08 8377
虽然Spring Boot 3.x第一个GA版本出来了，但一段时间内市面上依然还会以2.X版本为主，而2.7.8 是最后一个2.x的GA版本
spring-boot中文开发指南
11-16
在本指南中，你会学到以下几个核心知识点： 1. **Spring Boot基础**：理解Spring Boot的核心概念，如起步依赖、自动配置和嵌入式Web服务器。这些特性使得Spring Boot能够快速构建可运行的jar或war包，无需额外的...
WebSocket 集成 Spring Boot 的实战指南
Java_fenxiang的博客
10-15 523
???? 作者：知识浅谈，CSDN签约讲师&博客专家，华为云云享专家，阿里云专家博主，InfoQ签约作者 ???? 擅长领域：全栈工程师、爬虫、ACM算法，大数据，深度学习 ???? 公众号：知识浅谈 ????WebSocket 集成 Spring Boot 的实战指南????????引入依赖????配置WebSocket????实现WebSocket...
全面指南：利用Spring Boot、WebSocket和Stomp打造实时消息应用
weixin_48278764的博客
08-08 723
全面指南：利用Spring Boot、WebSocket和Stomp打造实时消息应用
Netty WebSocket HTTP Spring Boot Starter 教程
gitblog_00331的博客
09-12 420
Netty WebSocket HTTP Spring Boot Starter 教程 netty-websocket-http-spring-boot-starter ???? lightweight high-performance WebSocket http framework （ 轻量级、高性能的WebSocket及...
Spring Boot开发指南
深圳市多克创新科技有限公司
08-03 1222
Spring Boot使用的关键点
Netty-WebSocket-HTTP-Spring-Boot-Starter 教程
gitblog_01074的博客
09-12 400
Netty-WebSocket-HTTP-Spring-Boot-Starter 教程 netty-websocket-http-spring-boot-starter ???? lightweight high-performance WebSocket http framework （ 轻量级、高性能的WebSocket及...
一万字教程详解：教会你如何在 SpringBoot 中使用 WebSocket（典藏版）
weixin_44421461的博客
06-12 193
????这是一个或许对你有用的社群????一对一交流/面试小册/简历优化/求职解惑，欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料：《项目实战（视频）》：从书中学，往事中“练”《互联网高频面试题》：面朝简历学习，春暖花开《架构 x 系统设计》：摧枯拉朽，掌控面试高频场景题《精进 Java 学习指南》：系统学习，互联网主流技术栈《必读 Java 源码专栏》：知其然，知其所以然????这是一个或许...
Spring Boot WebSocket + WenRTC实现视频通话功能
weixin_44268792的博客
05-20 9776
参考书籍：HTML5 与 CSS3权威指南 初识WebRTC 实现让电话、电视及计算机都能够进行通信的公共平台，一个可以实现点对点视频聊天的Web应用程序，这就是WebRTC的目标。 WebRTC API是一个与getUserMedia方法紧密相关的API，它提供一种访问客户端本地的摄像头或麦克风设备的能力。 总体来说，WebRTC包含三个API： MediaStream(getUserMedia) RTCPeerConnection RTCDataChannel 手工建立WebRTC通信 WebR
Spring Boot “How-to“ 指南中文文档-上
qq_41939901的博客
01-10 1186
Spring Boot “How-to” Guides官方文档中文版。 解答了在使用 Spring Boot 时经常出现的 "我该怎么做...... "的问题。虽然没有面面俱到，但也涵盖了不少内容。
Spring Boot 参考指南
05-30
### Spring Boot 参考指南知识点解析 #### 一、Spring Boot 概览 - **Spring Boot** 是一个基于 Spring 平台的框架，旨在简化新 Spring 应用程序的初始设置和开发过程。 - **版本**：本指南适用于 1.3.0.BUILD-...
Spring-Boot-Reference-Guide, Spring Boot Reference Guide中文翻译 -《Spring Boot参考指南》.zip
10-10
《Spring Boot参考指南》是Spring Boot开发者的重要参考资料，它详细阐述了Spring Boot框架的核心特性、配置方式、自动配置原理以及如何构建微服务应用等关键知识点。Spring Boot是Java开发领域中一个极其流行的轻量...
Spring Boot视频网站：构建高性能的视频服务
最新发布
2401_85339615的博客
10-16 891
有了程序功能的操作，也需要对程序操作的各个功能所产生的数据信息存放在一个固定的仓库里面，这个所谓的仓库就是大家最熟悉的程序开发需要使用的数据库了，数据库能够发展到至今的模样，其实也是经历了很多的变化历程的，在最开始由于数据信息处理的需要开始推出最低级的数据管理，这个阶段也是数据库早期的人工管理的阶段，后来也经历了文件管理的阶段，这个阶段的数据管理因为信息不能够进行共享，加上管理的数据对配套的程序产生了较强的依赖性，在数据信息管理上也存在很多数据的重复记载造成数据冗余等问题。让自己步入一个更高的台阶！
在Spring Boot中具有多个实现的接口正确注入的六种方式
2301_76419561的博客
10-12 1108
以上六种方法各有优缺点，选择哪种方法取决于你的具体需求和偏好。在大多数情况下，使用@Autowired和@Qualifier注解是最直接和灵活的方式。然而，在某些情况下，使用@Primary注解、构造方法注入或Java配置类可能更合适。最后，将接口的所有实现注入到List或Map中提供了一种处理多个实现的强大方式。
确保Spring Boot定时任务只执行一次方案
2301_76419561的博客
10-14 573
确保Spring Boot定时任务只执行一次有多种方法，你可以根据实际需求选择最适合的方法。如果你需要更复杂的任务调度或周期性执行，@Scheduled注解和接口是更合适的选择。而对于一次性的初始化任务或应用程序启动任务，注解和实现接口则更为简洁明了。
Spring Boot集成Spring Security之自动装配
kfashfasf的博客
10-12 1046
使用Spring Boot集成Spring Security实现Servlet项目的安全个性化配置Spring Boot版本：2.7.18Spring Security版本：5.7.11。
Spring Boot 核心理解-profile
kk6891的博客
10-13 833
springBoot重新梳理和学习。为了面试。 加油。。。。。
Spring Boot在医疗病历B2B交互中的技术突破
2402_85761468的博客
10-12 1280
采用新的开发方式、先进的语言、完善的开发过程，可以最大限度的降低错误的引进，但还是不能完全的杜绝软件中有可能出现的错误，这些引入的错误需要通过测试找出来，系统中错误的密度也需要通过测试来进行估量。在设计过程的时候，我们一边读书，一边不断的思实考践中遇到的新问题，继续努力探讨的问题得到解决，在艰苦的工作和只能亲身体验到乐趣，而设计一个信息管理系统，不会一步到位，需要不断补充和完善，而且，仍然存在很多问题在系统中被发现，今后在实践应用中发现问题一定认真解决。在设计系统的过程中，存在一些错误是必然的。
自定义注解和组件扫描在Spring Boot中动态注册Bean（二）
2301_76419561的博客
10-13 759
自定义注解是一种强大的工具，它允许开发者定义自己的注解并在代码中使用它们，以实现特定的功能。在Spring Boot中，自定义注解可以用于动态注册Bean。首先，需要定义一个自定义注解。这个注解可以包含一些元信息，用于后续的处理。@Target(ElementType.TYPE) // 注解的目标为类@Retention(RetentionPolicy.RUNTIME) // 注解在运行时保留，可通过反射访问// 定义一个属性然后，在需要被动态注册为Bean的类上使用这个自定义注解。
Spring Boot中WebSocket客户端与服务端的实现指南
在Spring Boot中，WebSocket实例是通过WebSocketSession来表示的，每个session代表了一个服务端与客户端之间的会话。为了在会话中添加额外的信息，比如客户端的ID，需要实现一个WebSocket的包装类。这个包装类可以...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

愤怒的代码

如果您有受益，欢迎打赏博主😊

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值