Spring Boot 實作 WebSocket 示例-有解無憂

參考資料
什么是 WebSocket ？
HTTP vs WebSocket
什么時候使用 WebSocket？
代碼示例
- 1. SpringBoot 使用原生 WebSocket
  - 1.1 引入 spring-boot-starter-websocket jar
  - 1.2 撰寫 WebSocketHandler
  - 1.3 撰寫 WebSocket 配置
  - 1.4 啟動類
  - 1.5 測驗

參考資料

The WebSocket Protocol（RFC 6455）
Spring Boot 2.6.6 官方檔案
SockJS

什么是 WebSocket ？

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

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

使用“Upgrade: websocket”切換到 websocket 協議：

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

Connection頭部和Upgrade頭部有不同的語意和使用場景：
Connection: Upgrade 表示Upgrade是一個hop-by-hop的欄位，這個頭部是給proxy看的
Upgrade: websocket 表示瀏覽器想要升級到WebSocket協議，這個頭部是給最終處理請求的程式看的，如果只有Upgrade: websocket，說明proxy不支持WebSocket升級，按照標準應該視為普通HTTP請求，

HTTP vs WebSocket

HTTP 中，應用會提供很多 URLs，客戶端通過請求-回應風格訪問這些 URLs，服務器根據請求的 URL、方法、請求頭路由這些請求到合適的處理，

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

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

什么時候使用 WebSocket？

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

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

代碼示例

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

通過以下方式實作 WebSocket 服務端：

實作 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”,具體內容：

# 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!”

點擊【Send】

上圖可以看出訊息是按倒序展示的，

最后點擊url旁邊的【Disconnect】按鈕關閉連接：

驗證結束，

本文來自博客園，作者：不安分的黑娃，轉載請注明原文鏈接：https://www.cnblogs.com/lihw-study/p/16210256.html

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/468721.html

標籤：Java

上一篇：JAVA 基礎（1）開發環境的搭建以及開發工具的選擇

下一篇：maven依賴的詳解說明