Spring Boot 開發集成 WebSocket，實現私有即時通信系統

来源:https://www.cnblogs.com/Alandre/archive/2020/05/24/12953591.html
-Advertisement-
Play Games

1/ 概述 利用Spring Boot作為基礎框架，Spring Security作為安全框架，WebSocket作為通信框架，實現點對點聊天和群聊天。 2/ 所需依賴 Spring Boot 版本 1.5.3，使用MongoDB存儲數據（非必須），Maven依賴如下： 配置文件內容： 大致程式結構 ...


1/ 概述

利用Spring Boot作為基礎框架，Spring Security作為安全框架，WebSocket作為通信框架，實現點對點聊天和群聊天。

2/ 所需依賴

Spring Boot 版本 1.5.3，使用MongoDB存儲數據（非必須），Maven依賴如下：

<properties>
    <java.version>1.8</java.version>
    <thymeleaf.version>3.0.0.RELEASE</thymeleaf.version>
    <thymeleaf-layout-dialect.version>2.0.0</thymeleaf-layout-dialect.version>
  </properties>

  <dependencies>

    <!-- WebSocket依賴，移除Tomcat容器 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-websocket</artifactId>
      <exclusions>
        <exclusion>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
      </exclusions>
    </dependency>

    <!-- 使用Undertow容器 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-undertow</artifactId>
    </dependency>

    <!--  Spring Security 框架 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-security</artifactId>
    </dependency>

    <!-- MongoDB資料庫 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-mongodb</artifactId>
    </dependency>

    <!-- Thymeleaf 模版引擎 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.16.16</version>
    </dependency>

    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.30</version>
    </dependency>

    <!-- 靜態資源 -->
    <dependency>
      <groupId>org.webjars</groupId>
      <artifactId>webjars-locator</artifactId>
    </dependency>
    <dependency>
      <groupId>org.webjars</groupId>
      <artifactId>sockjs-client</artifactId>
      <version>1.0.2</version>
    </dependency>
    <dependency>
      <groupId>org.webjars</groupId>
      <artifactId>stomp-websocket</artifactId>
      <version>2.3.3</version>
    </dependency>
    <dependency>
      <groupId>org.webjars</groupId>
      <artifactId>bootstrap</artifactId>
      <version>3.3.7</version>
    </dependency>
    <dependency>
      <groupId>org.webjars</groupId>
      <artifactId>jquery</artifactId>
      <version>3.1.0</version>
    </dependency>

  </dependencies>

配置文件內容：

server:
  port: 80

# 若使用MongoDB則配置如下參數
spring:
  data:
    mongodb:
      uri: mongodb://username:[email protected]:27017
      authentication-database: admin
      database: chat

大致程式結構，僅供參考：

程式結構

3/ 創建程式啟動類，啟用WebSocket

使用@EnableWebSocket註解

@SpringBootApplication
@EnableWebSocket
public class Application {

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }

}

4/ 配置Spring Security

此章節省略。（配置好Spring Security，用戶能正常登錄即可）
可以參考：Spring Boot 全棧開發：用戶安全

5/ 配置Web Socket（結合第7節的JS看）

@Configuration
@EnableWebSocketMessageBroker
@Log4j
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {

  // 此處可註入自己寫的Service

  @Override
  public void registerStompEndpoints(StompEndpointRegistry stompEndpointRegistry) {
    // 客戶端與伺服器端建立連接的點
    stompEndpointRegistry.addEndpoint("/any-socket").withSockJS();
  }

  @Override
  public void configureMessageBroker(MessageBrokerRegistry messageBrokerRegistry) {
    // 配置客戶端發送信息的路徑的首碼
    messageBrokerRegistry.setApplicationDestinationPrefixes("/app");
    messageBrokerRegistry.enableSimpleBroker("/topic");
  }

  @Override
  public void configureWebSocketTransport(final WebSocketTransportRegistration registration) {
    registration.addDecoratorFactory(new WebSocketHandlerDecoratorFactory() {
      @Override
      public WebSocketHandler decorate(final WebSocketHandler handler) {
        return new WebSocketHandlerDecorator(handler) {
          @Override
          public void afterConnectionEstablished(final WebSocketSession session) throws Exception {
            // 客戶端與伺服器端建立連接後，此處記錄誰上線了
            String username = session.getPrincipal().getName();
            log.info("online: " + username);
            super.afterConnectionEstablished(session);
          }

          @Override
          public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
            // 客戶端與伺服器端斷開連接後，此處記錄誰下線了
            String username = session.getPrincipal().getName();
            log.info("offline: " + username);
            super.afterConnectionClosed(session, closeStatus);
          }
        };
      }
    });
    super.configureWebSocketTransport(registration);
  }
}

6/ 點對點消息，群消息

@Controller
@Log4j
public class ChatController {

  @Autowired
  private SimpMessagingTemplate template;
  
  // 註入其它Service

  // 群聊天
  @MessageMapping("/notice")
  public void notice(Principal principal, String message) {  
    // 參數說明 principal 當前登錄的用戶， message 客戶端發送過來的內容
    // principal.getName() 可獲得當前用戶的username  

    // 發送消息給訂閱 "/topic/notice" 且線上的用戶
    template.convertAndSend("/topic/notice", message); 
  }

  // 點對點聊天
  @MessageMapping("/chat")
  public void chat(Principal principal, String message){
    // 參數說明 principal 當前登錄的用戶， message 客戶端發送過來的內容（應該至少包含發送對象toUser和消息內容content）
    // principal.getName() 可獲得當前用戶的username

    // 發送消息給訂閱 "/user/topic/chat" 且用戶名為toUser的用戶
    template.convertAndSendToUser(toUser, "/topic/chat", content);
  }

}

