百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

Spring Boot3 中 WebSocket 实现数据实时通信全解析

liuian 2025-07-17 20:39 3 浏览

各位互联网大厂的开发同仁们,在如今的互联网应用开发中,实时通信功能越来越重要。比如在线聊天、数据推送、实时通知等场景,都离不开高效的实时通信技术。而 WebSocket 作为一种高效的双向通信协议,在 Spring Boot3 中能够被轻松整合,从而实现强大的数据实时通信功能。今天,咱们就一起来深入探究一下 Spring Boot3 中如何整合 WebSocket。

WebSocket 简介

WebSocket 是一种网络通信协议,它建立在 TCP 协议之上,与 HTTP 协议有良好的兼容性。其数据格式轻量,性能开销小,并且支持发送文本和二进制数据 ,关键是没有同源限制,客户端可与任意服务器通信。与传统 HTTP 请求 - 响应模式不同,它提供全双工通信通道,允许服务器主动向客户端推送数据,实现双向实时通信。

Spring Boot3 整合 WebSocket 步骤

添加依赖

对于 Spring Boot 项目,若使用内嵌应用容器,引入
spring-boot-starter-websocket依赖即可

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

若部署在独立容器中,如 Tomcat 或 Jetty 等,Spring Boot 假设 WebSocket 配置由容器负责。

配置 WebSocket

MVC 应用中的配置:在基于 Spring MVC 的应用里,创建一个 WebSocket 配置类并实现WebSocketConfigurer接口来注册自定义处理器。

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 {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new CustomWebSocketHandler(), "/ws").setAllowedOrigins("*");
    }
}

上述配置中,定义了 WebSocket 路径/ws用于客户端连接,CustomWebSocketHandler则用于处理 WebSocket 消息。

定义消息处理类:以简单的消息回显功能为例,创建CustomWebSocketHandler类

import org.springframework.web.socket.handler.TextWebSocketHandler;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;

public class CustomWebSocketHandler extends TextWebSocketHandler {
    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        String clientMessage = message.getPayload();
        session.sendMessage(new TextMessage("echo: " + clientMessage));
    }
}

该类继承TextWebSocketHandler,实现了将接收到的客户端消息回显给客户端的功能。

Reactive 应用中的 WebSocket 支持

在基于 Reactive 模式的应用中,Spring Boot 通过 WebFlux 提供 WebSocket 支持。需引入jakarta.websocket-api和
spring-boot-starter-webflux依赖。

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

其配置与 MVC 略有不同,可通过 router 函数配置 WebSocket 路径并定义处理器

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.handler.SimpleUrlHandlerMapping;
import org.springframework.web.reactive.socket.WebSocketHandler;
import org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter;
import java.util.Map;

@Configuration
public class ReactiveWebSocketConfig {
    @Bean
    public SimpleUrlHandlerMapping webSocketMapping(CustomReactiveWebSocketHandler handler) {
        return new SimpleUrlHandlerMapping(Map.of("/ws", handler), -1);
    }
    @Bean
    public WebSocketHandlerAdapter handlerAdapter() {
        return new WebSocketHandlerAdapter();
    }
}

接着定义WebSocketHandler实现类处理消息

import org.springframework.web.reactive.socket.WebSocketHandler;
// 后续代码省略

测试 WebSocket 功能

启动 Spring Boot 应用:完成上述配置和代码编写后,启动 Spring Boot 应用。前端测试:编写简单的 HTML 页面测试 WebSocket 连接和消息收发。例如。

<!DOCTYPE html>
<html lang="en">
<head>
    <title>WebSocket测试</title>
</head>
<body>
<div>
    <h2>WebSocket测试页面</h2>
    <div>
        <input type="text" id="messageInput" placeholder="输入消息">
        <button onclick="sendMessage()">发送</button>
    </div>
    <div id="messages" style="margin-top: 20px;"></div>
</div>

<script>
    let ws = null;

    function connect() {
        ws = new WebSocket('ws://localhost:8080/ws');

        ws.onopen = function () {
            console.log('WebSocket连接已建立');
            appendMessage('系统消息:连接已建立');
        };

        ws.onmessage = function (event) {
            appendMessage('收到消息:' + event.data);
        };

        ws.onclose = function () {
            console.log('WebSocket连接已关闭');
            appendMessage('系统消息:连接已关闭');
        };

        ws.onerror = function (error) {
            console.error('WebSocket错误:', error);
            appendMessage('系统消息:连接发生错误');
        };
    }

    function sendMessage() {
        const messageInput = document.getElementById('messageInput');
        const message = messageInput.value;

        if (ws && message) {
            ws.send(message);
            appendMessage('发送消息:' + message);
            messageInput.value = '';
        }
    }

    function appendMessage(message) {
        const messagesDiv = document.getElementById('messages');
        const messageElement = document.createElement('div');
        messageElement.textContent = message;
        messagesDiv.appendChild(messageElement);
    }

    // 页面加载完成后连接WebSocket
    window.onload = connect;
