在springboot项目中封装WebSocket成工具类

Spring Boot 中的 WebSocket 是一种在客户端和服务器之间建立双向通信的技术，允许实时传递数据。

WebSocket 的优势

1. 双向通信：WebSocket 允许客户端和服务器之间进行双向通信，实时传递数据。
2. 实时更新：WebSocket 可以实时更新客户端的数据，无需客户端手动刷新页面。
3. 低延迟：WebSocket 的延迟比传统的 HTTP 请求低得多。

处理器的使用场景和选择

• 文本消息：使用TextWebSocketHandler，适用于处理字符串或JSON消息。
• 二进制消息：使用BinaryWebSocketHandler，适用于处理图像、文件等二进制数据。
• Pong消息：使用PongWebSocketHandler，适用于心跳检测和保持连接。
• 复杂需求：直接实现WebSocketHandler接口，提供自定义的消息处理逻辑。
• 子协议：使用SubProtocolWebSocketHandler，适用于需要支持STOMP等子协议的应用（通常搭配消息队列一起使用）。

本文封装的是处理字符串消息。

1.引入依赖

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

2.配置webSocket配置类

import com.ruoyi.framework.handler.AlertWebSocketHandler;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Configuration;
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
@RequiredArgsConstructor
public class WebSocketConfig implements WebSocketConfigurer {

    private final AlertWebSocketHandler webSocketHandler;

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        //配置websocket客户端请求入口
        registry.addHandler(webSocketHandler, "/wms/websocket")
            .addInterceptors(new HttpSessionHandshakeInterceptor())
            .setAllowedOrigins("*");
    }
}

3.封装工具类（Handle处理类）

import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.CloseStatus;
import org.springframework.stereotype.Component;

import java.util.concurrent.ConcurrentHashMap;

@Component
public class WebSocketHandler extends TextWebSocketHandler {

    private ConcurrentHashMap<String, WebSocketSession> sessions = new ConcurrentHashMap<>();
       
    //建立连接后调用
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        sessions.put(session.getId(), session);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理收到的消息
        session.sendMessage(new TextMessage("你好！" + session.getId() + ":" + message.getPayload()));
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        sessions.remove(session.getId());
    }
    
    //给所有客户端发送消息
    public void sendMessageToAll(String message) throws Exception {
        for (WebSocketSession session : sessions.values()) {
            if (session.isOpen()) {
                session.sendMessage(new TextMessage(message));
            }
        }
    }

    //给指定客户端发送消息
    public void sendMessageToClient(String sessionId, String message) throws Exception {
        WebSocketSession session = sessions.get(sessionId);
        if (session != null && session.isOpen()) {
            session.sendMessage(new TextMessage(message));
        }
    }
}