SpringBoot中的@MessageMapping注解詳解

更新時間：2023年08月12日 08:31:42 作者：2013crazy

這篇文章主要介紹了SpringBoot中的@MessageMapping注解詳解,Spring Boot 提供了對 WebSocket 的支持，其中 @MessageMapping 注解是一個常用的注解，它可以將一個 Java 方法標記為 WebSocket 的消息處理器,需要的朋友可以參考下

@MessageMapping

隨著 Web 技術的發(fā)展，越來越多的應用程序開始使用 WebSocket 協(xié)議來實現(xiàn)實時通信。

Spring Boot 提供了對 WebSocket 的支持，其中 @MessageMapping 注解是一個常用的注解，它可以將一個 Java 方法標記為 WebSocket 的消息處理器。

本文將介紹 Spring Boot 中 @MessageMapping 注解的原理、用法和示例。

@MessageMapping 注解的原理

在 Spring Boot 中，@MessageMapping 注解用于標識一個 Java 方法是一個 WebSocket 消息處理器。

消息處理器負責接收客戶端發(fā)送的消息，并進行處理。具體來說，使用 @MessageMapping 注解的方法將會被 Spring WebSocket 自動掃描，并注冊為一個消息處理器。

@MessageMapping 注解的作用類似于 @RequestMapping 注解，但是它只能用于 WebSocket 消息處理器。

使用 @MessageMapping 注解時，需要指定消息的目的地（Destination），即客戶端發(fā)送消息時的目標地址。

@MessageMapping 注解的用法

使用 @MessageMapping 注解的步驟如下：

1. 創(chuàng)建 WebSocket 配置類

首先，需要創(chuàng)建一個 WebSocket 配置類，并添加 @EnableWebSocket 注解。該注解用于啟用 Spring WebSocket。

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(chatHandler(), "/chat");
    }
    @Bean
    public WebSocketHandler chatHandler() {
        return new ChatHandler();
    }
}

上面的代碼中，創(chuàng)建了一個 WebSocketHandlerRegistry 對象，并將 ChatHandler() 的實例注冊為 /chat 的處理器。

2. 創(chuàng)建消息處理器類

在消息處理器類中，需要編寫消息處理器方法。消息處理器方法處理客戶端發(fā)送的消息，并返回響應。消息處理器方法可以使用 Spring WebSocket 提供的注解來指定消息的目的地、消息的類型和其他參數(shù)。

@Component
public class ChatHandler implements WebSocketHandler {
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        System.out.println("Connection established: " + session.getId());
    }
    @MessageMapping("/hello")
    public void handleHelloMessage(String message) {
        System.out.println("Received message: " + message);
    }
    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        System.out.println("Transport error: " + exception.getMessage());
    }
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        System.out.println("Connection closed: " + session.getId());
    }
    @Override
    public boolean supportsPartialMessages() {
        return false;
    }
}

上面的代碼中，@MessageMapping 注解用于指定消息的目的地，即 /hello。方法的參數(shù)中，String 類型的 message 表示客戶端發(fā)送的消息內容。方法的返回值為 void，表示不需要返回響應。

3. 啟動應用程序

最后，需要啟動應用程序，并訪問 ws://localhost:8080/chat，就可以開始使用 WebSocket 了。

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

@MessageMapping 注解的示例

下面是一個使用 @MessageMapping 注解的示例項目。

1. 創(chuàng)建項目

使用 Spring Initializr 創(chuàng)建一個新的 Spring Boot 項目，添加以下依賴：

Spring Websocket
Thymeleaf

2. 創(chuàng)建 WebSocket 配置類

創(chuàng)建一個 WebSocketConfig 類，并添加 @EnableWebSocket 注解。該注解用于啟用 Spring WebSocket。

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(chatHandler(), "/chat").withSockJS();
    }
    @Bean
    public WebSocketHandler chatHandler() {
        return new ChatHandler();
    }
}

上面的代碼中，創(chuàng)建了一個 WebSocketHandlerRegistry 對象，并將 ChatHandler() 的實例注冊為 /chat 的處理器。使用 withSockJS() 方法可以啟用 SockJS 支持。

3. 創(chuàng)建消息處理器類

在消息處理器類中，需要編寫消息處理器方法。消息處理器方法處理客戶端發(fā)送的消息，并返回響應。消息處理器方法可以使用 Spring WebSocket 提供的注解來指定消息的目的地、消息的類型和其他參數(shù)。

@Component
public class ChatHandler implements WebSocketHandler {
    private List<WebSocketSession> sessions = new CopyOnWriteArrayList<>();
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        System.out.println("Connection established: " + session.getId());
        sessions.add(session);
        broadcast("User " + session.getId() + " joined the chat");
    }
    @MessageMapping("/chat")
    public void handleChatMessage(ChatMessage message) {
        System.out.println("Received message: " + message);
        broadcast(message);
    }
    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        System.out.println("Transport error: " + exception.getMessage());
    }
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        System.out.println("Connection closed: " + session.getId() + " (" + closeStatus.getCode() + ")");
        sessions.remove(session);
        broadcast("User " + session.getId() + " left the chat");
    }
    @Override
    public boolean supportsPartialMessages() {
        return false;
    }
    private void broadcast(Object message) {
        for (WebSocketSession session : sessions) {
            try {
                session.sendMessage(new TextMessage(new ObjectMapper().writeValueAsString(message)));
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

上面的代碼中，@MessageMapping 注解用于指定消息的目的地，即 /chat。方法的參數(shù)中，ChatMessage 類型的 message 表示客戶端發(fā)送的消息內容。方法的返回值為 void，表示不需要返回響應。使用 sessions 列表來存儲所有連接的 WebSocketSession。

同時，還實現(xiàn)了 afterConnectionEstablished()、handleTransportError() 和 afterConnectionClosed() 方法，分別用于處理連接建立、傳輸錯誤和連接關閉的事件。broadcast() 方法用于向所有 WebSocketSession 廣播消息。

4. 創(chuàng)建 Thymeleaf 模板文件

在 src/main/resources/templates 目錄下，創(chuàng)建一個名為 chat.html 的 Thymeleaf 模板文件。

<!DOCTYPE html>
<html>
<head>
    <title>Chat</title>
    <script src="/webjars/sockjs-client/1.5.0/dist/sockjs.min.js"></script>
    <script src="/webjars/stomp-websocket/2.3.3/dist/stomp.min.js"></script>
    <script src="/js/chat.js"></script>
</head>
<body>
<h1>Chat</h1>
<form onsubmit="return false;">
    <input type="text" id="name" placeholder="Name">
    <input type="text" id="message" placeholder="Message">
    <button onclick="sendMessage()">Send</button>
</form>
<div id="messages"></div>
</body>
</html>

上面的代碼中，使用了 SockJS 和 STOMP 協(xié)議來實現(xiàn) WebSocket 的兼容性。同時，引入了 chat.js 文件，用于處理客戶端發(fā)送消息和接收消息的邏輯。

5. 創(chuàng)建客戶端腳本文件

在 src/main/resources/static/js 目錄下，創(chuàng)建一個名為 chat.js 的客戶端腳本文件。

var stompClient = null;
function connect() {
    var socket = new SockJS('/chat');
    stompClient = Stomp.over(socket);
    stompClient.connect({}, function (frame) {
        console.log('Connected: ' + frame);
        stompClient.subscribe('/topic/messages', function (message) {
            showMessage(JSON.parse(message.body));
        });
    });
}
function disconnect() {
    if (stompClient !== null) {
        stompClient.disconnect();
    }
    console.log("Disconnected");
}
function sendMessage() {
    var name = document.getElementById('name').value;
    var message = document.getElementById('message').value;
    stompClient.send("/app/chat", {}, JSON.stringify({'name': name, 'message': message}));
}
function showMessage(message) {
    var div = document.createElement('div');
    div.appendChild(document.createTextNode(message.name + ': ' + message.message));
    document.getElementById('messages').appendChild(div);
}
connect();

上面的代碼中，使用 connect() 方法來建立 WebSocket 連接。使用Stomp.over() 方法創(chuàng)建一個 STOMP 客戶端對象。使用 stompClient.connect() 方法來連接到 WebSocket 服務器，并使用 stompClient.subscribe() 方法來訂閱 /topic/messages 目的地，以接收廣播消息。

使用 sendMessage() 方法來發(fā)送消息。該方法將 name 和 message 作為 JSON 對象發(fā)送到 /app/chat 目的地。

使用 showMessage() 方法來顯示消息。該方法將消息添加到 messages 元素中。