当前位置：首页 > news >正文

springboot使用websocket

news 2025/6/28 16:46:30

文章目录

一、概述
- 1、简介
二、使用
- 1、引包
- 2、配置处理器
- 3、前端测试

一、概述

1、简介

简介略，附上官方文档，spring5和spring6的官方文档内容大致是一样的：
https://docs.spring.io/spring-framework/docs/5.2.25.RELEASE/spring-framework-reference/web.html#websocket
https://docs.spring.io/spring-framework/reference/6.1/web/websocket.html

二、使用

1、引包

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

2、配置处理器

创建WebSocket服务器可以实现WebSocketHandler或者，更有可能的是，扩展TextWebSocketHandler或者BinaryWebSocketHandler。以下示例使用TextWebSocketHandler

import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;import java.util.concurrent.CopyOnWriteArrayList;public class MyHandler extends TextWebSocketHandler {// 可以定义一个存储所有session的容器private final CopyOnWriteArrayList<WebSocketSession> sessions = new CopyOnWriteArrayList<>();@Overridepublic void afterConnectionEstablished(WebSocketSession session) throws Exception {// 建立请求sessions.add(session);System.out.println("Connection established: " + session.getId());}@Overrideprotected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {// 收到消息String payload = message.getPayload();System.out.println("Received message: " + payload);// 发送回复消息for (WebSocketSession s : sessions) {s.sendMessage(new TextMessage("Server received: " + payload));}}@Overridepublic void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {// 关闭链接sessions.remove(session);System.out.println("Connection closed: " + session.getId());}}

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {/*** 将前面的WebSocket处理程序映射到特定的URL*/@Overridepublic void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {registry.addHandler(myHandler(), "/myHandler")//.addInterceptors(new HttpSessionHandshakeInterceptor()) // 可以拦截session属性.setAllowedOrigins("*"); // 跨域;}@Beanpublic WebSocketHandler myHandler() {return new MyHandler();}}