在Spring框架中使用WebSocket

在Spring框架中使用WebSocket，特别是Spring Boot项目中，可以利用Spring提供的spring-websocket模块来实现。以下是一个基本的步骤指南：

1. 添加依赖

首先确保你的 pom.xml 或者 Gradle 构建文件包含WebSocket相关的依赖。对于Spring Boot项目，通常只需要核心依赖就已经包含了WebSocket支持，无需额外添加。但如果不是Spring Boot，可能需要手动引入如下Maven依赖：


<!-- Spring WebSocket -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-websocket</artifactId>
    <version>当前Spring版本号</version>
</dependency>

2. 创建WebSocket配置类（可选）

如果你需要自定义WebSocket配置，如设置消息代理等，可以创建一个配置类并继承 AbstractWebSocketMessageBrokerConfigurer 或 WebSocketMessageBrokerConfigurer （根据Spring Boot版本有所不同）。


@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
        // 设置STOMP协议的消息代理，其中"/app"用于处理应用发送到客户端的消息，"/topic"或"/queue"用于订阅目的地
        config.enableSimpleBroker("/topic", "/queue");
        // 设置前缀为"/ws"的路由映射到WebSocket handler
        config.setApplicationDestinationPrefixes("/app");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        // 注册WebSocket端点，并可以添加拦截器等配置
        registry.addEndpoint("/websocket").withSockJS();
    }
}

3. 创建WebSocket Handler

创建一个处理WebSocket消息的类，该类需继承 TextWebSocketHandler 或实现 WebSocketHandler 接口：


@Component
public class MyWebSocketHandler extends TextWebSocketHandler {

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 连接建立后执行的操作
        session.sendMessage(new TextMessage("Hello, you have connected!"));
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理从客户端发来的文本消息
        String payload = message.getPayload();
        // ...处理逻辑...

        // 可以向客户端回应消息
        session.sendMessage(new TextMessage("Received: " + payload));
    }

    // 其他重写的方法...
}

4. 创建前端WebSocket客户端

在HTML和JavaScript中创建WebSocket客户端，连接到服务器上的WebSocket端点：


<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>WebSocket Client</title>
</head>
<body>
    <script type="text/javascript">
        var socket = new WebSocket('ws://localhost:8080/websocket');

        // 连接打开事件
        socket.onopen = function(event) {
            socket.send('Hello from client!');
        };

        // 收到消息事件
        socket.onmessage = function(event) {
            console.log('Received: ' + event.data);
        };

        // 连接关闭事件
        socket.onclose = function(event) {
            console.log('Connection closed');
        };
    </script>
</body>
</html>

以上就是在Spring框架下使用自带WebSocket功能的基本步骤。在实际项目中，你可能还需要结合STOMP协议进行更复杂的消息传递以及利用SockJS作为浏览器兼容性层等高级功能。