一、 概述
WebSocket心跳检测和断线重连机制在实时网络通信中扮演着至关重要的角色,它们确保了即时通讯的连贯性、可靠性和高效性。
心跳检测:通过定期发送小数据包(心跳包)来检查WebSocket连接状态,确认客户端和服务器之间的连接是否仍然活跃。
断线重连:在WebSocket连接因网络问题或其他原因意外断开时,自动尝试重新建立连接的过程。
二、 代码实现
首先,我们需要引入websocket依赖,以便能够使用对应功能:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
创建一个 WebSocketServer 类,用于处理 WebSocket 连接和消息。
WebSocket
服务器端点,用于与客户端建立WebSocket
连接并进行通信。它继承了RedisSubscriber
类,并实现了OnOpen
、OnClose
、OnMessage
和OnError
等WebSocket
生命周期的方法。以下是该类的主要功能:
建立WebSocket
连接:通过@ServerEndpoint
注解指定服务器端点的路径为/ws/{sid}
,其中sid
为保留字段。在@OnOpen
方法中,与客户端的连接建立成功时执行相应的逻辑,如将当前WebSocketServer
实例添加到webSocketSet
集合中,增加在线数量,并启动定时任务。
关闭WebSocket连接:在@OnClose
方法中,当客户端连接关闭时执行相应的逻辑,如从webSocketSet
集合中移除当前WebSocketServer
实例,减少在线数量。
处理客户端发送的消息:在@OnMessage
方法中,接收客户端发送的消息并进行处理。如果接收到的消息是心跳包,则直接返回;否则,根据消息内容执行相应的业务逻辑,并通过sendMessage
方法将处理结果发送给客户端。
异常处理:在@OnError
方法中,处理WebSocket
连接发生错误时的逻辑,如记录错误日志。
群发消息:提供sendInfo
方法用于向所有连接的客户端发送消息。
指定会话推送:提供sendInfo
方法用于向指定会话的客户端发送消息。
数据处理:根据接收到的消息内容,调用相应的业务服务,获取数据并转换为JSON
格式,最后将数据发送给客户端。
该类使用了CopyOnWriteArraySet
来存储所有连接的客户端的WebSocketServer
实例,使用ScheduledExecutorService
来定时发送心跳包和处理业务逻辑。同时,它还利用AtomicBoolean
和AtomicInteger
来控制数据推送的状态和在线数量的线程安全操作。
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.ruoyi.common.core.redis.RedisSubscriber;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.utils.spring.SpringUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import java.lang.Object;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
/**
* WebSocket服务类,用于与客户端建立WebSocket连接并进行通信。
* 继承自RedisSubscriber,实现特定的订阅和处理逻辑。
*/
@Slf4j
@Component
@ServerEndpoint(value = "/ws/{sid}")
public class WebSocketServer extends RedisSubscriber {
/**
* ObjectMapper
*/
private static final ObjectMapper objectMapper = new