Spring?Boot?實現(xiàn)?WebSocket?的代碼示例

更新時間：2022年04月30日 15:24:14 作者：不安分的黑娃

WebSocket?協(xié)議是獨立的基于?TCP?協(xié)議。它與?HTTP?的唯一關系是，它的握手會被?HTTP?服務器解釋為?Upgrade?請求，接下來通過本文給大家介紹Spring?Boot?實現(xiàn)?WebSocket?示例詳解,需要的朋友可以參考下

什么是 WebSocket ？

WebSocket協(xié)議提供了一種標準化的方法，通過單個TCP連接在客戶機和服務器之間建立全雙工、雙向的通信通道。它是一種不同于HTTP的TCP協(xié)議，但被設計為在HTTP上工作，使用端口80和443，并允許重用現(xiàn)有的防火墻規(guī)則。

WebSocket 協(xié)議是獨立的基于 TCP 協(xié)議。它與 HTTP 的唯一關系是，它的握手會被 HTTP 服務器解釋為 Upgrade 請求。

使用“Upgrade: websocket”切換到 websocket 協(xié)議：

GET /spring-websocket-portfolio/portfolio HTTP/1.1
Host: localhost:8080
Upgrade: websocket 
Connection: Upgrade 
Sec-WebSocket-Key: Uc9l9TMkWGbHFD2qnFHltg==
Sec-WebSocket-Protocol: v10.stomp, v11.stomp
Sec-WebSocket-Version: 13
Origin: http://localhost:8080

websocket 服務器返回 “101”：

HTTP/1.1 101 Switching Protocols 
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: 1qVdfYHU9hPOl4JYYNXF623Gzn0=
Sec-WebSocket-Protocol: v10.stomp

HTTP vs WebSocket

HTTP 中，應用會提供很多 URLs?？蛻舳送ㄟ^ 請求-響應風格訪問這些 URLs。服務器根據(jù)請求的 URL、方法、請求頭路由這些請求到合適的處理。

WebSocket 初始化連接只使用1個 URL。之后，所有的消息使用相同的 TCP 連接。WebSocket 是一個低等級的協(xié)議，它沒有規(guī)定消息內(nèi)容的任何語義。這意味著，除非客戶機和服務器在消息語義上達成一致，否則無法路由或處理消息。

WebSocket 客戶端與服務器可以通過HTTP 握手請求的 Sec-WebSocket-Protocol 請求頭商定更高級別的消息協(xié)議（像 STOMP）

什么時候使用 WebSocket？

WebSockets可以使網(wǎng)頁具有動態(tài)和交互性。然而，在許多情況下，Ajax和HTTP流或長輪詢的組合可以提供一個簡單而有效的解決方案。

例如，新聞、郵件和社交源需要動態(tài)更新，但每隔幾分鐘更新一次可能完全沒有問題。另一方面，協(xié)作、游戲和金融應用需要更接近實時。

代碼示例

1. SpringBoot 使用原生 WebSocket

1.1 引入 spring-boot-starter-websocket jar

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

1.2 編寫 WebSocketHandler

通過以下方式實現(xiàn) WebSocket 服務端：

實現(xiàn) WebSocketHandler 接口繼承 BinaryWebSocketHandler、TextWebSocketHandler 類

package org.spring.boot.websocket;
import java.nio.charset.StandardCharsets;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
/**
 * websocket 處理類：在請求信息的基礎上加上“服務器返回：”，然后返回給客戶端
 * @author black
 *
 */
public class EchoTextWebSocketHandler extends TextWebSocketHandler {
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 收到的信息
        String requestMsg  =  message.getPayload();
        System.out.println("服務器收到：" + requestMsg );
        // 組織響應信息
        String responseMsg = "服務器返回: " + requestMsg;
        System.out.println(responseMsg );
        TextMessage respMsg = new  TextMessage(responseMsg.getBytes(StandardCharsets.UTF_8));
         // 返回給客戶端
        session.sendMessage( respMsg);
    }
}

1.3 編寫 WebSocket 配置

package org.spring.boot.websocket;
import org.springframework.context.annotation.Bean;
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.WebSocketHandlerRegistration;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
/**
 * WebSocket 配置類
 * @author black
 *
 */
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        //  為指定的URL 配置具體的 WebSocketHandler
        WebSocketHandlerRegistration registration =  registry.addHandler(echoHandler(), "/echo");
        // registration 能夠對 WebSocketHandler 進行配置
    }
    @Bean
    public WebSocketHandler echoHandler() {
        return new EchoTextWebSocketHandler();
    }
}

1.4 啟動類

package org.spring.boot.websocket;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
/**
 * Spring boot 使用 websocket 代碼示例
 *
 */
@SpringBootApplication
public class SpringBootWebSocketBootstrap 
{
    public static void main( String[] args )
    {
        SpringApplication.run(SpringBootWebSocketBootstrap.class, args);
    }
}

應用默認端口為 8080 ，嵌入式容器是 tomcat。

1.5 測試

使用 Postman 進行 WebSocket 測試.

新建WebSocket 請求：

輸入“localhost:8080”

點擊【Connect】,下面顯示:

展開 “Connected to localhost:8080/echo”,具體內(nèi)容：

# Handshake Details
Request URL: http://localhost:8080/echo
Request Method: GET
Status Code: 101 
# Request Headers
Sec-WebSocket-Version: 13
Sec-WebSocket-Key: 1bNYHBOf9wqNuy2WUOYIsQ==
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits
Host: localhost:8080
# Response Headers
Upgrade: websocket
Connection: upgrade
Sec-WebSocket-Accept: uh9IkfewEg11GuuAKnbXmpH+Yqo=
Sec-WebSocket-Extensions: permessage-deflate;client_max_window_bits=15
Date: Sat, 30 Apr 2022 05:53:23 GMT

輸入“hello, 我是 black!”