springboot 整合 websocket

快，把我桶也提着

于 2024-04-09 19:34:25 发布

阅读量1k

点赞数 8

本文链接：https://blog.csdn.net/qq_44140067/article/details/137560200

版权

本文介绍了如何在Springboot项目中集成WebSocket，包括添加依赖、启用WebSocket支持、配置WebSocketServer，以及进行测试。通过创建controller和index.html页面，展示了WebSocket的实时通信效果，包括人数增减的动态更新。

摘要由CSDN通过智能技术生成

添加 websocket 依赖

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

启用Springboot对WebSocket的支持

package com.vazquez.k8sclient.config;

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

/**
 * @Description
 * @Author vazquez
 * @DATE 2024/4/9 18:45
 */

@Configuration
public class WebSocketConfig {
   

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

核心配置：WebSocketServer

因为 WebSocket 是类似客户端服务端的形式（采用 ws 协议），那么这里的 WebSocketServer 其实就相当于一个 ws 协议的 Controller

package com.vazquez.k8sclient.websocket;

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

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;

/**
 * @Description
 * @Author vazquez
 * @DATE 2024/4/9 18:45
 */

@Slf4j
@Service
@ServerEndpoint("/api/websocket/{sid}")
public class WebSocketServer {
   
    //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;
    //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
    private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();

    //与某个客户端的连接会话，需要通过它来给客户端发送数据
    private Session session;

    //接收sid
    private String sid = "";

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("sid") String sid) {
   
        this.session = session;
        webSocketSet.add(this