SpringBoot集成WebSokcet代碼步驟

更新時間：2026年01月16日 10:39:01 作者：盹貓

Spring?Boot是一個流行的Java框架,用于快速構建Spring應用程序,WebSocket是一種實現(xiàn)實時通信的協(xié)議,與HTTP協(xié)議結合使用,可以提供全雙工通信,這篇文章主要介紹了SpringBoot集成WebSokcet代碼步驟

前言

在Web開發(fā)時，有時我們需要一些實時性比較高的數據反饋，如設備監(jiān)測、系統(tǒng)監(jiān)測、聊天等，這時使用HTTP顯然是不適合的，這時就需要用到WebSocket通過單次連接來獲取長時間的數據獲取。

什么是websocket?

WebSocket 是一種在單個 TCP 連接上實現(xiàn)全雙工（雙向）通信的網絡協(xié)議，由 HTML5 規(guī)范定義，旨在它允許客戶端（如瀏覽器）和服務器之間建立持久連接，雙方可以隨時向對方發(fā)送數據，而無需像 HTTP 那樣每次通信都重新建立連接。

本篇文章就是記錄SpringBoot如何集成WebSocket功能，廢話不多說，讓我們開始吧～

環(huán)境準備

因為要使用websocket,所以在除了集成基礎的spring-boot-starter-web 依賴以外，還要集成

spring-boot-starter-websocket 以獲得Websocket支持。

Pom.xml

<properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
        <!--Web依賴-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--WebSocket依賴-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
            <version>2.3.12.RELEASE</version>
        </dependency>
</dependencies>

代碼步驟

配置websocket節(jié)點

在配置類里，我們需要新建一個ServerEndpointExporter 并交給SpringBoot管理，即可開啟WebSocket節(jié)點功能，內容如下：

@Configuration
public class WebSocketConfig {
    /**
     * 注入ServerEndpointExporter，
     * 這個bean會自動注冊使用了@ServerEndpoint注解聲明的Websocket endpoint
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

創(chuàng)建Websocket節(jié)點

首先需要在需使用到的WebSocket類上添加@ServerEndpoint(path,config) 以標記該類會作為一個websokcet的節(jié)點類，其中

path：該節(jié)點的訪問路徑
config: 可以做一些額外配置，如該節(jié)點的訪問權限校驗。

如下：

@Component
@Slf4j
@ServerEndpoint(value = "/detail", configurator = WebSocketAuthConfig.class)
public class DetailServer {}

下面就可以在該類中以事件標注的方式定義我們的方法，可以使用以下注解：

@OnOpen ：在有新的連接接入時，觸發(fā)方法。
@OnMessage: 當有新的消息時，觸發(fā)方法。
@OnError：當發(fā)生錯誤時，觸發(fā)方法。
@OnClose：當連接斷開時，觸發(fā)方法。

例如下面的方法定義：

    @OnOpen
    public void onOpen(Session session) {
        //這里一般會存儲會話。
        log.info("【websocket消息】有新的連接");
    }

    /**
     * 鏈接關閉調用的方法
     */
    @OnClose
    public void onClose() {
        //這里會移除會話。
        log.info("【websocket消息】連接斷開");
    }

    @OnMessage
    public void onMessage(String message) {
        log.info("【websocket消息】收到客戶端消息:" + message);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("用戶錯誤,原因:" + error.getMessage());
    }

一般會創(chuàng)建一個用于存儲當前當前Session的Map，用于會話的管理，并可以通過

session.getAsyncRemote().sendText(message);

將message數據發(fā)送到已連接的前端頁面。

授權驗證

當然不能允許所有人連接我們定義的WebSokcet節(jié)點，我們可以通過繼承ServerEndpointConfig.Configurator 來對節(jié)點進行配置，一般可以用于添加請求配置或進行授權認證，如下實現(xiàn)了一個Jwt的token驗證：

@Slf4j
public class WebSocketAuthConfig extends ServerEndpointConfig.Configurator {

    /**
     * DES:[攔截websocket的請求頭,并驗證]
     *
     * @param originHeaderValue 請求頭
     * @return boolean
     * @link [java.lang.String]
     */
    @Override
    public boolean checkOrigin(final String originHeaderValue) {
        final ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        try {
            assert servletRequestAttributes != null;
            /*
              此處使用反射的方式獲取對象,無法@AutoWiredW自動注入
             */
            final JwtUtil jwtUtil = SpringUtil.getBean(JwtUtil.class);
            HttpServletResponse response = servletRequestAttributes.getResponse();
            HttpServletRequest request = servletRequestAttributes.getRequest();
            //獲取并驗證請求參數中的token參數            
final String token = servletRequestAttributes.getRequest().getParameter("token");
            final Claims claims = jwtUtil.getClaimsByToken(token);
            if (ObjectUtil.isNull(claims)) {
                /*
                  Token驗證失敗,拒絕鏈接
                 */
                log.info("Token錯誤,拒絕連接......");
                request.getSession().setAttribute("loginFill",true);
                return  false;
            }else {
                request.getSession().setAttribute("loginFill",false);
            }
        } catch (final Exception e) {
            log.error("WebSocket-auth-error", e);
        }

        return true;
    }
}

當然這里也可以通過Shiro的根據路徑配置攔截請求，這里也是支持的，這樣ServerEndpointConfig.Configurator就可以不用單獨配置。