本文由 简悦 SimpRead 转码， 原文地址 blog.csdn.net
本文将详细介绍如何在 Spring Boot 应用程序中实现 WebSocket 实时通信。我们将探讨 WebSocket 的基本概念，以及如何使用 Spring Boot 和 Spring WebSocket 模块来实现 WebSocket 服务器和客户端。此外，我们将通过具体的示例来展示如何在 Spring Boot 应用程序中配置和使用 WebSocket，以及如何实现实时消息传递和群发消息等功能。本文适合希望使用 WebSocket 技术实现实时通信的 Spring Boot 开发者阅读。
一、引言
在现代 Web 应用程序中，实时通信是一个关键需求，用于实现即时消息传递、在线聊天、实时数据同步等功能。WebSocket 是一种网络通信协议，它提供了一种全双工通信渠道，允许服务器和客户端之间进行实时数据交换。Spring Boot 提供了一种简便的方式来集成 WebSocket 技术，以实现实时通信功能。本文将介绍如何在 Spring Boot 应用程序中实现 WebSocket 实时通信。
二、WebSocket 的基本概念
1. 什么是 WebSocket？
WebSocket 是一种网络通信协议，它提供了一种全双工通信渠道，允许服务器和客户端之间进行实时数据交换。WebSocket 协议基于 TCP 协议，通过 WebSocket 连接，服务器和客户端可以相互发送消息，实现实时通信。
2. WebSocket 的特点
- 全双工通信：WebSocket 协议支持服务器和客户端之间的全双工通信，客户端和服务器可以同时发送消息。
- 持久连接：WebSocket 连接一旦建立，将持续保持打开状态，直到客户端或服务器关闭连接。
- 跨域通信：WebSocket 协议支持跨域通信，允许不同域的服务器与客户端建立连接。
三、在 Spring Boot 中实现 WebSocket 实时通信
1. 添加 Spring WebSocket 依赖
在项目的 pom.xml 文件中，添加 Spring Boot 的 Spring WebSocket 依赖：
<dependencies>
<!-- Spring Boot Web依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Spring Boot WebSocket依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
</dependencies>
2. 创建 WebSocket 配置类
创建一个 WebSocket 配置类，用于配置 WebSocket 服务器端点。以下是一个简单的 WebSocket 配置类示例：
package com.example.demo.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.*;
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
@Override
public void configureMessageBroker(MessageBrokerRegistry config) {
config.enableSimpleBroker("/topic");
config.setApplicationDestinationPrefixes("/app");
}
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
registry.addEndpoint("/websocket-endpoint").withSockJS();
}
}
在上面的代码中，我们创建了一个名为WebSocketConfig的配置类，它实现了WebSocketMessageBrokerConfigurer接口。这个类用于配置 WebSocket 消息代理和注册 STOMP（Simple Text Oriented Messaging Protocol）端点。
3. 创建消息模型
创建一个简单的消息模型类，用于表示 WebSocket 消息。以下是一个简单的消息模型类示例：
package com.example.demo.model;
public class Message {
private String content;
private String sender;
// getter和setter方法
}
在上面的代码中，我们创建了一个名为Message的模型类，它包含两个属性：content和sender。
4. 创建消息处理器
创建一个消息处理器类，用于处理 WebSocket 消息。以下是一个简单的消息处理器类示例：
package com.example.demo.handler;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo
import org.springframework.stereotype.Controller;
@Controller
public class MessageHandler {
@MessageMapping("/send")
@SendTo("/topic/messages")
public Message sendMessage(Message message) {
return new Message("Hello, WebSocket!", "System");
}
}
在上面的代码中，我们创建了一个名为MessageHandler的控制器类，它包含一个名为sendMessage的方法。这个方法将处理发送到/send目的地的消息，并将消息发送到/topic/messages主题。
5. 创建前端代码
创建一个简单的 HTML 页面和 JavaScript 代码，用于连接到 WebSocket 服务器并发送消息。以下是一个简单的 HTML 页面示例：
<!DOCTYPE html>
<html>
<head>
<title>WebSocket Demo</title>
<script src="https://cdn.jsdelivr.net/npm/sockjs-client/dist/sockjs.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/stompjs/lib/stomp.min.js"></script>
</head>
<body>
<div>
<input type="text" id="messageInput" placeholder="Type a message...">
<button onclick="sendMessage()">Send</button>
</div>
<ul id="messagesList"></ul>
<script>
var socket = new SockJS('/websocket-endpoint');
var stompClient = Stomp.over(socket);
stompClient.connect({}, function (frame) {
stompClient.subscribe('/topic/messages', function (message) {
var messagesList = document.getElementById('messagesList');
var listItem = document.createElement('li');
listItem.textContent = message.body;
messagesList.appendChild(listItem);
});
});
function sendMessage() {
var messageInput = document.getElementById('messageInput');
stompClient.send('/app/send', {}, messageInput.value);
messageInput.value = '';
}
</script>
</body>
</html>
在上面的代码中，我们创建了一个简单的 HTML 页面，包含一个输入框和一个按钮。当用户点击按钮时，JavaScript 代码会连接到 WebSocket 服务器，并订阅/topic/messages主题。当服务器发送消息到该主题时，JavaScript 代码会将消息添加到页面上的消息列表。
四、实现实时消息传递和群发消息
1. 实时消息传递
要实现实时消息传递，我们可以在MessageHandler类中创建一个方法，用于接收并处理从客户端发送的消息。以下是一个实现实时消息传递的示例：
package com.example.demo.handler;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;
@Controller
public class MessageHandler {
// 省略其他代码
@MessageMapping("/receive")
@SendTo("/topic/messages")
public Message receiveMessage(Message message) {
return new Message("Received your message: " + message.getContent(), "System");
}
}
在上面的代码中，我们添加了一个名为receiveMessage的方法，用于接收并处理发送到/receive目的地的消息。这个方法会将接收到的消息发送到/topic/messages主题。
2. 群发消息
要实现群发消息，我们可以在WebSocketConfig类中配置一个广播代理。以下是一个实现群发消息的示例：
package com.example.demo.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.*;
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
// 省略其他代码
@Override
public void configureMessageBroker(MessageBrokerRegistry config) {
config.enableSimpleBroker("/topic");
config.setApplicationDestinationPrefixes("/app");
config.setBrokerDeliveryMode(MessageBrokerRegistry.BrokerDeliveryMode.BROADCASTING);
}
// 省略其他代码
}
在上面的代码中，我们通过将setBrokerDeliveryMode方法的参数设置为BROADCASTING来启用广播代理。这意味着所有发送到/topic/messages主题的消息都会被广播到所有连接的客户端。
五、总结
本文详细介绍了如何在 Spring Boot 应用程序中实现 WebSocket 实时通信。我们首先了解了 WebSocket 的基本概念和特点，然后学习了如何使用 Spring Boot 和 Spring WebSocket 模块来实现 WebSocket 服务器和客户端。我们还通过具体的示例展示了如何在 Spring Boot 应用程序中配置和使用 WebSocket，以及如何实现实时消息传递和群发消息等功能。
通过本文，您应该已经掌握了如何使用 Spring Boot 实现 WebSocket 实时通信。您学会了如何添加 Spring WebSocket 依赖、创建 WebSocket 配置类、创建消息模型、创建消息处理器，以及如何实现实时消息传递和群发消息。希望本文能够帮助您在开发 Spring Boot 应用程序时更加得心应手。如果您有任何疑问或建议，请随时留言交流。