Springboot整合WebSocket经典案例

最新推荐文章于 2024-09-09 21:00:00 发布
最新推荐文章于 2024-09-09 21:00:00 发布
阅读量1.3k 收藏 6
点赞数 1
CC 4.0 BY-SA版权
分类专栏： Java 文章标签： springboot websocket
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/CSU_hjh/article/details/119139346
本文介绍WebSocket的基础概念，演示如何在Spring Boot项目中实现不同场景下的消息传递，包括自我发送、群发和一对一发送。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

Springboot整合WebSocket经典案例

WebSocker简介

WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455，并由RFC7936补充规范。WebSocket API也被W3C定为标准。WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

案例分析

外部依赖包的导入


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

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.76</version>
        </dependency>

application配置端口

server:
  port: 9999

WebSocket配置类

package school.csu.websocketexample;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class WebsocketexampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(WebsocketexampleApplication.class, args);
    }

}

编写静态界面

在这里插入图片描述
页面内容及注释

<!DOCTYPE HTML>
<html>
<head>
    <title>My WebSocket</title>
</head>

<body>
<input id="text" type="text" />
<!--发送消息按钮-->
<button onclick="send()">Send</button>
<!--关闭连接按钮-->
<button onclick="closeWebSocket()">Close</button>
<!--显示消息-->
<div id="message"></div>
</body>

