SpringBoot实现WebSocket服务并让客户端实时接收
更新时间：2024年10月30日 08:36:48 作者：m0_74825409
使用SpringBoot和WebSocket可创建实时消息推送服务,首先添加WebSocket依赖至pom.xml,配置WebSocket端点和逻辑处理器,通过WebSocketHandler处理消息,使用AnnouncementController模拟消息推送,支持HTML和微信小程序客户端接收消息,感兴趣的可以了解一下
在 Spring Boot 中实现 WebSocket 服务并让客户端实时接收消息，可以使用 Spring Boot 内置的 WebSocket 支持。下面我为你提供一个基于 Spring Boot 和 WebSocket 的完整 Demo。
1. 引入依赖
首先，在 pom.xml 中添加 WebSocket 的依赖：
<dependencies>
<!-- WebSocket 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
</dependencies>
2. WebSocket 配置
创建一个配置类 WebSocketConfig.java，用于配置 WebSocket 的端点和处理逻辑。
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) {
// 注册 WebSocket 处理器和端点
registry.addHandler(new WebSocketHandler(), "/websocket")
.setAllowedOrigins("*"); // 允许跨域
}
}
3. WebSocket 处理器
创建 WebSocketHandler.java，处理 WebSocket 的连接、消息接收、消息广播等操作。
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
import java.util.HashSet;
import java.util.Set;
public class WebSocketHandler extends TextWebSocketHandler {
// 用于保存所有连接的 WebSocket 会话
private static final Set<WebSocketSession> sessions = new HashSet<>();
// 当有客户端连接时调用
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
sessions.add(session);
session.sendMessage(new TextMessage("欢迎连接 WebSocket 服务器！"));
}
// 当有消息从客户端发送过来时调用
@Override
protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
System.out.println("收到客户端消息: " + message.getPayload());
}
// 当连接关闭时调用
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
sessions.remove(session);
}
// 广播消息给所有连接的客户端
public static void broadcast(String message) throws Exception {
for (WebSocketSession session : sessions) {
if (session.isOpen()) {
session.sendMessage(new TextMessage(message));
}
}
}
}
4. 模拟公告推送
创建一个控制器 AnnouncementController.java，模拟公告的发布功能。发布公告时，会调用 WebSocket 处理器的 broadcast 方法，将消息推送给所有已连接的客户端。
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class AnnouncementController {
@GetMapping("/announce")
public String sendAnnouncement() {
try {
// 模拟公告内容
String announcement = "新公告发布于: " + System.currentTimeMillis();
WebSocketHandler.broadcast(announcement);
return "公告已发布: " + announcement;
} catch (Exception e) {
e.printStackTrace();
return "发布失败";
}
}
}
5. 运行步骤
1. 启动 Spring Boot 应用
启动 Spring Boot 项目后，WebSocket 服务器将会在 /websocket 端点上监听。
2. 小程序或网页客户端
客户端可以是小程序或者网页。这里提供一个简单的 HTML 客户端来测试 WebSocket 连接。
HTML 客户端代码（用于测试 WebSocket 连接）：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>WebSocket Demo</title>
</head>
<body>
<h1>WebSocket Demo</h1>
<div id="messages"></div>
<script>
// 连接 WebSocket 服务器
var socket = new WebSocket("ws://localhost:8080/websocket");
socket.onopen = function() {
console.log("连接成功！");
};
socket.onmessage = function(event) {
console.log("收到消息:", event.data);
document.getElementById("messages").innerHTML += "<p>" + event.data + "</p>";
};
socket.onclose = function() {
console.log("连接关闭！");
};
</script>
</body>
</html>
3. 发布公告
使用浏览器访问 http://localhost:8080/announce，每次访问该地址时，服务器会推送一条公告消息给所有连接的 WebSocket 客户端。
6. 小程序端实现
你也可以在微信小程序中使用类似的方式，通过 WebSocket 接收服务器推送的公告。
Page({
data: {
messages: [] // 保存接收到的公告消息
},
onLoad: function() {
// 连接 WebSocket 服务器
wx.connectSocket({
url: 'ws://localhost:8080/websocket', // 注意修改为你的服务器地址
success: (res) => {
console.log('WebSocket 连接成功！');
},
fail: (err) => {
console.error('WebSocket 连接失败', err);
}
});
// 监听 WebSocket 消息
wx.onSocketMessage((res) => {
console.log('收到服务器消息:', res.data);
this.setData({
messages: [...this.data.messages, res.data] // 将新消息添加到列表中
});
});
// 监听 WebSocket 连接关闭
wx.onSocketClose((res) => {
console.log('WebSocket 已关闭', res);
});
}
});
7. 总结
- 通过 Spring Boot 的 WebSocket 支持，可以在服务器端推送实时公告。
- 客户端可以是 HTML 页面，也可以是微信小程序，使用 WebSocket 接口接收公告消息。
到此这篇关于SpringBoot实现WebSocket服务并让客户端实时接收的文章就介绍到这了,更多相关SpringBoot WebSocket实时接收内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
本文主要介绍了WxJava微信公众号开发入门实战，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-06-06
这篇文章主要介绍了Java 插入排序之希尔排序的实例的相关资料,需要的朋友可以参考下2017-07-07
这篇文章主要给大家介绍了关于java中接口和事件监听器的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用java具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧2019-12-12
这篇文章主要介绍了Java分层概念详解，内容十分详细，在这里给大家分享下，需要的朋友可以参考。2017-09-09
java发送HttpClient请求及接收请求结果过程的简单实例
下面小编就为大家带来一篇java发送HttpClient请求及接收请求结果过程的简单实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2016-11-11
这篇文章主要介绍了Java 安全模型。Java的安全模型是其多个重要结构特点之一，它使Java成为适用于网络环境的技术。Java安全模型侧重于保护终端用户免受从网络下载的、来自不可靠来源的、恶意程序(以及善意程序中的bug)的侵犯。,需要的朋友可以参考下2019-06-06
你提交了一些任务，但你想等它们都完成了再做另外一些事情；你提交了一些任务，但是不想让它们立刻执行，等你喊123开始的时候，它们才开始执行；等等这些场景，线程之间需要相互配合，或者等待某一个条件成熟执行。这些场景想你就需要用到同步辅助类2014-04-04
这篇文章主要介绍了SpringBoot 签到奖励实现方案的示例代码，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-08-08
这篇文章主要介绍了Maven多模块及version修改的实现方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2019-06-06
在Java中,==和equals都是用于比较两个对象的操作符,但它们的行为和用途有所不同,这篇文章主要介绍了java的==运算符和equals的相关知识,需要的朋友可以参考下2024-08-08
最新评论