Spring Boot 是一个用于简化 Java 企业级应用开发的框架，它支持多种协议和技术。WebSocket 是一种在客户端和服务器之间建立持久连接的协议，可以实现实时双向通信，适合用于聊天应用、在线游戏等场景。本文将介绍如何在 Spring Boot 中整合 WebSocket 服务。
一、环境准备
首先，你需要一个支持 Spring Boot 的开发环境。确保你的项目中包含必要的依赖。可以使用 Maven 来管理你的项目依赖，在 pom.xml 中添加 WebSocket 的依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
二、创建 WebSocket 配置
在 Spring Boot 中，我们需要创建一个 WebSocket 配置类来注册 WebSocket 的端点。在这个类中，我们会使用 @EnableWebSocket 注解来启用 WebSocket 支持，并实现 WebSocketConfigurer 接口。
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(new MyWebSocketHandler(), "/websocket").setAllowedOrigins("*");
}
}
在上述代码中，我们创建了一个 WebSocket 配置类 WebSocketConfig，并注册了一个名为 /websocket 的 WebSocket 端点。
三、实现 WebSocket Handler
接下来，我们需要实现一个 WebSocket 处理器，来处理客户端的连接、消息接收等操作。
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
import org.springframework.web.socket.TextMessage;
import java.io.IOException;
public class MyWebSocketHandler extends TextWebSocketHandler {
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
// 连接建立后调用
System.out.println("Connection established: " + session.getId());
}
@Override
protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
// 接收到消息时调用
System.out.println("Received message: " + message.getPayload());
// Echo the message back
session.sendMessage(new TextMessage("Echo: " + message.getPayload()));
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
// 连接关闭后调用
System.out.println("Connection closed: " + session.getId());
}
}
在这个 MyWebSocketHandler 类中，我们重写了 afterConnectionEstablished、handleTextMessage 和 afterConnectionClosed 方法，分别处理连接建立、消息接收和连接关闭等事件。
四、前端测试
为了测试 WebSocket 服务，我们可以使用简单的 HTML 和 JavaScript 来实现前端页面。
<!DOCTYPE html>
<html>
<head>
<title>WebSocket Test</title>
</head>
<body>
<h2>WebSocket Test</h2>
<input type="text" id="message" placeholder="Enter message">
<button id="sendBtn">Send</button>
<div id="response"></div>
<script>
const socket = new WebSocket('ws://localhost:8080/websocket');
socket.onopen = function() {
console.log('WebSocket connection established');
};
socket.onmessage = function(event) {
document.getElementById('response').innerText = event.data;
};
document.getElementById('sendBtn').onclick = function() {
const message = document.getElementById('message').value;
socket.send(message);
};
</script>
</body>
</html>
五、总结
通过以上步骤，我们成功地在 Spring Boot 中整合了 WebSocket 服务。通过 WebSocket，客户端可以与服务器实时通信，适用于需要即时反馈的应用场景。可以根据具体的业务需求，扩展 WebSocket 的功能，比如实现用户身份验证、消息队列等。希望本文能为你的 Spring Boot WebSocket 开发提供帮助。
