介绍
WebSocket是一种全双工通信协议，可实现实时通信。在Web应用程序中，实时通信对于实现即时更新和交互性非常重要。Spring Boot框架提供了简单易用的功能来开发基于WebSocket的实时通信功能。
什么是WebSocket？
WebSocket是HTML5中的一种协议，它利用HTTP协议进行握手，并通过一个持久化的连接实现全双工通信。WebSocket与传统的HTTP请求响应模式不同，它能够在客户端和服务器之间建立一条持久化连接，使得服务器可以主动向客户端推送数据，而不需要客户端发送请求。这使得实时通信成为可能。
Spring Boot中使用WebSocket的步骤
- 创建一个Spring Boot项目。
- 添加依赖：在项目的
pom.xml文件中添加以下依赖：
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
</dependencies>
- 创建一个WebSocket配置类：创建一个
WebSocketConfig类，用于配置WebSocket相关的配置。
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
registry.addHandler(myWebSocketHandler(), "/my-websocket")
.setAllowedOrigins("*");
}
@Bean
public WebSocketHandler myWebSocketHandler() {
return new MyWebSocketHandler();
}
}
在上面的代码中，我们通过使用@Configuration注解将类标记为配置类，并通过@EnableWebSocket注解启用WebSocket功能。然后，我们使用registerWebSocketHandlers方法注册了一个MyWebSocketHandler的实例，并指定了关联的URL路径为/my-websocket。setAllowedOrigins("*")表示允许所有的来源进行连接。
4. 创建一个WebSocket处理器类：创建一个MyWebSocketHandler类，用于处理WebSocket相关的业务逻辑。
public class MyWebSocketHandler extends TextWebSocketHandler {
private final List<WebSocketSession> sessions = new CopyOnWriteArrayList<>();
@Override
public void handleTextMessage(WebSocketSession session, TextMessage message) throws IOException {
for (WebSocketSession wsSession : sessions) {
wsSession.sendMessage(message);
}
}
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
sessions.add(session);
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
sessions.remove(session);
}
}
在上面的代码中，我们定义了一个MyWebSocketHandler类，继承自TextWebSocketHandler类。我们重写了handleTextMessage方法，用于处理收到的文本消息。在这个例子中，我们将消息发送给所有的连接。我们还重写了afterConnectionEstablished方法，在建立连接时将连接加入到一个列表中，以及重写了afterConnectionClosed方法，在连接关闭时将连接从列表中移除。
- 创建一个WebSocket页面：创建一个HTML页面，用于测试WebSocket连接。
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>WebSocket Example</title>
<script type="text/javascript">
var socket = new WebSocket("ws://localhost:8080/my-websocket");
socket.onopen = function() {
console.log("WebSocket connection opened.");
}
socket.onmessage = function(event) {
console.log("WebSocket message received: " + event.data);
}
socket.onclose = function() {
console.log("WebSocket connection closed.");
}
function sendMessage() {
var message = document.getElementById("message").value;
socket.send(message);
}
</script>
</head>
<body>
<input type="text" id="message" placeholder="Enter a message">
<button onclick="sendMessage()">Send</button>
</body>
</html>
运行和测试
- 启动应用程序。
- 打开浏览器，访问
http://localhost:8080，进入WebSocket页面。 - 在文本框中输入消息，然后点击发送按钮。
- 在控制台中查看WebSocket连接状态和接收到的消息。
结论
通过以上的步骤，我们可以实现基于WebSocket的实时通信功能。Spring Boot提供了简单易用的功能来配置和使用WebSocket，使得开发实时通信功能变得更加容易和便捷。
希望本篇教程对于初学Spring Boot的开发人员有所帮助。如有任何疑问或建议，请随时留言。感谢阅读！
本文来自极简博客，作者：倾城之泪，转载请注明原文链接：Spring Boot编程基础教程：WebSocket实时通信
