Spring Boot项目中WebSocket快速入门

最新推荐文章于 2025-04-13 22:21:32 发布

东山-CDS

最新推荐文章于 2025-04-13 22:21:32 发布

阅读量1.9k

点赞数 9

分类专栏： Spring 文章标签：服务器网络运维 websocket

本文链接：https://blog.youkuaiyun.com/2301_77251217/article/details/145949879

版权

Spring 专栏收录该内容

5 篇文章

订阅专栏

一、WebSocket简介与特点

WebSocket 是一种网络通信协议，用于在客户端（通常是浏览器）和服务器之间建立全双工、双向的通信通道——即一次握手两者之间就可以创建持久性的连接，且能够实时双向的交换数据，基于TCP协议使得其具有可靠性。
为了方便理解，我们以短连接的HTTP为例，短连接的HTTP常用于B/C架构，客户端每次向浏览器请求都需要建立和关闭 TCP 连接，并且这种连接为单向的短连接，好比笔者和女神发微信，女神不会主动和笔者联系，笔者每发出一次消息女神只会回答一次，随后就断开连接。
而WebSocket则是双向的长连接，好比笔者和朋友打电话，一旦电话接通就可以你一句我一句双向交换信息直至本次通话结束，双方都断开连接。

二、入门案例

客户端页面编写

<!DOCTYPE HTML>
<html>
<head>
    <meta charset="UTF-8">
    <title>WebSocket Demo</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>

客户端部分比较简单，主要通过握手与服务器创建连接，可以看到，不同于常见的浏览器请求http,这里通过ws://localhost:8080向本地服务器握手，ws即websocket缩写。除此之外都是一些基本的回调函数，和事件监听，这里前端入门的朋友都可以轻松看懂，没有入门结合注释也不难理解。

导入websocket的maven坐标（version标签根据需要自己来确定）

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

编写服务端组件

import org.springframework.stereotype.Component;
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/**
 * WebSocket服务
 */
@Component
@ServerEndpoint("/ws/{sid}")//路径匹配
public class WebSocketServer {

    //存放会话对象
    private static Map<String, Session> sessionMap = new HashMap();

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("sid") String sid) {
        System.out.println("客户端：" + sid + "建立连接");
        sessionMap.put(sid, session);
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, @PathParam("sid") String sid) {
        System.out.println("收到来自客户端：" + sid + "的信息:" + message);
    }

    /**
     * 连接关闭调用的方法
     *
     * @param sid
     */
    @OnClose
    public void onClose(@PathParam("sid") String sid) {
        System.out.println("连接断开:" + sid);
        sessionMap.remove(sid);
    }

    /**
     * 群发
     *
     * @param message
     */
    public void sendToAllClient(String message) {
        Collection<Session> sessions = sessionMap.values();
        for (Session session : sessions) {
            try {
                //服务器向客户端发送消息
                session.getBasicRemote().sendText(message);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

}

服务端的操作和客户端类似，需要注意的有两点

@ServerEndpoint注解：用来路径匹配，接收客户端握手请求，并且在 Spring 框架中，使用 @ServerEndpoint 注解的 WebSocket 服务类（如此处的 WebSocketServer 类）需要额外的配置类来启用和管理 WebSocket 支持。

Session类：一个来自 Java WebSocket API 的类，它代表了一个 WebSocket 连接的会话（Session）。每个 Session对象对应一个客户端与服务器之间的连接，包含了与该连接相关的状态信息和操作方法。
组件的最后有一个sendToAllClient的方法用来向客户端群发消息，即遍历了我们一开始在sessionMap中存储的session并调用其getBasicRemote方法向客户端发送消息。

对于其他的注解则与客户端回调函数相似，满足条件时触发。

配置类书写——第三方Bean导入

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

/**
 * WebSocket配置类，用于注册WebSocket的Bean
 */
@Configuration
public class WebSocketConfiguration {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}

为什么要这个配置类才能启用呢？
@ServerEndpoint 是 Java WebSocket API 的一部分，而不是 Spring 的原生注解。Spring 需要通过配置类来集成 Java WebSocket API，并将其纳入 Spring 的生命周期管理。

编写定时任务类进行测试（其他类测试也可以）

import com.sky.websocket.WebSocketServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@Component
public class WebSocketTask {
    @Autowired
    private WebSocketServer webSocketServer;

    /**
     * 通过WebSocket每隔5秒向客户端发送消息
     */
    @Scheduled(cron = "0/5 * * * * ?")
    public void sendMessageToClient() {
        webSocketServer.sendToAllClient("这是来自服务端的消息：" + DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalDateTime.now()));
    }
}

定时任务类不理解的详见Maven 项目中Spring Task 的简单配置和快速入门-优快云博客