Spring Boot 是一个流行的 Java 开发框架，能够简化复杂的应用程序开发过程。WebSocket 技术允许在服务器和客户端之间建立双向通信通道，非常适合需要实时更新的应用场景，如聊天应用、实时数据推送等。本文将介绍如何在 Spring Boot 中整合 WebSocket，并提供简单的示例代码。
1. 项目依赖
首先，确保你的 pom.xml 中包含了 Spring Boot 的基本依赖以及 WebSocket 的支持。以下是一个基本的配置示例：
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
</dependencies>
2. 配置 WebSocket
接下来，你需要配置 WebSocket 的具体实现。创建一个 WebSocketConfig 类，使用 @Configuration 和 @EnableWebSocketMessageBroker 注解来启用消息代理。
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.subscripton.SubscriptionRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.MessageBrokerRegistry;
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"); // Enable a simple in-memory broker
config.setApplicationDestinationPrefixes("/app"); // Prefix for messages from clients to the server
}
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
registry.addEndpoint("/ws").setAllowedOrigins("*").withSockJS(); // WebSocket endpoint
}
}
3. 创建控制器
你需要一个控制器来处理 WebSocket 消息。下面是一个简单的控制器示例，它接收客户端发送的消息并将其返回给所有订阅者。
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class WebSocketController {
@MessageMapping("/hello")
@SendTo("/topic/greetings")
public String greeting(String message) throws Exception {
// 模拟处理消息的延迟
Thread.sleep(1000);
return "Hello, " + message + "!";
}
}
4. 前端集成
在 HTML 页面中使用 WebSocket。你可以使用 SockJS 和 Stomp.js 来实现。
<!DOCTYPE html>
<html>
<head>
<title>WebSocket 示例</title>
<script src="https://cdnjs.cloudflare.com/ajax/libs/sockjs-client/1.5.1/sockjs.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/stompjs/lib/stomp.min.js"></script>
</head>
<body>
<div>
<input id="name" type="text" placeholder="输入你的名字" />
<button onclick="sendName()">发送</button>
<div id="greetings"></div>
</div>
<script>
const socket = new SockJS('/ws');
const stompClient = Stomp.over(socket);
stompClient.connect({}, function (frame) {
console.log('连接成功: ' + frame);
stompClient.subscribe('/topic/greetings', function (greeting) {
showGreeting(JSON.parse(greeting.body).content);
});
});
function sendName() {
const name = document.getElementById('name').value;
stompClient.send("/app/hello", {}, JSON.stringify({'name': name}));
}
function showGreeting(message) {
const greetings = document.getElementById('greetings');
greetings.innerHTML += "<p>" + message + "</p>";
}
</script>
</body>
</html>
5. 运行项目
完成上述步骤后，启动你的 Spring Boot 项目。当你打开 HTML 页面并输入你的名字后，点击发送按钮，你会收到来自服务器的问候消息。
总结
通过上述步骤，我们成功地在 Spring Boot 中整合了 WebSocket，实现了简单的实时通讯功能。这种基于 WebSocket 的双向通讯方式，非常适合需要实时交互的场合，能够极大地提升用户体验。在实际开发中，可以根据应用的复杂性进一步扩展该示例，处理更复杂的业务逻辑和消息类型。
