Spring Boot整合WebSocket:开启实时通信之旅

liuian 2025-07-17 20:39 99 浏览

Spring Boot整合WebSocket：开启实时通信之旅

今天咱们来聊聊Spring Boot整合WebSocket这件大事儿。说到实时通信，你是不是第一时间想到QQ、微信这些聊天工具？没错，WebSocket就是实现这种“我发出去，你就立马收到”功能的利器。它打破了传统HTTP请求响应的模式，建立了客户端与服务器端的持久连接，让数据能够在两端自由流动。

什么是WebSocket？

首先咱们得知道WebSocket是个啥。简单来说，它是一种全双工通信协议，允许客户端和服务端之间进行双向实时数据交换。不像HTTP那样每次都要重新建立连接，WebSocket一旦建立连接后，就可以持续发送消息，而且延迟超低，简直是实时应用的福音。

想象一下，你在玩多人在线游戏或者看直播的时候，服务器需要实时更新游戏状态或者观众人数，这种场景下使用WebSocket就再合适不过了。

准备工作

在开始之前，我们需要准备几个东西：

一台能联网的电脑，Windows、Mac还是Linux都可以。
JDK 8及以上版本，因为WebSocket依赖于Java EE的API，而JDK 8自带了这个API。
一个IDE，比如IntelliJ IDEA或者Eclipse，用来编写代码。
Maven或者Gradle构建工具，用于管理项目的依赖库。

接下来咱们就开始搭建项目吧！

创建Spring Boot项目

首先打开你喜欢的IDE，新建一个Spring Boot项目。如果你用的是Spring Initializr网站，只需要勾选Web依赖即可。为什么只勾选Web呢？因为WebSocket也是Web相关的技术嘛。

创建好项目后，你会看到一个基本的Spring Boot骨架项目，里面有pom.xml文件（如果是Maven项目的话）或者build.gradle文件（如果是Gradle项目的话）。

添加WebSocket依赖

接着咱们需要添加WebSocket的支持。在pom.xml里加上以下依赖：

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

如果你用的是Gradle，就在build.gradle里写：

implementation 'org.springframework.boot:spring-boot-starter-websocket'

加完依赖后，别忘了刷新项目，让Maven或者Gradle去下载这些依赖库。

配置WebSocket

配置WebSocket其实挺简单的。咱们需要定义一个类来处理WebSocket的消息。这里我们创建一个叫MyWebSocketConfig的类：

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

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

这段代码的作用是注册一个WebSocket处理器MyWebSocketHandler，并且指定访问路径为/ws。这样客户端就能通过这个路径连接到我们的WebSocket服务了。

编写WebSocket处理器

现在咱们来写具体的处理逻辑。创建一个MyWebSocketHandler类：

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
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        String payload = message.getPayload();
        System.out.println("Received message: " + payload);
        
        // 向客户端回传消息
        session.sendMessage(new TextMessage("Echo: " + payload));
    }
}

在这个类里，我们重写了handleTextMessage方法，当接收到客户端发来的文本消息时，会打印出来，并且回复一条带有“Echo”的消息给客户端。

启动项目并测试

一切准备就绪后，启动项目。你可以通过浏览器或者其他WebSocket客户端工具来测试。比如使用JavaScript的WebSocket API：

let ws = new WebSocket('ws://localhost:8080/ws');

ws.onopen = function() {
    console.log('Connected to server');
};

ws.onmessage = function(event) {
    console.log('Received from server: ', event.data);
};

ws.send('Hello Server!');

这段脚本会在连接成功后向服务器发送一条“Hello Server!”的消息，并打印服务器返回的信息。