7/ 客戶端與伺服器端交互

    var stompClient = null;

    function connect() {
        var socket = new SockJS('/any-socket');
        stompClient = Stomp.over(socket);
        stompClient.connect({}, function (frame) {
            // 訂閱 /topic/notice 實現群聊
            stompClient.subscribe('/topic/notice', function (message) {
                showMessage(JSON.parse(message.body));
            });
            // 訂閱 /user/topic/chat 實現點對點聊
            stompClient.subscribe('/user/topic/chat', function (message) {
                showMessage(JSON.parse(message.body));
            });
        });
    }

    function showMessage(message) {
        // 處理消息在頁面的顯示
    }

    $(function () {
        // 建立websocket連接
        connect();
        // 發送消息按鈕事件
        $("#send").click(function () {
            if (target == "TO_ALL"){
                // 群發消息
                // 匹配後端ChatController中的 @MessageMapping("/notice")
                stompClient.send("/app/notice", {}, '消息內容');
            }else{
                // 點對點消息，消息中必須包含對方的username
                // 匹配後端ChatController中的 @MessageMapping("/chat")
                var content = "{'content':'消息內容','receiver':'anoy'}";
                stompClient.send("/app/chat", {}, content);
            }
        });
    });

8/ 效果測試

登錄三個用戶：Anoyi、Jock、超級管理員。
群消息測試，超級管理員群發消息：

超級管理員

Anoyi

Jock

點對點消息測試，Anoyi給Jock發送消息，只有Jock收到消息，Anoyi和超級管理員收不到消息：

Jock

超級管理員

Anoyi

9/ 輕量級DEMO（完整可運行代碼）

Spring Boot 開發私有即時通信系統（WebSocket）(續)

10/ 參考文獻

文末福利

Java 資料大全 鏈接:https://pan.baidu.com/s/1pUCCPstPnlGDCljtBVUsXQ 密碼:b2xc
更多資料： 2020 年 精選阿裡 Java、架構、微服務精選資料等，加 v ❤ ：qwerdd111

轉載，請保留原文地址，謝謝 ~


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

-Advertisement-
Play Games
更多相關文章
  • Chrome性能調優技巧
    在開發大型Web應用或複雜交互的網站，不免會遇到一些頁面性能瓶頸的問題。本篇介紹一下如何利用Chrome的性能面板分析網站的性能瓶頸，應該對你有所幫助。 註意，為了減少一些Chrome插件對性能評估產生噪音，最好打開隱身模式訪問頁面進行測試。 將Chrome切換到隱身模式，然後打開該頁面進行測試： ...
  • React-class組件生命周期
    在組件特定時期，觸發的條件，統稱為生命周期； + 組件生命周期分為三部分： 組件創建階段 ：組件創建階段的生命周期函數，有一個顯著的特點：創建階段的生命周期函數，組件一生只執行一次； componentWillMount：組件將要被掛載，此時還沒有開始渲染虛擬dom render：第一次開始渲染真正 ...
  • 6.動畫
    # 6.動畫 - 1. transition 過渡 transition-property:all;//監聽屬性 transition-duration:1s;//過渡時間 transition-timing-function:linear;//運動速率 transition-delay:1s;// ...
  • 【設計模式】趣說訪問者模式，頗有些無奈之舉
    老實說，在實際編程中，訪問者設計模式應用的並不多，至少我是這樣認為的，因為它的主要使用場景並不多。那麼肯定會有人問，訪問者模式的主要使用場景是什麼呢？繼續往下看便知。新聞聯播看多了之後首先要說的是，設計模式中的“訪問者”和現實生活中的“訪問者”其本質是一回事。雖然設計模式中的不太熟悉，但現實生活中的 ...
  • MMU那些事兒
    MMU存在的意義 [導讀] 本文從記憶體管理的發展歷程角度層層遞進，介紹MMU的誕生背景，工作機制。而忽略了具體處理器的具體實現細節，將MMU的工作原理從概念上比較清晰的梳理了一遍。 MMU誕生之前: 在傳統的批處理系統如DOS系統,應用程式與操作系統在記憶體中的佈局大致如下圖： 應用程式直接訪問物理內 ...
  • 實用演算法系列之RT-Thread鏈表堆管理器
    [導讀] 前文描述了棧的基本概念，本文來聊聊堆是怎麼會事兒。RT Thread 在社區廣受歡迎，閱讀了其內核代碼，實現了堆的管理，代碼設計很清晰，可讀性很好。故一方面瞭解RT Thread內核實現，一方面可以弄清楚其堆的內部實現。將學習體會記錄分享，希望對於堆的理解及實現有一個更深入的認知。 註，文 ...
  • GO 使用Webhook 實現github 自動化部署
    通常大家開發大部分是本地git push 提交，伺服器上git pull 手動更新。git 可以使用webhook實現自動部署。webhook是倉庫平臺的一個鉤子事件，通過hook 鉤子監聽代碼，回調通知(通知地址就是你在各個git倉庫平臺中填寫的webhook地址，一般在你的某個項目倉庫如mypr ...
  • Android連載13-創建啟動活動類
    根據碎片的生命周期，我們知道onAttach()方法首先會被執行，因此在這裡做一些數據初始化的操作，比如調用getNews()方法獲取幾條模擬的新聞數據，以及完成NewsAdapter的創建，然後在onCreateView()方法中載入了news_title_frag佈局，並給新聞列表的ListVi ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類