探索Spring Boot中的WebSocket支持：实时双向通信

开场白

大家好，欢迎来到今天的讲座。今天我们要一起探索Spring Boot中非常酷炫的WebSocket支持，带你进入实时双向通信的世界。如果你还在用轮询来实现“实时”功能，那你就OUT了！WebSocket让你的应用程序能够即时响应用户的操作，带来更加流畅和互动的用户体验。

什么是WebSocket？

在开始之前，我们先简单回顾一下什么是WebSocket。传统的HTTP协议是单向的，客户端发起请求，服务器响应，然后连接关闭。而WebSocket则不同，它允许客户端和服务器之间建立持久的、双向的通信通道。这意味着服务器可以主动向客户端推送消息，而不需要客户端不断地发起请求。

WebSocket的工作原理如下：

客户端通过HTTP请求与服务器建立连接。
服务器将这个HTTP连接升级为WebSocket连接。
一旦连接建立，双方就可以自由地发送和接收消息，直到一方关闭连接。

Spring Boot中的WebSocket支持

Spring Boot从一开始就对WebSocket提供了强大的支持。通过简单的配置和少量的代码，你就可以轻松地在你的应用程序中集成WebSocket。接下来，我们将一步步介绍如何在Spring Boot中使用WebSocket。

1. 引入依赖

首先，你需要在pom.xml中添加Spring WebSocket的依赖。如果你使用的是Spring Boot 2.x版本，那么你可以直接使用以下依赖：

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

如果你还需要使用STOMP（一种基于WebSocket的简单消息传递协议），可以再添加一个依赖：

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

2. 配置WebSocket

接下来，我们需要配置WebSocket。Spring Boot提供了一个WebSocketConfigurer接口，你可以通过实现它来自定义WebSocket的行为。下面是一个简单的配置类：

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 WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(myWebSocketHandler(), "/ws").setAllowedOrigins("*");
    }

    @Bean
    public MyWebSocketHandler myWebSocketHandler() {
        return new MyWebSocketHandler();
    }
}

在这个配置类中，我们做了两件事：

启用了WebSocket支持（通过@EnableWebSocket注解）。
注册了一个WebSocket处理器（MyWebSocketHandler），并指定了它的访问路径（/ws）。

3. 实现WebSocket处理器

MyWebSocketHandler是我们的WebSocket处理器，它负责处理客户端与服务器之间的消息交互。你可以继承TextWebSocketHandler或BinaryWebSocketHandler来实现自己的处理器。下面是一个简单的例子：

import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class MyWebSocketHandler extends TextWebSocketHandler {

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 当收到客户端的消息时，打印出来
        System.out.println("Received message: " + message.getPayload());

        // 然后给客户端发回一条消息
        session.sendMessage(new TextMessage("Hello, client! You said: " + message.getPayload()));
    }
}

在这个处理器中，当服务器收到客户端的消息时，它会打印出消息内容，并给客户端发回一条回复。这就是最基础的WebSocket通信逻辑。

4. 使用STOMP协议

如果你想要更复杂的通信模式，比如发布/订阅模型，那么可以考虑使用STOMP协议。STOMP是一种轻量级的消息协议，适合用于WebSocket的场景。Spring Boot内置了对STOMP的支持，你可以通过@MessageMapping注解来处理STOMP消息。

首先，我们需要修改配置类，启用STOMP支持：

import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
        // 配置消息代理，使用内存中的队列
        config.enableSimpleBroker("/topic");
        // 配置前缀，用于识别客户端发送的消息
        config.setApplicationDestinationPrefixes("/app");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        // 注册STOMP端点，允许跨域访问
        registry.addEndpoint("/ws").withSockJS();
    }
}

在这个配置中，我们做了几件事：

启用了STOMP消息代理（enableSimpleBroker），并指定了消息的前缀（/topic）。
配置了客户端发送消息的前缀（/app）。
注册了一个STOMP端点（/ws），并启用了SockJS支持，以便在不支持WebSocket的浏览器中也能正常工作。

接下来，我们可以创建一个控制器来处理STOMP消息：

import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;

@Controller
public class WebSocketController {

    @MessageMapping("/chat")
    @SendTo("/topic/messages")
    public String handleChat(String message) {
        // 处理客户端发送的消息，并将其广播给所有订阅者
        return "New message: " + message;
    }
}

在这个控制器中，当客户端发送消息到/app/chat时，服务器会将这条消息广播给所有订阅了/topic/messages的客户端。

5. 前端代码

最后，我们来看看前端如何与WebSocket服务器进行通信。假设你使用的是JavaScript，可以通过WebSocket对象或SockJS库来连接服务器。下面是使用SockJS和STOMP的示例代码：

// 引入SockJS和STOMP库
var socket = new SockJS('/ws');
var stompClient = Stomp.over(socket);

stompClient.connect({}, function (frame) {
    console.log('Connected: ' + frame);

    // 订阅消息
    stompClient.subscribe('/topic/messages', function (message) {
        console.log('Received message: ' + message.body);
    });

    // 发送消息
    stompClient.send("/app/chat", {}, "Hello, Server!");
});

这段代码做了三件事：

连接到WebSocket服务器。
订阅/topic/messages，以便接收服务器广播的消息。
向服务器发送一条消息到/app/chat。

总结

通过今天的讲座，我们了解了Spring Boot中如何使用WebSocket实现实时双向通信。无论是简单的文本消息传递，还是复杂的发布/订阅模型，Spring Boot都为我们提供了强大的工具和支持。希望你能在自己的项目中尝试一下WebSocket，为用户提供更加流畅的交互体验。

如果你有任何问题或想法，欢迎在评论区留言。下次见！