Springboot中WebSocket用法

WebSocket

WebSocket 是一种基于 TCP 连接的协议，与 HTTP 请求-响应的单向通信模式不同，WebSocket 允许客户端（通常是浏览器）与服务器之间建立双向、持久的连接。通过一次握手，即可创建稳定的通信通道，实现高效的数据交互。

maven坐标

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

创建WebSocketServer类

/**
 * 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(“/ws/{sid}”)声明了当前类是一个 WebSocket 服务器端，并指定了 WebSocket 连接的 URL 路径
• sessionMap 是一个静态的 Map，用于存储所有 WebSocket 连接的 Session 对象，键为 sid（客户端唯一标识），值为 Session（客户端的 WebSocket 会话）。
• @OnOpen：表示该方法在 WebSocket 连接建立成功 时调用。
• @OnMessage：表示该方法在 服务器收到客户端消息 时调用。
• @OnClose：表示 WebSocket 连接关闭 时调用。
• @PathParam(“sid”) String sid：获取该消息所属的客户端 sid，方便识别消息来源。
• session.getBasicRemote().sendText(message);：使用 WebSocket 提供的 sendText() 方法，向每个客户端发送消息。

WebSocket配置类

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

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

}

ServerEndpointExporter是 Spring WebSocket 提供的一个 Bean，用于扫描带有 @ServerEndpoint 注解的 WebSocket 端点，并注册到 Spring 的 WebSocket 容器中。没有这个 Bean，@ServerEndpoint 标注的 WebSocket 端点不会生效！

定时任务类

@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()));
    }
}