springboot websocket 断线重连

### Spring Boot 中 WebSocket 自动重连的实现 在 Spring Boot 应用程序中，WebSocket 客户端可以通过特定机制来实现实时通信中的自动重连功能。以下是关于如何配置和实现这一特性的详细说明。 #### 配置 WebSocket 依赖 为了支持 WebSocket 功能，在 `pom.xml` 文件中需引入必要的依赖项[^1]： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 此依赖会提供构建 WebSocket 服务器所需的核心组件和支持。 --- #### 使用 Stomp Over WebSocket 协议 通常情况下，Spring Boot 提供了对 STOMP（Simple Text Oriented Messaging Protocol）的支持，这使得通过 WebSocket 进行消息传递更加方便。STOMP 是一种轻量级协议，适用于基于文本的消息传输场景。 要启用自动重连功能，可以利用 JavaScript 前端库 **SockJS** 和 **Stomp.js** 来处理客户端逻辑。这些工具提供了内置的功能用于检测断开连接并尝试重新建立连接。 以下是一个典型的前端代码示例，展示如何设置自动重连行为： ```javascript function connect() { var socket = new SockJS('/ws-endpoint'); // 替换为实际的 WebSocket 路径 stompClient = Stomp.over(socket); stompClient.connect({}, function (frame) { console.log('Connected: ' + frame); stompClient.subscribe('/topic/messages', function (message) { showMessage(JSON.parse(message.body)); }); }, function (error) { console.error('Connection failed, retrying...', error); setTimeout(connect, 5000); // 如果失败，则等待 5 秒后再次尝试连接 }); } // 页面加载完成后立即调用连接函数 document.addEventListener("DOMContentLoaded", connect); ``` 上述代码片段展示了当连接丢失时触发超时回调，并延迟一定时间后重新执行连接操作的过程[^2]。 --- #### 后端服务端实现 对于服务端部分，开发者无需额外编写复杂的逻辑即可支持客户端发起的多次连接请求。只需按照标准流程定义好 WebSocket 控制器类以及订阅路径即可满足需求。 下面是一段简单的 Java 示例代码，演示如何创建一个基本的服务端处理器： ```java import org.springframework.context.annotation.Configuration; import org.springframework.messaging.simp.config.MessageBrokerRegistry; import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker; import org.springframework.web.socket.config.annotation.StompEndpointRegistry; import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer; @Configuration @EnableWebSocketMessageBroker public class WebSocketConfig implements WebSocketMessageBrokerConfigurer { @Override public void configureMessageBroker(MessageBrokerRegistry config) { config.enableSimpleBroker("/topic"); // 广播消息前缀 config.setApplicationDestinationPrefixes("/app"); } @Override public void registerStompEndpoints(StompEndpointRegistry registry) { registry.addEndpoint("/ws-endpoint").withSockJS(); // 注册 SockJS 终端点 } } ``` 以上配置允许客户端通过指定 URL 访问 WebSocket 接口，并兼容 SockJS 的回退策略以增强跨浏览器兼容性和稳定性[^3]。 --- #### 注意事项 尽管实现了自动重连机制，但仍需要注意一些潜在问题： - 网络波动可能导致频繁掉线与上线切换，因此应合理调整重试间隔时间和最大次数。 - 若业务涉及状态同步或数据一致性保障，则可能需要设计补偿方案应对短暂离线期间发生的数据缺失情况。 ---

### 解决 Spring Boot 中 WebSocket 超时问题 在处理 Spring Boot 应用中的 WebSocket 超时问题时，可以通过配置服务器端的心跳机制以及调整超时时间来实现更稳定的连接。以下是详细的解决方案： #### 配置心跳间隔 WebSocket 协议本身并不具备内置的保持活动功能，因此通常会通过发送定期的心跳消息来防止连接被关闭。Spring 提供了 `StandardWebSocketHandlerAdapter` 和 `SockJS` 来支持这种行为。 可以在 WebSocket 配置类中设置心跳参数： ```java @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myWebSocketHandler(), "/ws").setAllowedOrigins("*"); } @Bean public WebSocketHandler myWebSocketHandler() { return new MyWebSocketHandler(); } } ``` 为了启用心跳检测，可以扩展 `TextWebSocketHandler` 并覆盖其方法以定义自定义逻辑[^1]。 #### 设置超时时间 Spring Boot 支持通过属性文件或程序化方式修改 WebSocket 连接的超时时间。具体来说，可以通过以下两种方式进行配置： 1. **application.properties 文件** 修改默认的读取和写入超时时间： ```properties server.connection-timeout=300000 # 5分钟 spring.webflux.websocket.timeout.seconds=600 # 10分钟 ``` 2. **程序化配置** 如果需要更加灵活的控制，可以直接在 WebSocket 处理器中指定超时选项： ```java @Configuration public class WebSocketTimeoutConfig { @Bean public ServerEndpointExporter serverEndpointExporter() { return new ServerEndpointExporter(); } @PostConstruct public void configureTimeouts() { System.setProperty("org.apache.tomcat.websocket.read_timeout", "300000"); // 5分钟 System.setProperty("org.apache.tomcat.websocket.write_timeout", "300000"); // 5分钟 } } ``` 上述代码片段展示了如何通过系统属性动态调整 Tomcat 容器内的 WebSocket 超时时间[^2]。 #### 使用 Spring Session 维护状态 如果应用涉及分布式部署或者需要跨多个实例共享用户会话数据，则可考虑集成 Spring Session。它允许开发者将用户的会话存储到 Redis 或其他外部存储介质中，从而避免因单点故障而导致的连接中断[^3]。 例如，在项目中引入依赖并完成基础配置后，即可利用 Redis 存储 WebSocket 用户的状态信息： ```xml <dependency> <groupId>org.springframework.session</groupId> <artifactId>spring-session-data-redis</artifactId> </dependency> ``` 接着更新 `application.yml` 添加必要的 Redis 参数： ```yaml spring: session: store-type: redis redis: host: localhost port: 6379 ``` 最后一步是在主启动类上标注注解以便激活功能： ```java @SpringBootApplication @EnableRedisHttpSession public class WebSocketApplication { public static void main(String[] args) { SpringApplication.run(WebSocketApplication.class, args); } } ``` 以上措施能够有效缓解由于网络波动或其他原因引发的 WebSocket 断线现象。 ---