Spring Boot与WebSocket实时通信

发布时间：2024-10-05 08:37:02 作者：小樊
来源：亿速云阅读：96

Spring Boot与WebSocket实时通信是一种利用WebSocket技术实现服务器与客户端之间实时数据传输的方法。WebSocket是一种在单个TCP连接上进行全双工通信的协议，它使得服务器能够主动向客户端推送数据，从而实现实时通信。

要在Spring Boot中实现WebSocket实时通信，你需要遵循以下步骤：

添加依赖

在你的Spring Boot项目中，需要添加spring-boot-starter-websocket依赖。在pom.xml文件中添加以下内容：

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

配置WebSocket

创建一个配置类，继承AbstractWebSocketMessageBrokerConfigurer，并覆盖configureMessageBroker和registerStompEndpoints方法。例如：

@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-demo").withSockJS();
    }
}

这里，我们启用了简单的消息代理，将/topic作为广播消息的前缀，将/app作为客户端订阅的前缀。同时，我们添加了一个使用SockJS的WebSocket端点/websocket-demo。

创建消息处理器

创建一个类，实现WebSocketHandler接口，用于处理WebSocket消息。例如：

public class MyWebSocketHandler implements WebSocketHandler {

    @Override
    public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
        // 处理接收到的消息
    }

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 连接建立后的操作
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        // 连接关闭后的操作
    }
}

发送消息

在控制器或其他需要发送消息的地方，使用SimpMessagingTemplate发送消息。例如：

@Autowired
private SimpMessagingTemplate messagingTemplate;

public void sendMessage(String destination, String message) {
    messagingTemplate.convertAndSend(destination, message);
}

客户端代码

在客户端，你可以使用原生的WebSocket API或者第三方库（如SockJS）来连接服务器并接收消息。例如，使用SockJS的JavaScript客户端代码如下：

<!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>
</head>
<body>
    <script>
        var socket = new SockJS('/websocket-demo');
        var stompClient = Stomp.over(socket);

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

这样，当服务器通过sendMessage方法发送消息到/topic/messages时，客户端就能实时接收到这些消息。

Spring Boot与WebSocket实时通信

相关阅读