在SpringBoot中實(shí)現(xiàn)WebSocket會話管理的方案

更新時(shí)間：2023年11月24日 08:39:46 作者：一只愛擼貓的程序猿

在構(gòu)建實(shí)時(shí)通信應(yīng)用時(shí),WebSocket 無疑是一個(gè)強(qiáng)大的工具,SpringBoot提供了對WebSocket的支持,本文旨在探討如何在 Spring Boot 應(yīng)用中實(shí)現(xiàn) WebSocket 會話管理,我們將通過一個(gè)模擬的場景一步步展開討論,需要的朋友可以參考下

場景設(shè)定

假設(shè)我們正在開發(fā)一個(gè)在線聊天應(yīng)用，該應(yīng)用需要實(shí)現(xiàn)以下功能：

用戶可以通過 WebSocket 實(shí)時(shí)發(fā)送和接收消息。
系統(tǒng)需要跟蹤用戶的會話狀態(tài)，以便在用戶重新連接時(shí)恢復(fù)狀態(tài)。
為了提高效率和安全性，我們需要監(jiān)控空閑連接并及時(shí)關(guān)閉它們。

基于這個(gè)場景，我們將探討四種實(shí)現(xiàn) WebSocket 會話管理的策略：

1. 使用現(xiàn)有的會話標(biāo)識符

一種常見的做法是利用 HTTP 會話（例如，通過 cookies）來管理 WebSocket 會話。

實(shí)現(xiàn)方法：

在 WebSocket 握手階段，從 HTTP 請求中提取會話標(biāo)識符。
將 WebSocket 會話與提取的會話標(biāo)識符關(guān)聯(lián)。

import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;

import javax.servlet.http.HttpSession;
import java.util.Map;

public class MyHandshakeInterceptor extends HttpSessionHandshakeInterceptor {
    
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {
        if (request instanceof ServletServerHttpRequest) {
            ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
            HttpSession session = servletRequest.getServletRequest().getSession();
            attributes.put("HTTP_SESSION_ID", session.getId());
        }
        return super.beforeHandshake(request, response, wsHandler, attributes);
    }
}

這個(gè)攔截器需要在 WebSocket 的配置類中注冊。例如，在 WebSocketConfig 類中，你可以這樣注冊攔截器：

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;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/ws")
                .addInterceptors(new MyHandshakeInterceptor())
                .setAllowedOrigins("*");
        // 你也可以添加 .withSockJS() 如果你需要SockJS支持
    }

    // ...其他配置...
}

2. 自定義協(xié)議消息

另一種方法是在 WebSocket 連接中定義自己的消息格式，包含會話管理信息。

實(shí)現(xiàn)方法：

定義消息格式（如 JSON），包含會話信息。
在連接建立后，通過 WebSocket 發(fā)送和接收這些自定義消息。

@Controller
public class WebSocketController {
    
    @Autowired
    private WebSocketSessionManager sessionManager;

    @MessageMapping("/sendMessage")
    public void handleSendMessage(ChatMessage message, SimpMessageHeaderAccessor headerAccessor) {
        String sessionId = (String) headerAccessor.getSessionAttributes().get("HTTP_SESSION_ID");
        // 使用 sessionId 處理消息
        // 可以通過 sessionManager 獲取用戶信息
    }

    // ...其他消息處理方法...
}

3. 連接映射

將每個(gè) WebSocket 連接映射到特定的用戶會話。

實(shí)現(xiàn)方法：

在連接建立時(shí)，從 WebSocket 握手信息中獲取用戶身份。
維護(hù)一個(gè)映射，關(guān)聯(lián) WebSocket 會話 ID 和用戶會話。

import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler; 
import java.util.Iterator; 
import org.springframework.stereotype.Component;
import java.util.concurrent.ConcurrentHashMap;
import java.util.Map;

@Component
public class WebSocketSessionManager extends TextWebSocketHandler {

    @Autowired
    private WebSocketHandler webSocketHandler;
    
    private Map<String, String> sessionMap = new ConcurrentHashMap<>();
    private Map<String, Long> lastActiveTimeMap = new ConcurrentHashMap<>();

    public void registerSession(String websocketSessionId, String userSessionId) {
        sessionMap.put(websocketSessionId, userSessionId);
        lastActiveTimeMap.put(websocketSessionId, System.currentTimeMillis());
    }

    public String getUserSessionId(String websocketSessionId) {
        return sessionMap.get(websocketSessionId);
    }