<script type="text/javascript">
    var websocket = null;

    //判断当前浏览器是否支持WebSocket, 主要此处要更换为自己的地址
    if ('WebSocket' in window) {
        websocket = new WebSocket("ws://localhost:9999/sendMessage/one");
    } else {
        alert('Not support websocket')
    }

    //连接发生错误的回调方法
    websocket.onerror = function() {
        setMessageInnerHTML("error");
    };

    //连接成功建立的回调方法
    websocket.onopen = function(event) {
        //setMessageInnerHTML("open");
    }

    //接收到消息的回调方法
    websocket.onmessage = function(event) {
        setMessageInnerHTML(event.data);
    }

    //连接关闭的回调方法
    websocket.onclose = function() {
        setMessageInnerHTML("close");
    }

    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function() {
        websocket.close();
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //关闭连接
    function closeWebSocket() {
        websocket.close();
    }

    //发送消息
    function send() {
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>

案例一：自己给自己发送消息

相关代码以及注释讲解

package school.csu.websocketexample.component;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 前后端交互实现消息发送给自己
 */




@Slf4j
@ServerEndpoint("/sendMessage/one")//@ServerEndpoint注解是服务端与客户端交互的关键，其值(/sendMessage/one)得与index页面中的请求路径对应。
@Component
public class OneToOneWebSocket {
    //静态变量记录当前连接数
    private static AtomicInteger onlineCount = new AtomicInteger(0);


    /**
     * 连接建立成功调用的方法
     * @param session
     */
    @OnOpen
    public void onOpen(Session session){
        onlineCount.incrementAndGet();//连接数自动+1
        //打印日志
        log.info("有新连接加入：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        onlineCount.decrementAndGet(); // 在线数减1
        log.info("有一连接关闭：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }


    /**
     * 收到客户端消息后调用的方法
     *
     * @param message
     *            客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("服务端收到客户端[{}]的消息:{}", session.getId(), message);
        this.sendMessage("Hello, " + message, session);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }

    /**
     * 服务端发送消息给客户端
     */
    private void sendMessage(String message, Session toSession) {
        try {
            log.info("服务端给客户端[{}]发送消息{}", toSession.getId(), message);
            toSession.getBasicRemote().sendText(message);
        } catch (Exception e) {
            log.error("服务端发送消息给客户端失败：{}", e);
        }
    }

}

效果演示
在这里插入图片描述

案例二：群发消息（不包括自己）

package school.csu.websocketexample.component;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 
 * 前后端交互的类实现消息的接收推送(自己发送给所有人(不包括自己))
 * 
 * @ServerEndpoint(value = "/sendMessage/oneToMany") 前端通过此URI 和后端交互，建立连接
 */
@Slf4j
@ServerEndpoint(value = "/sendMessage/oneToMany")
@Component
public class OneToManyWebSocket {

    /** 记录当前在线连接数 */
    private static AtomicInteger onlineCount = new AtomicInteger(0);

    /** 存放所有在线的客户端 */
    private static Map<String, Session> clients = new ConcurrentHashMap<>();

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        onlineCount.incrementAndGet(); // 在线数加1
        clients.put(session.getId(), session);
        log.info("有新连接加入：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        onlineCount.decrementAndGet(); // 在线数减1
        clients.remove(session.getId());
        log.info("有一连接关闭：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message
     *            客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("服务端收到客户端[{}]的消息:{}", session.getId(), message);
        this.sendMessage(message, session);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }

    /**
     * 群发消息
     * 
     * @param message
     *            消息内容
     */
    private void sendMessage(String message, Session fromSession) {
        for (Map.Entry<String, Session> sessionEntry : clients.entrySet()) {
            Session toSession = sessionEntry.getValue();
            // 排除掉自己
            if (!fromSession.getId().equals(toSession.getId())) {
                log.info("服务端给客户端[{}]发送消息{}", toSession.getId(), message);
                toSession.getAsyncRemote().sendText(message);
            }
        }
    }}

另外注意吧index.html的v这里也改一下

        websocket = new WebSocket("ws://localhost:9999/sendMessage/oneToMany");

演示效果（同时打开三个窗口，控制台打印如下）
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

案例三：一对一进行发送

package school.csu.websocketexample.component;

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;

/**
 * 前后端交互的类实现消息的接收推送(自己发送给另一个人)
 *
 * @ServerEndpoint(value = "/test/oneToOne") 前端通过此URI 和后端交互，建立连接
 */



import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import school.csu.websocketexample.domain.MyMessage;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;


@Slf4j
@ServerEndpoint(value = "/sendMessage/oneToAnotherOne")
@Component
public class OneToAnotherOneWebSocket {

    /** 记录当前在线连接数 */
    private static AtomicInteger onlineCount = new AtomicInteger(0);

    /** 存放所有在线的客户端 */
    private static Map<String, Session> clients = new ConcurrentHashMap<>();

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        onlineCount.incrementAndGet(); // 在线数加1
        clients.put(session.getId(), session);
        log.info("有新连接加入：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        onlineCount.decrementAndGet(); // 在线数减1
        clients.remove(session.getId());
        log.info("有一连接关闭：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message
     *            客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("服务端收到客户端[{}]的消息[{}]", session.getId(), message);
        try {
            MyMessage myMessage = JSON.parseObject(message, MyMessage.class);
            if (myMessage != null) {
                Session toSession = clients.get(myMessage.getUserId());
                if (toSession != null) {
                    this.sendMessage(myMessage.getMessage(), toSession);
                }
            }
        } catch (Exception e) {
            log.error("解析失败：{}", e);
        }
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }

    /**
     * 服务端发送消息给客户端
     */
    private void sendMessage(String message, Session toSession) {
        try {
            log.info("服务端给客户端[{}]发送消息[{}]", toSession.getId(), message);
            toSession.getBasicRemote().sendText(message);
        } catch (Exception e) {
            log.error("服务端发送消息给客户端失败：{}", e);
        }
    }

}

这里记得修改一下

        websocket = new WebSocket("ws://localhost:9999/sendMessage/oneToAnotherOne");

在这里插入图片描述
在这里插入图片描述
差不多就这些啦~之后要用到我们实际的项目呢之中去哦。

Spring Boot整合WebSocket全面指南：从基础到高级实战
专注Java开发与国产数据库技术分享，涵盖达梦DM8/OceanBase/GaussDB核心原理与实战，兼及DeepSeek大模型部署、YOLOv11训练等AI技术，为开发者提供从基础到进阶的技术干货。
05-14 2584
WebSocket是一种在单个TCP连接上实现全双工通信的协议，解决了HTTP协议在实时通信中的局限性。与HTTP的请求-响应模式不同，WebSocket允许服务器主动向客户端推送数据，实现真正的双向通信。其特点包括一次握手、持久连接、轻量级数据帧头（2-10字节）以及支持文本和二进制数据传输。相比之下，HTTP长轮询需要频繁建立连接，实时性较差，且头部开销较大。WebSocket的握手过程通过HTTP协议完成，握手成功后，双方可以通过该连接自由发送数据帧。在Spring Boot中，可以通过添加依赖、配置
大数据项目中 Eureka 的服务治理框架搭建
最新发布
AI天才研究院
04-30 784
随着大数据处理规模的爆炸式增长，传统单体架构已难以应对高并发、低延迟和弹性扩展的需求。微服务架构通过将复杂系统拆分为独立部署的服务单元，显著提升了开发效率和系统灵活性，但也引入了服务间通信、故障处理和动态管理等挑战。Eureka 作为服务治理的核心组件，提供了服务注册、发现、负载均衡和健康检查等关键功能，是构建可扩展大数据平台的基础设施。本文将深入解析 Eureka 的技术原理，通过实战案例演示如何在大数据项目中搭建高可用的服务治理框架，并探讨其在实时计算、分布式存储等场景中的优化实践。背景介绍。
springboot集成websocket的简单例子
03-02
一个springboot集成websocket的简单例子，好多网上资源无法用，特上传
SpringBoot 整合WebSocket 简单实战案例
默默不代表沉默
06-24 5万+
先看项目目录结构： ------接下来，我们开始整合WebSocket------ 先是pom.xml添加依赖： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket&lt...
Springboot集成websocket实例
蜂蜜柚子茶
11-25 1982
一、简介 WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。 WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在 WebSocket API 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。 在 WebSocket API 中，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。 WebSocket
springboot websocket示例
feinifi的博客
08-19 1043
springboot项目如果要加入websocket，只需要在普通的依赖基础上，加上spring-boot-starter-websocket即可。 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency>...
springboot-websocket实战案例
01-12
该项目采用springboot+websocket 实现聊天小案例。 包括 springboot+websocket 实现服务端代码、html5 连接websocket客户端、springboot后台连接websockete客户端代码。
基于springboot的纺织品企业财务管理系统源码数据库.zip
03-09
它集成了大量的常用组件，如数据访问、安全、WebSocket等，极大地降低了开发复杂性。SpringBoot的核心特性包括自动配置、嵌入式Web服务器、运行时指标以及命令行界面等。 二、SSM框架整合 SSM（Spring、SpringMVC、...
云E办Springboot+vue——前端项目完整版（含源码）
热门推荐
涵盖了计算机专业基础知识、数学建模相关实践、复杂网络论文研究、LeetCode算法刷题经验、C语言开发经验、前端Vue、React框架开发实战相关知识
08-10 5万+
本项目基于Vue+Spring Boot构架一个前后端分离项目。前端使用社区非常活跃的开源框架vue进行构建。受疫情的影响，许多企业由线上办公转为线下办公。随着线上办公的人数的增多，线上办公的优点逐步凸显：通过实现工作流程的自动化、节省企业办公费用、实现绿色办公，同时提升办公效率。前端使用的技术有： Vue、Vue-cli、Vuex、VueRouter、ElementUI、Axios、ES6、Webpack、WebSocket、font-awesome、js-file-download、vue-chat 项
2021 SpringBoot历史最详细图文教学（一）
qq_25083447的博客
01-07 1409
心心相印 → 印贼作父 → 父相伤害 → 害想咋滴 一篇文章让你0基础精通SpringBoot，害想咋滴？（白嫖有罪，记得点赞） SpringBoot由于学习的内容比较多，我会分成多个章节来写。 不详细记得叫人打我 不详细一定要叫人打我 不详细千万记得叫人打我 一、Spring Boot入门 1.1、SpringBoot简介 Spring Framework   Spring Framework是轻量级的框架。无需开发重量级的 EnterpriseJavaBean（EJB），通过依赖注入和面向切面编程
SpringBoot项目集成指南：一站式框架功能与业务实现
在线聊天室是展示实时通信能力的经典案例。SpringBoot项目中的聊天室DEMO可能包含多种实现方案，例如基于Netty、WebSocket和长轮训的实现，以满足不同的使用场景和需求。 6. ElasticSearch调用实现： Elastic...
SpringBoot2.0开发WebSocket应用完整示例
05-04
java及html源码 博文链接：https://wallimn.iteye.com/blog/2425666
Spring Boot 使用 WebSocket示例
allway2的博客
02-01 1966
Introduction to WebSocket with Spring Boot | SpringHowhttps://springhow.com/spring-boot-websocket/ 让我们看看如何将 WebSocket 支持添加到 Spring Boot 应用程序中。我们将尝试创建一个简单的聊天应用程序。请注意，此实现不使用 STOMP。 什么是 WebSocket？ WebSocket 协议有助于通过单个 TCP 连接在客户端和服务器之间建立全双工双向通信。该协议与 HTTP 不同，
Springboot超仔细整合websocket(附案例代码) 搭建一个性能强大的消息推送系统
qq_55272229的博客
06-30 1万+
添加依赖：确保在pom.xml中添加Spring WebSocket和WebSocket依赖。创建WebSocket处理器(端点)：编写一个处理WebSocket消息的处理器。完成对应的生命周期如果需要传递http第一次握手时候处理信息 需要添加对应的处理配置配置WebSocket：配置WebSocket相关的Bean和端点(值得注意的是每一个端点对象对一个用户线程 所以spring的单实列bean和异步处理再这里无法生效 具体会在踩坑笔记中提及)
SpringBoot集成WebSocket （简单例子）
Payne Yu的博客
10-16 1480
一、 WebSocket简介 什么是WebSocket? WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信——允许服务器主动发送信息给客户端。 为什么需要 WebSocket? 因为 HTTP 协议有一个缺陷：通信只能由客户端发起，HTTP 协议做不到服务器主动向客户端推送信息。 二、 WebSocket简单实现 使用websocke...
springboot+websocket最简单实用案例
A_Xi_Baa的博客
05-12 485
效果图，后端推送到前端，页面无请求自动刷新 springboot端 pom.xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> WebSocketConfig.java import org
Springboot整合websocket(附详细案例代码)
weixin_46425661的博客
09-09 1万+
本文主要介绍WebSocket的概念，和在springboot项目中的使用。
SpringBoot整合WebSocket的简单示例
qq_35359663的博客
01-24 916
两种方式（原生注解和Spring封装）实现的WebSocket通信的示例
SpringBoot整合Websocket综合示例项目
oNew_Lifeo的博客
08-23 1036
项目场景是每个系统用户有多条流水线项目，每条流水线可以进行构建操作，后端模拟构建接口，实时修改当前构建流水线的状态，由初始化 -》运行中-》成功或失败，前端能够实时展示流水线状态。一般网站实现该功能都是采用轮询的方式，在一定的时间间隔内频繁获取流水线列表已此来达到"实时展示"的效果
SpringBoot整合WebSocket实现在线通信
资源摘要信息:"SpringBoot集成WebSocket详细解析" 在现代Web应用中，WebSocket协议提供了一种在单个TCP连接上进行全双工通讯的方式。与传统的HTTP协议相比，WebSocket能实现服务端向客户端推送信息，适合需要实时...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值