Java高级 |【实验八】springboot 使用Websocket

coderSong25682025-06-09 1:30

隶属文章：Java高级 | （二十二）Java常用类库-CSDN博客

系列文章：Java高级 | 【实验一】Springboot安装及测试 |最新-CSDN博客

Java高级 | 【实验二】Springboot 控制器类+相关注解知识-CSDN博客

Java高级 | 【实验三】Springboot 静态资源访问-CSDN博客

Java高级 | 【实验四】Springboot 获取前端数据与返回Json数据-CSDN博客

Java高级 | 【实验五】Spring boot+mybatis操作数据库-CSDN博客

Java高级 | 【实验六】Springboot文件上传和下载-CSDN博客

Java高级 | 【实验七】Springboot 过滤器和拦截器-CSDN博客

目录

一、WebSocket

[1.1 HTTP协议 VS WebSocket协议](#1.1 HTTP协议 VS WebSocket协议)

[1.2 WebSocket 应用场景](#1.2 WebSocket 应用场景)

二、springboot中WebSocket实现

[2.1 服务端代码](#2.1 服务端代码)

1）引入websocket依赖

2）定义WebSocket服务端程序

5）在主类中添加定器的执行

[2.2 客户端代码](#2.2 客户端代码)

[2.3 测试](#2.3 测试)

一、WebSocket

WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工（full-duplex）通信 ，即允许服务器主动发送信息给客户端。因此，在WebSocket中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接 ，并进行双向数据传输，客户端和服务器之间的数据交换变得更加简单。

1.1 HTTP协议 VS WebSocket协议

HTTP WebSocket
连接类型 短连接 长连接
通信方式 单向，基于请求响应模式 支持双向通信
底层协议 TCP连接

1.2 WebSocket 应用场景

应用场景 说明
实时通信 非常适合需要实时通信的应用场景，例如，在线聊天室、即时消息传递和视频会议等应用中，用户可以通过WebSocket实时接收和发送消息。 比传统的HTTP轮询更高效，因为它不需要频繁地建立和关闭连接。
多用户游戏 提供快速、实时的游戏状态更新，提供流畅的游戏体验。
协同编辑 协同编辑应用，如Google Docs，允许多个用户同时编辑同一个文档。 WebSocket可以用来同步不同用户的编辑操作，确保所有用户都能看到最新的内容。
股票或货币交易平台 推送最新的交易数据，帮助交易者做出快速决策。
体育赛事直播 实时更新比分和比赛状态，为用户提供即时的比赛信息。
在线教育 实现实时的教学互动，如实时问答、投票和测验。

二、springboot 中 WebSocket 实现

2.1 服务端代码

1）引入 websocket 依赖

在pom.xml中引入如下依赖：

XML 复制代码 
<!--        引入websocket依赖-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-websocket</artifactId>
		</dependency>

导入依赖后，再启动运行，确保日志没有error

2） 定义WebSocket服务端 程序

创建一个名为WebSocketServer的类，其代码如下：

正常log不需要注释才能看到提示结果，我注释是因为当时idea有点问题，暂时没管

java 复制代码 
package com.example.sp_websocket;

import jakarta.websocket.*;
import jakarta.websocket.server.PathParam;
import jakarta.websocket.server.ServerEndpoint;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;

import java.io.IOException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
@Slf4j
@Component
@ServerEndpoint("/ws/{sid}")
public class WebSocketServer {
    private static Map<String, Session> sessionMap = new HashMap<>();
    /**
     * 连接建立时触发
     * @param session
     * @param sid
     */
    @OnOpen
    public void onOpen(Session session , @PathParam("sid") String sid){
//        log.info("有客户端连接到了服务器 , {}", sid);
        sessionMap.put(sid, session);
    }

    /**
     * 服务端接收到消息时触发
     * @param session
     * @param message
     * @param sid
     */
    @OnMessage
    public void onMessage(Session session , String message, @PathParam("sid") String sid){
//        log.info("接收到了客户端 {} 发来的消息 : {}", sid ,message);
    }
    /**
     * 连接关闭时触发
     * @param session
     * @param sid
     */
    @OnClose
    public void onClose(Session session , @PathParam("sid") String sid){
        System.out.println("连接断开:" + sid);
        sessionMap.remove(sid);
    }

    /**
     * 通信发生错误时触发
     * @param session
     * @param sid
     * @param throwable
     */
    @OnError
    public void onError(Session session , @PathParam("sid") String sid , Throwable throwable){
        System.out.println("出现错误:" + sid);
        throwable.printStackTrace();
    }
    /**
     * 广播消息
     * @param message
     * @throws IOException
     */
    public void sendMessageToAll(String message) throws IOException {
        Collection<Session> sessions = sessionMap.values();
        if(!CollectionUtils.isEmpty(sessions)){
            for (Session session : sessions) {
                //服务器向客户端发送消息
                session.getBasicRemote().sendText(message);
            }
        }
    }
}

3） 定义配置类，注册WebSocket的服务端

创建WebSocketConfig类，其代码如下：

java 复制代码 
package com.example.sp_websocket;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {

    /**
     * 注册基于@ServerEndpoint声明的Websocket Endpoint
     * @return
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    }
}

说明：如果ServerEndpointExporter无法正确识别，则在pom.xml文件删除tomcat的依赖。

4） 定义定时任务类，定时向客户端推送数据

编写 MessageTask 类，其代码如下：

java 复制代码 
package com.example.sp_websocket;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.io.IOException;
import java.time.LocalDateTime;
@Component
public class MessageTask {
    @Autowired
    private WebSocketServer webSocketServer;
    @Scheduled(cron = "0/5 * * * * ?")
    public void sendMessageToAllClient() throws IOException {
        System.out.println("sssss");
        webSocketServer.sendMessageToAll("Hello Client , Current Server Time : " + LocalDateTime.now());

    }
}

5）在主类中添加定器的执行

在SpWebsocketApplication类中添加定时器执行的注解，修改后的代码如下：

java 复制代码 
package com.example.sp_websocket;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class SpWebsocketApplication {

	public static void main(String[] args) {

		SpringApplication.run(SpWebsocketApplication.class, args);
	}

}

2.2 客户端代码

定义websocket.html页面充当客户端。

websocket.html存放在电脑上，比如，我放在了D盘。

java 复制代码 
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<input id="text" type="text" />
<button onclick="send()">发送消息</button>
<button onclick="closeWebSocket()">关闭连接</button>
<div id="message">
</div>
</body>
<script type="text/javascript">
    var websocket = null;
    var clientId = Math.random().toString(36).substr(2);
    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        //连接WebSocket节点
        websocket = new WebSocket("ws://localhost:8080/ws/"+clientId);
    }
    else{
        alert('Not support websocket')
    }
    //连接发生错误的回调方法
    websocket.onerror = function(){
        setMessageInnerHTML("error");
    };
    //连接成功建立的回调方法
    websocket.onopen = function(){
        setMessageInnerHTML("连接成功");
    }
    //接收到消息的回调方法
    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 send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
    //关闭连接
    function closeWebSocket() {
        websocket.close();
    }
</script>
</html>

2.3 测试

运行websocket.html。即双击websocket.html

相关推荐
愿你天黑有灯下雨有伞23 分钟前
告别复杂配置！Spring Boot优雅集成百度OCR的终极方案
spring boot·百度·ocr
我命由我123452 小时前
Kotlin 数据容器 - List（List 概述、创建 List、List 核心特性、List 元素访问、List 遍历）
java·开发语言·jvm·windows·java-ee·kotlin·list
武子康4 小时前
Java-80 深入浅出 RPC Dubbo 动态服务降级：从雪崩防护到配置中心秒级生效
java·分布式·后端·spring·微服务·rpc·dubbo
舒一笑5 小时前
我的开源项目-PandaCoder迎来史诗级大更新啦
后端·程序员·intellij idea
@昵称不存在6 小时前
Flask input 和datalist结合
后端·python·flask
zhuyasen6 小时前
Go 分布式任务和定时任务太难？sasynq 让异步任务从未如此简单
后端·go
东林牧之7 小时前
Django+celery异步：拿来即用，可移植性高
后端·python·django
何双新7 小时前
基于Tornado的WebSocket实时聊天系统：从零到一构建与解析
python·websocket·tornado
YuTaoShao7 小时前
【LeetCode 热题 100】131. 分割回文串——回溯
java·算法·leetcode·深度优先
源码_V_saaskw7 小时前
JAVA图文短视频交友+自营商城系统源码支持小程序+Android+IOS+H5
java·微信小程序·小程序·uni-app·音视频·交友
热门推荐
01Qwen3-Coder 快速上手教程 | Qwen Code + Claude Code02vue数据变化但页面不变03全球最强模型Grok4，国内已可免费使用！（附教程）04KGG转MP3工具|非KGM文件|解密音频05sqli-labs 靶场 less-8、9、10 第八关到第十关详解：布尔注入，时间注入06扣子开源本地部署教程 丨Coze智能体小白喂饭级指南07干翻 Typora！MilkUp：完全免费的桌面端 Markdown 编辑器！08【2025.7.18】更新vscode后所有.vue文件template标签后报红的临时解决办法，Vue - Official 插件3.0.2导致09ChatGPT Agent 完全使用指南：2025年7月最新功能详解10《魔兽世界》提示lua警告的含义及解决方法