    public void updateLastActiveTime(String websocketSessionId) {
        lastActiveTimeMap.put(websocketSessionId, System.currentTimeMillis());
    }

    public Long getLastActiveTime(String websocketSessionId) {
        return lastActiveTimeMap.get(websocketSessionId);
    }

    public void checkAndCloseInactiveSessions(long timeout) {
        long currentTime = System.currentTimeMillis();
        lastActiveTimeMap.entrySet().removeIf(entry -> {
            String sessionId = entry.getKey();
            long lastActiveTime = entry.getValue();

            if (currentTime - lastActiveTime > timeout) {
                closeSession(sessionId);  // 關(guān)閉會話
                sessionMap.remove(sessionId);  // 從用戶會話映射中移除
                return true;  // 從活躍時(shí)間映射中移除
            }
            return false;
        });
    }

    private void closeSession(String websocketSessionId) {
        // 邏輯來關(guān)閉 WebSocket 會話
        // 可能需要與 webSocketHandler 交互
    }
    
    public void unregisterSession(String websocketSessionId) {
        sessionMap.remove(websocketSessionId);
    }
    // 可以添加注銷會話的方法等
}

4. 心跳和超時(shí)機(jī)制

實(shí)現(xiàn)心跳消息和超時(shí)機(jī)制，以管理會話的生命周期。

實(shí)現(xiàn)方法：

客戶端定時(shí)發(fā)送心跳消息。
服務(wù)端監(jiān)聽這些消息，并實(shí)現(xiàn)超時(shí)邏輯。

function sendHeartbeat() {
    if (stompClient && stompClient.connected) {
        stompClient.send("/app/heartbeat", {}, JSON.stringify({ timestamp: new Date() }));
    }
}
setInterval(sendHeartbeat, 10000); // 每10秒發(fā)送一次心跳

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.stereotype.Controller;

@Controller
public class HeartbeatController {

    @Autowired
    private WebSocketSessionManager sessionManager;

    @MessageMapping("/heartbeat")
    public void handleHeartbeat(HeartbeatMessage message, SimpMessageHeaderAccessor headerAccessor) {
        String websocketSessionId = headerAccessor.getSessionId();
        sessionManager.updateLastActiveTime(websocketSessionId);
        // 根據(jù)需要處理其他邏輯
    }
}

使用 Spring 的定時(shí)任務(wù)功能來定期執(zhí)行會話超時(shí)檢查，ScheduledTasks 類中的 checkInactiveWebSocketSessions 方法每5秒執(zhí)行一次，調(diào)用 WebSocketSessionManager 的 checkAndCloseInactiveSessions 方法來檢查和關(guān)閉超時(shí)的會話。

import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@EnableScheduling
@Component
public class ScheduledTasks {

    @Autowired
    private WebSocketSessionManager sessionManager;

    // 定義超時(shí)閾值，例如30分鐘
    private static final long TIMEOUT_THRESHOLD = 30 * 60 * 1000;

    @Scheduled(fixedRate = 5000) // 每5秒執(zhí)行一次
    public void checkInactiveWebSocketSessions() {
        sessionManager.checkAndCloseInactiveSessions(TIMEOUT_THRESHOLD);
    }
}

補(bǔ)充：在 WebSocket 連接關(guān)閉或用戶注銷時(shí)，可以調(diào)用 unregisterSession 方法來清理會話信息。當(dāng) WebSocket 連接關(guān)閉時(shí)，afterConnectionClosed 方法會被調(diào)用，這時(shí)我們可以通過 sessionManager 移除對應(yīng)的會話信息。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class MyWebSocketHandler extends TextWebSocketHandler {

    @Autowired
    private WebSocketSessionManager sessionManager;

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        String websocketSessionId = session.getId();
        sessionManager.unregisterSession(websocketSessionId);
        // 進(jìn)行其他清理工作
    }

    // 實(shí)現(xiàn)其他必要的方法
}

總結(jié)

實(shí)現(xiàn) WebSocket 會話管理需要綜合考慮應(yīng)用的需求和架構(gòu)特點(diǎn)。Spring Boot 提供了實(shí)現(xiàn)這些功能的強(qiáng)大支持，但正確地應(yīng)用這些工具和策略是成功的關(guān)鍵。通過本文的討論，我們看到了如何在一個(gè)實(shí)際場景中一步步地思考和實(shí)現(xiàn)有效的 WebSocket 會話管理。

以上就是在SpringBoot中實(shí)現(xiàn)WebSocket會話管理的方案的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot實(shí)現(xiàn)WebSocket會話的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: