如何組合 Spring REST 和 WebSocket？

Question

我是 Spring 的新手，正在從事大學項目。

目標：擁有一個 REST POST 端點，它可以保存數據，但也使用 websocket 發送廣播消息。

現在，我的 RestController 似乎工作正常，但真的不知道如何實現 websocket 部分？

這是端點的樣子：

@PostMapping("/employees")
 Employee newEmployee(@RequestBody Employee newEmployee) {
    return repository.save(newEmployee);
 }

我之前的想法：

- 使用具有@SendTo 注釋的方法創建@Controller？

- 我可以在 RestController newEmployee 方法上使用@SendTo 嗎？

最有效的方法是什么？

Answer 1

就像 spring 提供了@RestController 一樣，它也提供了@EnableWebSocket 注解和處理雙向通信的方法，下面是在 Z2A2D595E6ED9A0B24F027F2 中創建 websocket 連接的分步方法
首先進行配置 class 用於制作我們的 WebSocketConnection class bean，它將成為 websocket 連接、斷開連接和來自客戶端的消息的處理程序，並將其添加到 WebSocketsHandlerRegister 命名空間。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfiguration implements WebSocketConfigurer {

    @Bean
    public WebSocketConnection getWebSocketConnection() {
        return new WebSocketConnection();
    }

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
        webSocketHandlerRegistry.addHandler(getWebSocketConnection(), "/websocket");
    }
}

現在讓我們制作我們的 WebSocketConnection class

public class WebSocketConnection  extends TextWebSocketHandler {

    private static final Logger log = LoggerFactory.getLogger(WebSocketConnection.class);

    private static final Gson gson = new GsonBuilder().create();

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        log.info("connected with the websocket client : " + session.getId());
    }

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        JsonObject parsedMessage = gson.fromJson(message.getPayload(), JsonObject.class);

        log.info("The message got from the client is " + parsedMessage);

        JsonObject responseMessage = new JsonObject();
        responseMessage.addProperty("response", "Your response was recorded by the server");
        responseMessage.addProperty("messageReceivedtime", LocalDateTime.now().toLocalDate().toString());
        int max = 100;
        int min = 20;
        responseMessage.addProperty("randomNo", (int) Math.floor(Math.random() * (max - min + 1) + min));

        session.sendMessage(new TextMessage(responseMessage.toString())); //sending message back to the client
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        log.info("connection closed from the websocket client : " + session.getId());
    }
}

你在這里完成了。
現在從 javascript 的客戶端開始，您將必須像下面一樣制作 websocket 客戶端 object

const webSocketClient = new WebSocket('ws://localhost:port/websocket');
//const webSocketClient = new WebSocket('wss://ip:port/websocket') for cases of secure connection

有關 javascript 中 WebSocket 客戶端的更多信息，請參閱此
https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_client_applications

您提到了您的目標，即“擁有一個保存數據的 REST POST 端點，但也使用 websocket 發送廣播消息”不應該在 1 go 中。 您可以做的是，當用戶保存數據時，您可以將服務器的響應返回給已保存數據的用戶，然后讓該用戶向websocket服務器發送消息，websocket服務器將廣播給其他用戶。