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

websocket 在spingboot 中使用

news 2026/3/27 1:10:41

websocket 在spingboot 中使用

springboot 中已存在 websocket 的依赖，不需要添加额外的依赖。

内容部分

config 配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;/*** @author * @description WebSocketConfig* @date 2026-02-06 14:56*/
@Configuration
public class WebSocketConfig {/*** 注册ServerEndpointExporter，让Spring扫描@ServerEndpoint注解* SpringBoot内置容器（Tomcat/Jetty）必须加，外部容器可省略*/@Beanpublic ServerEndpointExporter serverEndpointExporter() {return new ServerEndpointExporter();}
}

server 配置

在同一个server 中只能进行同一个业务操作，也只能使用同一个ConcurrentHashMap，
如果使用相同的map，在进行广播的时候，则会影响到其他的业务操作。
可以在 @ServerEndpoint("/ws/connect") 中进行配置，进行多个业务连接通信。

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;/*** @author * @description WebSocketServer* WebSocket服务端*  * @ServerEndpoint：指定WebSocket连接路径，前端通过 ws://ip:端口/ws/connect 连接*  ws://localhost:8321/ws/connect*  * @Component：让Spring管理这个Bean，配合ServerEndpointExporter扫描* @date 2026-02-06 14:57*/
@Slf4j
@ServerEndpoint("/ws/connect")
@Component
public class WebSocketServer {// 存储所有在线会话：key=会话ID，value=会话对象（ConcurrentHashMap保证线程安全）private static final Map<String, Session> ONLINE_SESSIONS = new ConcurrentHashMap<>();// 会话ID（每个连接唯一）private String sessionId;/*** 【核心】连接建立成功时触发** @param session 会话对象：代表当前客户端与服务端的WebSocket连接*/@OnOpenpublic void onOpen(Session session) {this.sessionId = session.getId();ONLINE_SESSIONS.put(sessionId, session);log.info("WebSocket连接建立：会话ID={}，当前在线人数={}", sessionId, ONLINE_SESSIONS.size());// 连接成功后，主动给客户端回传一条消息sendMessageToClient(session, "恭喜，WebSocket连接成功！会话ID：" + sessionId);}/*** 【核心】接收客户端发送的消息时触发** @param message 客户端发送的消息内容* @param session 当前客户端会话*/@OnMessagepublic void onMessage(String message, Session session) {log.info("收到客户端消息：会话ID={}，消息内容={}", sessionId, message);// 方式1：给当前客户端**回传消息**（回声测试，最基础）sendMessageToClient(session, "服务端已收到你的消息，内容：" + message);// 方式2：**广播消息**（给所有在线客户端发送，可选测试）// broadcastMessage("【会话ID=" + sessionId + "】：" + message);}/*** 【核心】连接关闭时触发（客户端关闭页面/主动断开）*/@OnClosepublic void onClose(Session session) {ONLINE_SESSIONS.remove(sessionId);log.info("WebSocket连接关闭：会话ID={}，当前在线人数={}", sessionId, ONLINE_SESSIONS.size());}/*** 【核心】WebSocket连接发生异常时触发** @param error 异常对象*/@OnErrorpublic void onError(Session session, Throwable error) {log.error("WebSocket连接异常：会话ID={}，异常信息={}", sessionId, error.getMessage(), error);ONLINE_SESSIONS.remove(sessionId);}// 私有方法：给单个客户端发送消息private void sendMessageToClient(Session session, String message) {try {// getBasicRemote()：同步发送消息；getAsyncRemote()：异步发送（推荐高并发）session.getBasicRemote().sendText(message);} catch (Exception e) {log.error("给客户端发送消息失败：会话ID={}", sessionId, e);}}// 公有方法：广播消息（给所有在线客户端，可选测试）public void broadcastMessage(String message) {ONLINE_SESSIONS.values().forEach(session -> sendMessageToClient(session, message));}
}

测试

采取 Schedule 发送定时任务方式判断是否可以获取到服务端发送的内容，代码如下

import cn.hutool.core.date.DateUtil;
import cn.hutool.core.util.IdUtil;
import com.lt.ws.server.WebSocketServer;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;import java.util.Date;/*** @author * @description WsTask* @date 2026-02-06 15:09*/
@Component
@Slf4j
public class WsTask {@Autowiredprivate WebSocketServer webSocketServer;private final static int synDataTime = 30 * 60 * 1000;//    private final static  int pushDataTime = 10 * 60 * 1000;private final static int pushDataTime = 10 * 1000;@Scheduled(fixedRate = pushDataTime)public void task1() {log.info("测试任务执行");}private static String getCurrentStrTime() {return DateUtil.format(new Date(), "yyyy-MM-dd HH:mm:ss");}/*** 发送广播消息*/@Scheduled(fixedRate = pushDataTime)public void pushWsBroadcastMessage() {this.webSocketServer.broadcastMessage(getCurrentStrTime() + " :: " + IdUtil.fastUUID());}
}