</script>
</body>
</html>

打开浏览器访问该 HTML 页面,在输入框输入消息点击发送,即可看到消息发送到服务端并回显回来。

总结

通过以上步骤,咱们就成功在 Spring Boot3 中整合了 WebSocket 实现数据实时通信。各位开发小伙伴们,赶紧在自己的项目中实践起来吧!

相关推荐

Springboot 整合 Websocket 轻松实现IM及时通讯

一、方案实践集成分为三步:添加依赖、增加配置类和消息核心类、前端集成。1.1、添加依赖<dependency><groupId>org.springframework...

SpringBoot扩展——应用Web Socket!

应用WebSocket目前,网络上的即时通信App有很多,如QQ、微信和飞书等,按照以往的技术来说,即时功能通常会采用服务器轮询和Comet技术来解决。HTTP是非持久化、单向的网络协议,在建立连接...

【Spring Boot】WebSocket 的 6 种集成方式

介绍由于前段时间我实现了一个库【SpringCloud】一个配置注解实现WebSocket集群方案以至于我对WebSocket的各种集成方式做了一些研究目前我所了解到的就是下面这些了(就一个破w...

SpringBoot生产级WebSocket集群实践,支持10万连接!

1、问题背景智慧门诊系统旨在从一定程度上解决患者面临的三长一短(挂号、看病、取药时间长,医生问诊时间短)的问题。实现“诊前、诊中、诊后”实时智能一体化,整合完善医院工作流程。围绕门诊看病的各个环节,让...

Spring Boot3 中 WebSocket 实现数据实时通信全解析

各位互联网大厂的开发同仁们,在如今的互联网应用开发中,实时通信功能越来越重要。比如在线聊天、数据推送、实时通知等场景,都离不开高效的实时通信技术。而WebSocket作为一种高效的双向通信协议,在...

Java WebSocket 示例(java nio websocket)

一、环境准备1.依赖配置(Maven)在pom.xml中添加WebSocket依赖:xml<!--SpringBootWebSocket--><dependen...

Spring Boot整合WebSocket:开启实时通信之旅

SpringBoot整合WebSocket:开启实时通信之旅今天咱们来聊聊SpringBoot整合WebSocket这件大事儿。说到实时通信,你是不是第一时间想到QQ、微信这些聊天工具?没错,We...

Spring Boot3 竟能如此轻松整合 WebSocket 技术,你还不知道?

在当今互联网大厂的软件开发领域,实时通信的需求愈发迫切。无论是在线聊天应用、实时数据更新,还是协同办公系统,都离不开高效的实时通信技术支持。而WebSocket作为一种能够实现浏览器与服务器之间持...

Spring Boot集成WebSocket(springboot集成websocket)

一、基础配置依赖引入<dependency><groupId>org.springframework.boot</groupId><artifactId>...

Springboot下的WebSocket开发(springboot websocket server)

今天遇到一个需求,需要对接第三方扫码跳转。一种方案是前端页面轮询后端服务,但是这种空轮询会虚耗资源,实时性比较差而且也不优雅。所以决定使用另一种方案,websocket。以前就知道websocket,...

springboot websocket开发(java spring boot websocket)

maven依赖SpringBoot2.0对WebSocket的支持简直太棒了,直接就有包可以引入<dependency><groupId>org....

Python界面(GUI)编程PyQt5窗体小部件

一、简介在Qt(和大多数用户界面)中,“小部件”是用户可以与之交互的UI组件的名称。用户界面由布置在窗口内的多个小部件组成。Qt带有大量可用的小部件,也允许您创建自己的自定义和自定义小部件。二、小部件...

实战PyQt5: 014-下拉列表框控件QComboBox

QComboBox简介QComboBox下拉列表框,是一个集按钮和下拉列表选项于一体的部件。QComboBox提供了一种向用户呈现选项列表的方式,其占用最小量的屏幕空间。QComboBox中的常用方法...

Python小白逆袭!7天吃透PyQt6,独立开发超酷桌面应用

PythonGUI编程:PyQt6从入门到实战的全面指南在Python的庞大生态系统中,PyQt6作为一款强大的GUI(GraphicalUserInterface,图形用户界面)编程框架,为开...

如何用 PyQt6 打造一个功能完善的 SQLite 数据库管理工具

如何使用PyQt6和qt_material库,打造一个功能完善的SQLite数据库管理工具,轻松管理和查询SQLite数据库。一、目标数据库连接与表管理:支持连接SQLite数据库...