# chat-room-backend

**Repository Path**: goatlzh/chat-room-backend

## Basic Information

- **Project Name**: chat-room-backend
- **Description**: 聊天室后端
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-06
- **Last Updated**: 2025-11-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java, SpringBoot, WebSocket

## README

# 在线聊天室后端

这是一个基于WebSocket的在线聊天室后端项目，允许用户登录并与其他在线用户进行实时聊天。

前端：https://gitee.com/goatlzh/chat-room-frontend

## 技术栈

- Java
- Spring Boot
- WebSocket
- Maven

## 功能特性

- 用户登录
- 获取当前用户名
- 实时聊天功能
- 广播消息给所有在线用户

## 项目结构

- `OnlineChatRoomApplication.java` - Spring Boot 应用的主类
- `config` - 存放配置类
- `controller` - 存放控制器类
- `pojo` - 存放实体类
- `utils` - 存放工具类
- `vo` - 存放视图对象类
- `websocket` - 存放WebSocket相关类

## 配置

配置文件位于 `application.yml`。

## 使用说明

1. 启动应用
2. 使用 `/user/login` 接口进行登录
3. 使用 `/user/getUsername` 接口获取当前用户名
4. 通过WebSocket连接 `/chat` 端点进行实时聊天

## 聊天消息格式

```json
{
  "toName": "接收者用户名",
  "message": "聊天消息内容"
}
```

## 结果消息格式

```json
{
  "isSystem": false,
  "fromName": "发送者用户名",
  "message": "消息内容"
}
```

## 贡献

欢迎贡献代码和提出问题。请先fork项目，然后提交pull request。

## 许可证

该项目使用 MIT 许可证。详情请查看 LICENSE 文件。