springboot中websocket簡單實現

更新時間：2023年01月06日 09:03:04 作者：C~LOVER

本文主要介紹了springboot中websocket簡單實現，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

websocket簡單實現

websocket是HTML5下一種新的協(xié)議，本質上websocket是一個基于tcp的協(xié)議。它實現了瀏覽器與服務器之間的雙向通信，能更好的節(jié)省服務器資源和寬帶并實現實時的通信。
websocket的幾個優(yōu)點?
1、使用的資源少，因為它的頭更小。
2、實時性更強：服務端可以通過連接主動向客戶端推送消息。
3、有狀態(tài)：開啟連接之后可以不用每次都攜帶狀態(tài)信息。

下面介紹spring集成的websocket的使用方法。

引入依賴包

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

實現WebSocketHandler 接口重寫相關方法。

主要有以下幾個方法：
afterConnectionEstablished：連接成功后調用。
handleMessage：處理發(fā)送來的消息。
handleTransportError： WS 連接出錯時調用。
afterConnectionClosed：連接關閉后調用。
supportsPartialMessages：是否支持分片消息。

import cn.hutool.core.collection.CollUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.*;

import java.io.IOException;
import java.util.concurrent.CopyOnWriteArrayList;

/**
 * 測試websocket
 *
 * @author yjj
 * @version 1.0
 * @since 2022 -12-28 14:55:29
 */
@Slf4j
@Component
public class TestWebsocket implements WebSocketHandler {

    protected static final CopyOnWriteArrayList<WebSocketSession> WEB_SOCKET_SESSIONS = new CopyOnWriteArrayList<>();

    /**
     * 建立連接后操作
     *
     * @param session       連接session信息
     * @throws Exception    exception
     */
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        WEB_SOCKET_SESSIONS.add(session);
        sendMessage("連接成功~~~~~~,sessionId=" + session.getId());
    }

    /**
     * 接收到消息后的處理
     *
     * @param session       連接session信息
     * @param message       信息
     * @throws Exception    exception
     */
    @Override
    public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
        sendMessage("接收到的消息為=【"+ message +"】,sessionId=【"+ session.getId() +"】,回復消息=【你好呀！】");
    }

    /**
     * ws連接出錯時調用
     *
     * @param session       session連接信息
     * @param exception     exception
     * @throws Exception    exception
     */
    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        if(session.isOpen()){
            sendMessage("ws連接出錯，即將關閉此session,sessionId=【"+ session.getId() +"】");
            session.close();
        }
        WEB_SOCKET_SESSIONS.remove(session);
    }

    /**
     * 連接關閉后調用
     *
     * @param session           session連接信息
     * @param closeStatus       關閉狀態(tài)
     * @throws Exception        exception
     */
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        if(session.isOpen()){
            sendMessage("ws連接即將關閉此session,sessionId=【"+ session.getId() +"】");
            session.close();
        }
        WEB_SOCKET_SESSIONS.remove(session);
    }

    /**
     * 是否支持分片消息
     */
    @Override
    public boolean supportsPartialMessages() {
        return false;
    }

    /**
     * 發(fā)送消息
     * @param message          消息
     * @throws IOException     ioException
     */
    public void sendMessage(String message) throws IOException {
        if(CollUtil.isNotEmpty(WEB_SOCKET_SESSIONS)){
            for (WebSocketSession webSocketSession : WEB_SOCKET_SESSIONS) {
                webSocketSession.sendMessage(new TextMessage(message));
            }
        }
    }
}

監(jiān)聽某個URL，websocket配置

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.WebSocketHandler;
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 javax.annotation.Resource;
/**
 * websocket配置
 *
 * @author yjj
 * @version 1.0
 * @since 2022 -12-28 15:10:11
 */
@EnableWebSocket
@Configuration
public class WebSocketConfig implements WebSocketConfigurer {

    @Resource
    private TestWebsocket testWebsocket;

    /**
     * Register {@link WebSocketHandler WebSocketHandlers} including SockJS fallback options if desired.
     *
     * @param registry
     */
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(testWebsocket, "/test").setAllowedOrigins("*");
    }
}

測試
使用websocket工具進行連接后效果圖如下:

在這里插入圖片描述