詳解基于SpringBoot的WebSocket應用開發

作者：ijunfu 2024-03-19 08:45:45

WebSocket是一種在單個TCP連接上進行全雙工通信的協議，其最大的特點是服務器可以主動向客戶端發送消息，而不需要客戶端先發起請求。相較于傳統的HTTP長輪詢或輪詢機制，WebSocket能有效減少不必要的網絡通信開銷，并提供更優的實時性。

在現代Web應用中，實時交互和數據推送的需求日益增長。WebSocket協議作為一種全雙工通信協議，允許服務端與客戶端之間建立持久性的連接，實現實時、雙向的數據傳輸，極大地提升了用戶體驗。本文將詳細介紹如何在Spring Boot框架中使用WebSocket進行高效、穩定的實時通信。

WebSocket簡介

SpringBoot集成WebSocket

添加依賴

首先，在Spring Boot項目中引入WebSocket支持。在pom.xml文件中添加如下依賴：

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

創建WebSocket配置類

創建一個WebSocket配置類，通過WebSocketConfigurer接口來自定義WebSocket處理邏輯。例如：

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 注冊WebSocket處理器，指定訪問路徑
        registry.addHandler(myWebSocketHandler(), "/webSocket/{sid}");
    }

    @Bean
    public WebSocketHandler myWebSocketHandler() {
        return new MyWebSocketHandler();
    }
}

實現WebSocket處理器

創建一個實現WebSocketHandler接口的類，如MyWebSocketHandler，并重寫其中的方法以處理WebSocket的生命周期事件（如打開、關閉、接收消息等）：

@Component
public class MyWebSocketHandler implements WebSocketHandler {

    private static final CopyOnWriteArraySet<MyWebSocketHandler> webSocketSet = new CopyOnWriteArraySet<>();

    private Session session;
    private String sid;

    @Override
    public void afterConnectionEstablished(Session session) throws Exception {
        this.session = session;
        sid = session.getAttributes().get("sid").toString();
        webSocketSet.add(this);
        log.info("WebSocket連接已建立, sid: {}", sid);
    }

    @Override
    public void handleMessage(String message, Session session) throws IOException {
        log.info("接收到{}的信息: {}", sid, message);
        // 群發消息或其他處理邏輯
        for (MyWebSocketHandler item : webSocketSet) {
            try {
                if (item.sid.equals(sid)) {
                    item.sendMessage(message);
                }
            } catch (IOException e) {
                log.error("發送消息時發生錯誤", e);
            }
        }
    }

    @Override
    public void handleTransportError(Throwable exception, Session session) {
        if (session.isOpen()) {
            session.close();
        }
        webSocketSet.remove(this);
        log.error("WebSocket連接發生錯誤", exception);
    }

    @Override
    public void afterConnectionClosed(Session session, CloseStatus status) {
        webSocketSet.remove(this);
        log.info("WebSocket連接已關閉, sid: {}, 原因: {}", sid, status.getReason());
    }

    @Override
    public boolean supportsPartialMessages() {
        return false;
    }

    private void sendMessage(String message) throws IOException {
        session.getBasicRemote().sendText(message);
    }
    
    // 可以增加根據sid篩選的消息推送方法
    public static void sendInfo(SocketMsg socketMsg, String targetSid) throws IOException {
        // ...
    }
}

客戶端連接WebSocket

在前端JavaScript代碼中使用WebSocket API與后端建立連接，并處理各種事件：

var ws = new WebSocket('ws://localhost:8080/webSocket/' + uniqueSessionId);

ws.onopen = function(event) {
    console.log('WebSocket連接已建立');
};

ws.onmessage = function(event) {
    console.log('接收到服務器消息：', event.data);
};

ws.onerror = function(error) {
    console.error('WebSocket連接發生錯誤：', error);
};

ws.onclose = function(event) {
    console.log('WebSocket連接已關閉，原因：', event.reason);
};

// 發送消息到服務器
ws.send(JSON.stringify({message: 'Hello, Server!'}));

總結

通過上述步驟，我們已經在Spring Boot項目中成功實現了WebSocket功能。需要注意的是，實際應用場景中可能需要對用戶權限、連接管理、消息隊列、心跳檢測等功能進行更細致的設計與實現，以確保WebSocket服務的穩定性和性能表現。同時，WebSocket技術的應用場景非常廣泛，包括但不限于即時聊天、在線協作、實時監控等。

責任編輯：姜華來源：今日頭條