springboot websocket 知識點彙總

来源:https://www.cnblogs.com/xxctx/p/18303261
-Advertisement-
Play Games

以下是一個詳細全面的 Spring Boot 使用 WebSocket 的知識點彙總 1. 配置 WebSocket 添加依賴 進入maven官網, 搜索spring-boot-starter-websocket，選擇版本, 然後把依賴複製到pom.xml的dependencies標簽中 配置 We ...


以下是一個詳細全面的 Spring Boot 使用 WebSocket 的知識點彙總

1. 配置 WebSocket

添加依賴

進入maven官網, 搜索spring-boot-starter-websocket，選擇版本, 然後把依賴複製到pom.xml的dependencies標簽中

在這裡插入圖片描述

配置 WebSocket

創建一個配置類 WebSocketConfig，並啟用 WebSocket 支持：

這個類的主要作用就是

  • 啟用 WebSocket 支持: 這個配置類通過返回 ServerEndpointExporter 實例來啟用 WebSocket 支持。
  • 自動註冊端點: 它會自動註冊用 @ServerEndpoint 註解標識的 WebSocket 端點，使它們能夠處理 WebSocket 請求。
package com.example.websocketdemo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {
    
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

2. 創建 WebSocket 端點

創建一個 WebSocket 端點 WebSocketServer，處理客戶端與伺服器之間的 WebSocket 通信。

當一個用戶向服務端發送socket連接時, 相當於創建了一個WebSocketServer 類的實例對象

代碼中的Session 放到文章最後講。

package com.example.websocketdemo.websocket;
import jakarta.websocket.*;
import jakarta.websocket.server.PathParam;
import jakarta.websocket.server.ServerEndpoint;
import org.springframework.stereotype.Component;

@Component	// 下麵路徑最後面不要寫 '/'這個符號
@ServerEndpoint("/websocket/{username}")	// 我們配置的有WebSocketConfig類, 所以可以使用這個註解
public class WebSocketServer {

    private Session session;

    @OnOpen	// 建立連接的時候會調用這個函數
    public void onOpen(Session session, @PathParam("username") String username) {
        this.session = session;
        System.out.println("Connected with username: " + username);
    }

    @OnMessage	// 接收到客戶端的信息時調用
    public void onMessage(String message, Session session) {
        System.out.println("Received message: " + message);
        try {
            session.getBasicRemote().sendText("Server received [" + message + "]");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    @OnClose	// 關閉連接的時候調用
    public void onClose(Session session) {
        System.out.println("Session closed");
    }

    @OnError	// 錯誤時調用
    public void onError(Session session, Throwable throwable) {
        throwable.printStackTrace();
    }
}

3. Spring Security 配置（可選）

如果你的應用使用了 Spring Security，可能需要配置忽略 WebSocket 端點的安全檢查：

需要在你的SecurityConfig 類中添加下麵內容才可以讓伺服器接收到websocket的請求。SecurityConfig是一個管理Spring Security的自定義類

package com.example.websocketdemo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.WebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityCustomizer;

@Configuration
public class SecurityConfig {

    @Bean
    public WebSecurityCustomizer webSecurityCustomizer() {
        return (web) -> web.ignoring().requestMatchers("/websocket/**");
    }
}

4. 客戶端代碼

可以使用 JavaScript 在前端與 WebSocket 伺服器進行通信。

<script>
    let socket = null;

    function connect() {
        let username = "your user name";
        
        // @ServerEndpoint("/websocket/{username}")	這裡也可以傳遞其他參數, 比如token, 它會被服務端的這個註解接收到
        socket = new WebSocket('ws://localhost:8080/websocket/' + username);
		
		// 建立連接時會調用
        socket.onopen = function(event) {
            
        };

		// 接收到服務端的信息時調用
        socket.onmessage = function(event) {
            
        };
		
		// 關閉連接時調用
        socket.onclose = function(event) {
            
        };
		
		// 錯誤時調用
        socket.onerror = function(event) {
            
        };
		
		// 也可以通過close()手動關閉連接, 他會調用onclose(), 一般vue中在取消掛在組件時手動關閉連接
		socket.close(); 
		
		// 向服務端發送信息, message最好是json格式, JSON.stringify()
		socket.send(message)
    }
</script>

5. 處理 JSON 消息

在信息交換的時候, 我們一般用JSON格式的信息。Java 標準庫中並不包含直接處理 JSON 的功能。因此，需要引入第三方庫來處理 JSON 數據。
這裡我們講的是 Alibaba 提供的 fastjson, 還是在 maven官網 搜索 fastjson 選擇對應版本, 引入到pom.xml的dependencies標簽中。

// 將 Java 對象序列化為 JSON 字元串
String jsonString = JSON.toJSONString(user);
        
// 將 JSON 字元串反序列化為 Java 對象
User deserializedUser = JSON.parseObject(jsonString, User.class);

// 創建一個 JSONObject
JSONObject jsonObject = new JSONObject();
jsonObject.put("name", "John");
// 轉換成JSON字元串
jsonObject.toString()

// 解析 JSON 字元串
String jsonString = "{\"name\":\"ld\",\"age\":18,\"city\":\"ShangHai\"}";
JSONObject parsedObject = JSONObject.parseObject(jsonString);
// 獲取value, 輸出 ld
System.out.println("Name: " + parsedObject.getString("name"));

6. Session

Session 在 WebSocket 中是一個重要的概念，它代表了客戶端和伺服器之間的 WebSocket 連接。通過 Session 對象，你可以發送和接收消息、獲取連接信息、管理連接狀態以及處理連接中的錯誤。

1. 創建 WebSocket 伺服器端點

在 Java 中使用 WebSocket 的第一步是創建一個 WebSocket 伺服器端點。通過使用 @ServerEndpoint 註解，你可以定義 WebSocket 伺服器端點，並處理連接、關閉、消息和錯誤事件。

示例代碼：

import jakarta.websocket.OnClose;
import jakarta.websocket.OnError;
import jakarta.websocket.OnMessage;
import jakarta.websocket.OnOpen;
import jakarta.websocket.Session;
import jakarta.websocket.server.ServerEndpoint;
import java.io.IOException;

@ServerEndpoint("/websocket")
public class WebSocketServer {
    
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Connected: " + session.getId());
    }

    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        System.out.println("Received: " + message);
        session.getBasicRemote().sendText("Echo: " + message);
    }

    @OnClose
    public void onClose(Session session) {
        System.out.println("Disconnected: " + session.getId());
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        throwable.printStackTrace();
    }
}

2. Session 對象的常用方法

  • 獲取連接的唯一 ID：session.getId()
  • 發送消息：
    • 發送文本消息：session.getBasicRemote().sendText("message")
    • 發送二進位消息：session.getBasicRemote().sendBinary(ByteBuffer buffer)
  • 獲取連接的基本信息：
    • 獲取連接的 URI：session.getRequestURI()
    • 獲取連接的參數：session.getPathParameters()
    • 獲取連接的請求參數：session.getRequestParameterMap()
  • 關閉連接：session.close()
  • 檢查連接狀態：session.isOpen()

3. 處理消息

在 WebSocket 中，處理消息是通過 @OnMessage 註解的方法實現的。你可以在這個方法中處理來自客戶端的消息，並使用 Session 對象發送響應。

示例代碼：

@OnMessage
public void onMessage(String message, Session session) throws IOException {
    System.out.println("Received: " + message);
    // 向客戶端發送回顯消息
    session.getBasicRemote().sendText("Echo: " + message);
}

4. 處理連接和斷開

@OnOpen 和 @OnClose 註解的方法分別用於處理連接建立和連接斷開事件。在這些方法中，你可以執行一些初始化或清理操作。

示例代碼：

@OnOpen
public void onOpen(Session session) {
    System.out.println("Connected: " + session.getId());
}

@OnClose
public void onClose(Session session) {
    System.out.println("Disconnected: " + session.getId());
}

5. 處理錯誤

@OnError 註解的方法用於處理 WebSocket 連接中的錯誤。在這個方法中，你可以記錄錯誤信息或執行其他的錯誤處理操作。

示例代碼：

@OnError
public void onError(Session session, Throwable throwable) {
    throwable.printStackTrace();
}

6. 使用 Session 進行高級操作

6.1 保存和共用用戶狀態

在 WebSocket 應用中，你可以使用 Session 對象來保存和共用用戶狀態。例如，你可以在 Session 對象中存儲用戶的身份信息，併在後續的消息處理中使用這些信息。

示例代碼：

@OnOpen
public void onOpen(Session session) {
    session.getUserProperties().put("username", "John");
}

@OnMessage
public void onMessage(String message, Session session) throws IOException {
    String username = (String) session.getUserProperties().get("username");
    session.getBasicRemote().sendText("Hello, " + username + "! You sent: " + message);
}

6.2 廣播消息

你可以使用 Session 對象的集合來實現消息的廣播，即將消息發送給所有連接的客戶端。

示例代碼：

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

@ServerEndpoint("/websocket")
public class WebSocketServer {
    private static Set<Session> sessions = Collections.synchronizedSet(new HashSet<>());

    @OnOpen
    public void onOpen(Session session) {
        sessions.add(session);
        System.out.println("Connected: " + session.getId());
    }

    @OnClose
    public void onClose(Session session) {
        sessions.remove(session);
        System.out.println("Disconnected: " + session.getId());
    }

    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        for (Session s : sessions) {
            if (s.isOpen()) {
                s.getBasicRemote().sendText("Broadcast: " + message);
            }
        }
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        throwable.printStackTrace();
    }
}

