Spring Boot中使用WebSocket實現推播與通知功能-java教程-PHP中文網

Spring Boot中使用WebSocket實現推播與通知功能

PHPz

發布： 2023-06-23 11:47:50

原創

1604 人瀏覽過

在現代網路應用程式開發中，WebSocket是實現即時通訊和即時資料傳輸的常用技術。 Spring Boot框架提供了整合WebSocket的支持，讓開發者可以非常方便地實現推播和通知功能。

本文將介紹Spring Boot中如何使用WebSocket實現推播和通知功能，並示範一個簡單的即時線上聊天室的實作。

建立Spring Boot專案

首先，我們需要建立一個Spring Boot專案。可以在Spring Initializr網站上使用web和WebSocket依賴來快速建立一個新專案。程式碼如下：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>
</dependencies>

登入後複製

設定WebSocket

接下來，我們需要設定WebSocket以使其能夠在Spring Boot應用程式中運作。

首先，我們需要在應用程式的設定檔中加入以下屬性：

spring.websocket.enabled=true

登入後複製

接著，在Spring Boot的設定類中加入一個@EnableWebSocket註解，啟用WebSocket支援。同時，我們需要實作一個WebSocketConfigurer接口，在其中註冊處理程序和訊息攔截器，以便處理WebSocket請求和訊息。

程式碼如下：

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new WebSocketHandler(), "/chat").setAllowedOrigins("*").withSockJS();
    }
}

登入後複製

在上面的程式碼中，我們註冊了一個處理程序（即WebSocketHandler），該處理程序在客戶端連接到“/ chat”端點時被呼叫。使用setAllowedOrigins方法來指定允許的來源，以便進行跨域請求，使用withSockJS方法以啟用SockJS支持，以便與不支援WebSocket的瀏覽器相容。

寫WebSocket處理程序

現在我們需要寫處理程序類，這個類別會處理所有的WebSocket請求和訊息。

在Spring Boot中，這個類別只需要實作WebSocketHandler介面即可。我們將使用SimpeTextWebSocketHandler類，該類別提供了處理WebSocket訊息的基本功能，並且我們可以在其基礎上擴展自己的處理程序。

程式碼如下：

public class WebSocketHandler extends TextWebSocketHandler {

    private final List<WebSocketSession> sessions = new CopyOnWriteArrayList<>();

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        sessions.add(session);
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        sessions.remove(session);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        for (WebSocketSession s : sessions) {
            if (s.isOpen() && !s.equals(session)) {
                s.sendMessage(message);
            }
        }
    }
}

登入後複製

在上面的程式碼中，afterConnectionEstablished方法在新的WebSocket會話建立時被調用，afterConnectionClosed方法在WebSocket會話關閉時被呼叫。 handleTextMessage方法處理所有的WebSocket訊息，並傳送給所有目前連線的客戶端。

建立WebSocket客戶端

現在，我們需要建立一個WebSocket客戶端來測試實現的推播和通知功能。可以使用JavaScript的WebSocket API來建立一個WebSocket客戶端。

程式碼如下：

const socket = new WebSocket('ws://localhost:8080/chat');

socket.onopen = function() {
  console.log('连接已建立');
};

socket.onmessage = function(event) {
  console.log('收到消息:', event.data);
};

socket.onerror = function(error) {
  console.log('发生错误:', error);
};

socket.onclose = function() {
  console.log('连接已关闭');
};

登入後複製

在上面的程式碼中，我們建立了一個WebSocket實例並嘗試連接到ws：// localhost：8080 / chat。然後，我們監聽WebSocket事件以獲取打開，關閉，錯誤和訊息事件。