本文由 简悦 SimpRead 转码， 原文地址 blog.csdn.net
介绍
WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议。它使得客户端和服务器之间的实时通信变得更加高效和方便。在现代 Web 应用中，WebSocket 常被用来实现聊天系统、通知推送、在线游戏等实时功能。本篇文章将介绍如何在 Spring Boot 中使用 WebSocket 实现实时通信。
项目依赖
首先，我们需要在 Spring Boot 项目中添加 WebSocket 的依赖。在pom.xml文件中添加以下依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
配置 WebSocket
接下来，我们需要配置 WebSocket。在 Spring Boot 中，我们可以通过创建一个配置类来完成这一步：
在上述配置中，我们使用@EnableWebSocket注解来启用 WebSocket 支持，并通过实现WebSocketConfigurer接口来注册我们的 WebSocket 处理器。
创建 WebSocket 处理器
然后，我们需要创建一个 WebSocket 处理器类来处理 WebSocket 连接和消息。在这个例子中，我们将创建一个简单的处理器来回显客户端发送的消息：
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 {
String payload = message.getPayload();
System.out.println("Received: " + payload);
session.sendMessage(new TextMessage("Echo: " + payload));
}
}
在这个处理器中，我们重写了handleTextMessage方法，当接收到文本消息时，将其回显给客户端。
创建 WebSocket 客户端
为了测试我们的 WebSocket 服务器，我们可以使用一个简单的 HTML 页面作为客户端：
在这个简单的客户端中，我们通过 JavaScript 创建了一个 WebSocket 连接，并实现了发送和接收消息的功能。
运行和测试
完成以上步骤后，我们可以运行 Spring Boot 应用，然后打开浏览器访问 HTML 客户端页面，输入消息并发送，应该会看到服务器回显的消息。
处理连接的生命周期事件
除了处理消息外，我们还可以处理 WebSocket 连接的生命周期事件，例如连接建立和关闭。我们可以在 WebSocket 处理器中重写以下方法：
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.WebSocketSession;
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
System.out.println("Connection established");
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
System.out.println("Connection closed: " + status);
}
广播消息
在实际应用中，我们通常需要向所有连接的客户端广播消息。我们可以在处理器中维护一个 WebSocketSession 的集合，并在接收到消息时向所有会话发送消息：
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
public class MyWebSocketHandler extends TextWebSocketHandler {
private static Set<WebSocketSession> sessions = Collections.synchronizedSet(new HashSet<>());
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
sessions.add(session);
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
sessions.remove(session);
}
@Override
protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
String payload = message.getPayload();
for (WebSocketSession s : sessions) {
s.sendMessage(new TextMessage("Broadcast: " + payload));
}
}
}
总结
通过 Spring Boot 和 WebSocket，我们可以非常方便地实现实时通信功能。在本文中，详细介绍了如何配置 WebSocket、创建 WebSocket 处理器以及如何处理连接的生命周期事件。希望这篇文章能够帮助您在项目中更好地使用 WebSocket。