# EchoIM **Repository Path**: tigerxue/echo-im ## Basic Information - **Project Name**: EchoIM - **Description**: 基于 Spring Boot、Netty 和 Vue 3 的即时通讯系统,支持实时消息、语音视频通话、文件共享与后台管理。 - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-07 - **Last Updated**: 2026-11-08 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # EchoIM EchoIM 是一个前后端分离的网页版即时通讯系统。当前仓库包含一个 Spring Boot + Netty 后端、用户端 Vue 应用、管理后台 Vue 应用、数据库初始化脚本和 Docker/Nginx 部署配置。 ## 当前能力 ### 用户端 IM - 单聊、群聊、频道三类会话 - WebSocket 实时消息,支持 ACK、已读、输入中、在线状态、离线同步 - 文本、图片、文件、GIF、贴纸、语音消息 - 消息撤回、编辑、回复、转发、删除、置顶、表情回应 - 消息线程、群消息已读详情、语音转写搜索、未读摘要缓存 - 定时消息、草稿同步、阅后即焚、Saved Messages - 会话置顶、免打扰、归档、手动标记未读、会话文件列表 - 好友申请、好友列表、用户搜索、公开主页、邀请链接加入 - 群/频道成员管理、角色、公告、禁言、邀请链接、入群审批 - 一对一语音/视频通话信令与 WebRTC 客户端能力 - 多端设备状态同步、浏览器通知、Web Push 订阅配置 ### 平台与运营 - 管理员登录、数据看板、用户管理、组织管理、群组管理 - 系统配置、版本管理、靓号管理、操作日志 - 举报审核、敏感词管理、系统公告、用户封禁 - 开放平台应用、Access Key/Secret、Bot、Webhook 投递日志、OpenAPI JSON - 健康检查、WebSocket 指标、JVM 指标、前端错误上报 ## 技术栈 | 层级 | 技术 | |------|-----------------------------------------------------------------| | 后端 | Java 17, Spring Boot 3.5, MyBatis-Plus, Netty, Redis, MySQL | | 用户端 | Vue 3, TypeScript, Pinia, Element Plus, Vite, WebSocket, WebRTC | | 管理后台 | Vue 3, TypeScript, Pinia, Element Plus, Axios, Vite | | 文件存储 | 本地磁盘或AI云 OSS | | 部署 | Docker Compose, Nginx, GitHub Actions/GHCR | ## 项目结构 ```text EchoIM/ ├── backend/echoim-server/ # Spring Boot 后端与 Netty IM 服务 ├── frontend/echoim-web/ # 用户端 Vue 3 应用 ├── frontend/echoim-admin/ # 管理后台 Vue 3 应用 ├── sql/ # MySQL 初始化与增量脚本 ├── deploy/ # Docker、Nginx、生产部署脚本 ├── docs/ # 架构、接口、数据库、部署、设计和规划文档 ├── docker-compose.yml # 本地 MySQL + Redis + 后端编排 └── .env.example # 环境变量模板 ``` ## 本地开发 ### 环境要求 - JDK 17+ - Maven 3.8+ - Node.js 18+ - MySQL 8.0+/8.4 - Redis 8+ ### 1. 配置环境变量 ```bash cp .env.example .env ``` 本地开发可以使用默认 MySQL/Redis 连接,也可以按需修改 `.env`。至少建议设置: - `ECHOIM_JWT_SECRET`:JWT 签名密钥 - `SPRING_MAIL_*`:注册、登录挑战、找回密码所需 SMTP 配置 - `ECHOIM_FILE_STORAGE_TYPE=local`:不接 OSS 时使用本地文件存储 ### 2. 初始化数据库 ```bash mysql -u root -p echoim < sql/echoim20261107.sql ``` 初始账号: | 类型 | 账号 | 密码 | |------|---------------------------------|----------| | 管理员 | `admin` | `admin` | | 演示用户 | `echo_demo_01` 至 `echo_demo_05` | `123456` | ### 3. 启动后端 ```bash cd backend/echoim-server mvn spring-boot:run ``` - HTTP API:`http://localhost:8080` - WebSocket:`ws://localhost:8091/ws` - 健康检查:`http://localhost:8080/api/health` ### 4. 启动用户端 ```bash cd frontend/echoim-web npm install npm run dev ``` 默认地址:`http://localhost:5173` ### 5. 启动管理后台 ```bash cd frontend/echoim-admin npm install npm run dev ``` 默认地址:`http://localhost:5174` ## Docker 本地启动 根目录 `docker-compose.yml` 会启动 MySQL 8.4、Redis 7.4 和后端服务,不包含两个前端开发服务器。 ```bash cp .env.example .env docker compose up -d ``` 首次启动后初始化数据库: ```bash docker exec -i echoim-mysql sh -lc 'mysql -uroot -p"$MYSQL_ROOT_PASSWORD" --default-character-set=utf8mb4' < sql/init.sql docker exec -i echoim-mysql sh -lc 'mysql -uroot -p"$MYSQL_ROOT_PASSWORD" --default-character-set=utf8mb4 echoim' < sql/initdata.sql ``` ## 生产部署 当前生产部署脚本采用“前端静态产物 + 后端镜像”的布局: - CI 构建用户端和管理后台 `dist/`,打包成 `frontend-web-dist.tgz` 和 `frontend-admin-dist.tgz` - CI 构建并推送 `echoim-backend` 镜像到 GHCR - 服务器脚本把前端产物解压到 `/srv/echoim/frontend/releases//web` 和 `/admin` - 宿主机/宝塔 Nginx 托管 `/` 和 `/admin/` 静态资源,并代理 `/api/` 到 `127.0.0.1:18081`、`/ws` 到 `127.0.0.1:18091` - MySQL、Redis 默认部署在宿主机或外部服务,由后端容器通过 `host.docker.internal` 访问 生产说明见 [deploy/production/README.md](/prd/README.md)。通用部署说明见 [docs/deployment/README.md](/docs/deployment/README.md)。 ## 常用校验 ```bash # 后端测试 cd backend/echoim-server && mvn test # 用户端 cd frontend/echoim-web && npm run typecheck && npm run build # 管理后台 cd frontend/echoim-admin && npm run typecheck && npm run build ``` 用户端还包含 Playwright 用例: ```bash cd frontend/echoim-web npm run test:e2e npm run test:a11y ``` ## 文档入口 - [接口文档](/docs/api/README.md) - [系统架构](/docs/architecture/README.md) - [数据库设计](/docs/database/README.md) - [部署指南](/docs/deployment/README.md) - [UI/UX 设计](/docs/design/README.md) - [产品需求](/docs/prd/README.md) - [用户指南](/docs/user-manual/README.md) - [未来规划](/docs/future/README.md) - [数据库脚本说明](/sql/README.md)