文章到這裡就這束了！~

其他文章地址:

快速入門，springboot知識點彙總

springboot常用註解大全(超詳細, 30個)

springboot websocket知識點彙總

spring cloud知識點彙總, 待更


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 防火防盜防CDN流量盜刷
    沒想到自己的小破站也逃不掉被攻擊的命，分分鐘就給我刷欠費了。 本來不想寫這篇文章的，但看到好多大佬（小林coding、 JavaGuide）近期cdn都被盜刷了。 還是來提醒下大家，防火防盜防cdn流量盜刷 事故時間：2024年7月5日晚8點左右 事故現場：好不容易到了周五，想著第二天就周末了，和朋 ...
  • 全網最適合入門的面向對象編程教程：12 類和對象的Python實現-Python使用logging模塊輸出程式運行日誌
    本文主要介紹了日誌的定義和作用，以及 Python 內置日誌處理的 logging 模塊，同時簡單說明瞭日誌等級和 logging 模塊的簡易使用方法。 ...
  • 全網最適合入門的面向對象編程教程：17 類和對象的Python實現-鴨子類型與“file-like object“
    本文主要介紹了Python中創建自定義類時鴨子類型的基本定義、特點和應用場景，同時列舉了“file-like object“的例子對鴨子類型進行了說明。 ...
  • springboot常用註解大全(超詳細, 30個)
    Spring Boot註解主要用於簡化配置、自動裝配組件和實現聲明式服務。以下是詳細的介紹： 1、Springboot註解 核心註解 1. @SpringBootApplication 作用: 標註一個主程式類，表明這是一個Spring Boot應用程式的入口。 功能: 這是一個複合註解，組合了@C ...
  • 如何使用阿裡雲鏡像加速
    有的時候博客內容會有變動，首發博客是最新的，其他博客地址可能會未同步,認準https://blog.zysicyj.top 官方地址 Ubuntu 針對Docker客戶端版本大於 1.10.0 的用戶 您可以通過修改daemon配置文件/etc/docker/daemon.json來使用加速器 su ...
  • JAVA編輯word替換指定內容，解決插入圖片顯示不全問題
    在開發過程中，我們可能會遇到需要生成word，或者通過模板word替換相應內容的需求。但在文檔中插入圖片時，如果段落格式設置不對，就會導致圖片只顯示一點點或者不顯示。接下來就介紹一下java編輯word和插入圖片需怎麼處理。 1.引入依賴 首先我們在項目中引入Apache POI，用於讀取和操作wo ...
  • Spring MVC 中的攔截器的使用“攔截器基本配置” 和 “攔截器高級配置”
    1. Spring MVC 中的攔截器的使用“攔截器基本配置” 和 “攔截器高級配置” @目錄1. Spring MVC 中的攔截器的使用“攔截器基本配置” 和 “攔截器高級配置”2. 攔截器3. Spring MVC 中的攔截器的創建和基本配置3.1 定義攔截3.2 攔截器基本配置3.3 攔截器的 ...
  • Python 生成條形碼、二維碼 （Code 128、EAN-13、QR code等）
    條形碼和二維碼是現代信息交換和數據存儲的重要工具，它們將信息以圖形的形式編碼，便於機器識別和數據處理，被廣泛應用於物流、零售、醫療、教育等各領域。本文將介紹如何使用Python快速生成各種常見的條形碼如Code 128、EAN-13，以及生成二維碼。 Python條碼庫 本文需要用到 Spire.B ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類