# spring-stomp-deme **Repository Path**: GRH8/spring-stomp-deme ## Basic Information - **Project Name**: spring-stomp-deme - **Description**: WebSocket 实时通信 demo - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-08-02 - **Last Updated**: 2026-08-02 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Spring Boot STOMP WebSocket Demo 这是一个基于 Spring Boot 和 STOMP 协议的 WebSocket 实时聊天应用演示。 ## 功能特性 - ✅ 实时公共聊天室 - ✅ 私聊消息支持 - ✅ 用户加入通知 - ✅ 美观的 UI 界面 - ✅ SockJS 回退支持 - ✅ 时间戳显示 ## 技术栈 - Spring Boot 3.2.0 - Spring WebSocket - STOMP 协议 - SockJS - Java 17+ ## 项目结构 ``` spring-stomp-demo/ ├── src/main/java/com/example/websocket/ │ ├── WebSocketApplication.java # Spring Boot 启动类 │ ├── config/ │ │ └── WebSocketConfig.java # WebSocket 配置 │ ├── controller/ │ │ └── ChatController.java # 消息控制器 │ └── model/ │ ├── ChatMessage.java # 请求消息模型 │ └── OutputMessage.java # 响应消息模型 └── src/main/resources/ ├── application.yml # 应用配置 └── static/ └── index.html # 聊天客户端页面 ``` ## 快速开始 ### 1. 环境要求 - JDK 17 或更高版本 - Maven 3.6+ ### 2. 构建项目 ```bash mvn clean install ``` ### 3. 运行应用 ```bash mvn spring-boot:run ``` 或者在 IDE 中直接运行 `WebSocketApplication` 类。 ### 4. 访问应用 打开浏览器访问: http://localhost:8080 ## 使用说明 1. 打开浏览器访问 http://localhost:8080 2. 输入用户名加入聊天室 3. 可以打开多个浏览器窗口,使用不同的用户名 4. 在任意窗口发送消息,所有窗口都能实时收到 5. 查看系统通知消息 ## WebSocket 端点说明 ### 连接端点 - **URL**: `/ws` - **协议**: WebSocket (SockJS) ### 消息路由 #### 客户端 → 服务器 - `/app/chat.sendMessage` - 发送公共聊天消息 - `/app/chat.addUser` - 用户加入聊天室 - `/app/chat.sendPrivate` - 发送私聊消息 #### 服务器 → 客户端 - `/topic/public` - 公共消息订阅频道 - `/user/queue/private` - 私聊消息订阅频道 ## STOMP 协议流程 1. **连接**: 客户端通过 SockJS 连接到 `/ws` 端点 2. **订阅**: 订阅 `/topic/public` 接收公共消息 3. **发送**: 通过 `/app/chat.sendMessage` 发送消息 4. **广播**: 服务器通过 `@SendTo("/topic/public")` 广播消息 5. **接收**: 所有订阅者实时收到消息 ## 配置说明 在 `application.yml` 中可以修改: - 服务器端口 (默认 8080) - 日志级别 在 `WebSocketConfig.java` 中可以修改: - WebSocket 端点路径 - 消息代理前缀 - 应用目标前缀 ## 核心代码解析 ### WebSocketConfig.java ```java @Configuration @EnableWebSocketMessageBroker public class WebSocketConfig implements WebSocketMessageBrokerConfigurer { // 配置消息代理和 STOMP 端点 } ``` ### ChatController.java ```java @MessageMapping("/chat.sendMessage") @SendTo("/topic/public") public OutputMessage sendMessage(@Payload ChatMessage chatMessage) { // 处理消息并广播给所有订阅者 } ``` ## 扩展建议 - 添加消息持久化 (数据库存储) - 实现用户认证和授权 - 添加表情包支持 - 实现群聊功能 - 添加消息已读回执 - 实现在线用户列表 ## 许可证 MIT License