Spring Boot与WebSocket通信实现

发布时间：2024-11-15 12:22:03 作者：小樊
来源：亿速云阅读：81

Spring Boot 是一个用于简化 Spring 应用程序开发的框架，它提供了许多开箱即用的功能，使得开发人员能够快速构建和部署应用程序。WebSocket 是一种网络通信协议，它允许在客户端和服务器之间进行全双工通信。结合 Spring Boot 和 WebSocket，可以实现实时应用程序的开发。

下面是一个简单的示例，展示了如何使用 Spring Boot 和 WebSocket 实现通信功能：

添加依赖

在 pom.xml 文件中添加 Spring Boot 和 WebSocket 的依赖：

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

配置 WebSocket

创建一个配置类 WebSocketConfig，继承 AbstractWebSocketMessageBrokerConfigurer，并配置 WebSocket 的相关信息：

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
        config.enableSimpleBroker("/topic");
        config.setApplicationDestinationPrefixes("/app");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/websocket").withSockJS();
    }
}

这里配置了一个名为 /websocket 的 WebSocket 端点，并使用 SockJS 作为后备选项。同时，启用了简单的消息代理，用于将消息发布到 /topic 路径。

创建 WebSocket 控制器

创建一个控制器 WebSocketController，用于处理客户端发送的消息：

@Controller
public class WebSocketController {

    @MessageMapping("/send")
    @SendTo("/topic/messages")
    public String handleMessage(@Payload String message) {
        return "Received message: " + message;
    }
}

这里定义了一个名为 /send 的消息处理方法，使用 @MessageMapping 注解映射到 WebSocket 端点。当客户端发送消息到 /app/send 时，该方法将被调用，并将消息发布到 /topic/messages。

创建客户端

创建一个简单的 HTML 页面，用于与 WebSocket 服务器进行通信：

<!DOCTYPE html>
<html>
<head>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/sockjs-client/1.5.0/sockjs.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/stomp.js/2.3.3/stomp.min.js"></script>
    <script>
        var socket = new SockJS('/websocket');
        var stompClient = Stomp.over(socket);

        stompClient.connect({}, function (frame) {
            console.log('Connected: ' + frame);
            stompClient.subscribe('/topic/messages', function (response) {
                console.log('Received: ' + response.body);
            });
        });

        function sendMessage() {
            var message = document.getElementById('message').value;
            stompClient.send("/app/send", {}, message);
        }
    </script>
</head>
<body>
    <input type="text" id="message" placeholder="Type your message here">
    <button onclick="sendMessage()">Send</button>
</body>
</html>

这里使用 SockJS 和 Stomp.js 库创建了一个 WebSocket 客户端，连接到 /websocket 端点，并订阅了 /topic/messages 主题。当用户点击发送按钮时，客户端将向服务器发送消息。

现在，你可以运行 Spring Boot 应用程序，并在浏览器中打开 HTML 页面。当用户在输入框中输入消息并点击发送按钮时，服务器将接收到消息并将其发布到 /topic/messages 主题，客户端将接收到并显示该消息。

Spring Boot与WebSocket通信实现

相关阅读