143cb8aa5f
- CURRENT_STATUS.md: 更新 Phase 2b 完成状态（10 个 Task） - 新增功能描述（IM/会话/WS事件/REST API/前端页面/数据库） - 更新目录结构、技术决策、测试指南 - 下一阶段规划更新为 Phase 2c - project-context.mdc: 更新当前进度和模块列表 Made-with: Cursor
102 lines
6.5 KiB
Plaintext
102 lines
6.5 KiB
Plaintext
---
|
||
description: EchoChat 项目上下文与开发记忆 - 每次新对话自动加载
|
||
alwaysApply: true
|
||
---
|
||
|
||
# EchoChat 项目上下文
|
||
|
||
## 快速恢复上下文
|
||
|
||
**新对话开始时，必须先读取以下文件恢复项目记忆：**
|
||
|
||
1. `docs/progress/CURRENT_STATUS.md` — 项目开发进度、已完成 Task、关键技术决策、下一步工作
|
||
2. 当前阶段的实施计划文档（位于 `docs/plans/` 目录下）
|
||
|
||
## 当前进度
|
||
|
||
- **Phase 1（基础设施与用户认证）**：✅ 全部完成（11 个 Task）
|
||
- **Phase 2a（WebSocket 实时通讯与联系人管理）**：✅ 全部完成（13 个 Task + 后期 Bug 修复 3 项）
|
||
- **Phase 2b（即时通讯消息系统）**：✅ 核心功能开发完成（10 个 Task），设计文档 `docs/plans/2026-03-03-phase2b-design.md`
|
||
- 分支：`feature/phase2b-instant-messaging`
|
||
- **跨模块通信模式**：已建立接口注入标准（ws.FriendIDsGetter / im.FriendChecker / im.UserInfoGetter → contact.FriendshipDAO，im.OfflineMessagePusher → ws.Handler）
|
||
|
||
## 项目概述
|
||
|
||
EchoChat 是一个实时音视频通讯平台，包含三个子项目：
|
||
- `backend/go-service/` — Go 后端（Gin + GORM + Wire + Redis + gorilla/websocket）
|
||
- `frontend/` — 前台用户端（uni-app + Vue 3.4 + Pinia 2.x）
|
||
- `admin/` — 后台管理端（Vue 3.5+ + Element Plus + Pinia 3.x）
|
||
|
||
已实现模块：auth（认证）、contact（联系人）、ws（WebSocket）、admin（管理端）、im（即时通讯）
|
||
|
||
## 核心开发规则
|
||
|
||
1. **前端设计**：必须使用 openskills 安装的 `ui-ux-pro-max` 技能包，脚本绝对路径为 `/Users/bojinyuan/.agent/skills/ui-ux-pro-max/scripts/search.py`。**严禁使用** `.cursor/skills/ui-ux-pro-max.bak/` 目录下的任何文件，该目录已废弃。禁止手动设计系统
|
||
2. **工作流**：使用 superpowers 流程控制开发节奏
|
||
3. **两端差异**：`frontend/` 和 `admin/` 是完全独立的项目，技术栈不需要统一
|
||
4. **模块系统**：前端统一使用 ESM（`export`/`import`），禁止 CommonJS
|
||
5. **Go 常量命名**：camelCase（`UserStatusActive`），非大写下划线
|
||
6. **API 响应**：统一 `{ "code": 0, "message": "success", "data": ... }`
|
||
7. **JWT 策略**：有状态 JWT，Token 存 Redis（按 clientType 隔离：`echo:auth:token:{frontend|admin}:{user_id}`），前后台互不影响
|
||
8. **角色等级体系**：`auth_roles.level` 字段（值越小权限越高：1=超管, 10=管理员, 100=普通用户），所有管理操作强制执行层级权限校验
|
||
9. **代码注释**：所有公开函数、组件、Store 必须有详细注释
|
||
10. **文档自动同步（强制）**：每个 Task 或功能开发完成后，必须自动执行文档同步，详见下方「文档自动同步规则」
|
||
11. **验证方式**：使用 Playwright MCP 进行页面自动化验证
|
||
12. **代码审查**：每个 Task 完成后，使用 `code-reviewer` 子代理进行结构化审查，确保代码质量和计划一致性
|
||
13. **完成验证**：使用 `verification-before-completion` 技能，在声称完成前运行验证命令并确认输出
|
||
|
||
## 文档自动同步规则（强制执行）
|
||
|
||
**触发时机**：每个 Task 或功能模块开发完成后，代码提交前，必须自动检查并更新以下文档，无需用户提醒。
|
||
|
||
### 必须检查的文档清单
|
||
|
||
| 文档 | 路径 | 更新条件 |
|
||
|------|------|---------|
|
||
| 项目进度 | `docs/progress/CURRENT_STATUS.md` | 每个 Task 完成后更新 Task 状态表、新增功能描述 |
|
||
| 架构设计 | `docs/architecture/system-architecture.md` | 新增模块、路由、中间件、数据流变化时更新 |
|
||
| 当前阶段设计文档 | `docs/plans/20xx-xx-xx-phaseXx-design.md` | 设计变更、状态变更时更新 |
|
||
| 总体系统设计 | `docs/plans/2026-02-27-echochat-system-design.md` | API 列表、页面结构、数据库表、分期规划变更时更新 |
|
||
| API 文档导航 | `docs/api/README.md` | 新增 API 文档文件时更新导航表和目录结构 |
|
||
| 模块 API 文档 | `docs/api/{frontend,admin}/*.md` | 新增/修改 API 接口时更新对应模块文档 |
|
||
| 开发规范 | `docs/conventions/frontend-backend-integration.md` | 新增通用规范（错误处理、协议、联动模式）时更新 |
|
||
| 项目规则 | `.cursor/rules/project-context.mdc` | 进度变更、新规则、新模块时更新 |
|
||
|
||
### 文档质量要求
|
||
|
||
1. **单文件 ≤ 500 行**：超过时拆分为独立文件，在导航中添加链接
|
||
2. **状态标记实时**：Task 完成后立即将状态标记从 🔜/📋 改为 ✅
|
||
3. **结构一致**：新增内容遵循现有文档的格式和层级结构
|
||
4. **交叉引用**：相关文档之间保持引用链接一致（如设计文档引用 API 文档路径）
|
||
5. **日期更新**：文档头部的「最后更新」日期保持最新
|
||
|
||
### 每阶段（Phase）结束时的额外检查
|
||
|
||
- 当前阶段设计文档状态标记为「✅ 已完成」
|
||
- 总体设计文档的开发分期部分更新完成标记
|
||
- project-context.mdc 的当前进度更新
|
||
- CURRENT_STATUS.md 的下一阶段规划更新
|
||
|
||
## 前后端联动规范（必须遵守）
|
||
|
||
> 详细规范见 `docs/conventions/frontend-backend-integration.md`
|
||
|
||
1. **前后台路由严格分离（最高优先级）**：
|
||
- 前台用户端 API：`/api/v1/auth/*`、`/api/v1/im/*`、`/api/v1/meeting/*` 等
|
||
- 后台管理端 API：`/api/v1/admin/auth/*`、`/api/v1/admin/users/*` 等
|
||
- **禁止任何混用**：admin 前端不得调用 `/api/v1/auth/*`，frontend 不得调用 `/api/v1/admin/*`
|
||
- 新增功能时必须先确认归属哪端，使用对应的路由前缀
|
||
2. **Token Redis 存储隔离**：按 `clientType` 隔离：`echo:auth:token:{frontend|admin}:{user_id}`，JWT Claims 包含 `client_type` 字段
|
||
3. **错误提示统一**：前端所有 HTTP 错误提示必须优先使用后端 `data.message`，禁止硬编码覆盖后端信息
|
||
4. **安全防护**：后端登录接口对"用户不存在"与"密码错误"统一返回 401 + "账号或密码错误"
|
||
5. **401 场景区分**：前端拦截器区分「登录请求的 401」（仅提示错误）和「已认证请求的 401」（清 Token + 跳转登录页）
|
||
6. **响应格式一致**：后端所有响应必须使用 `utils.Response*` 系列函数
|
||
7. **业务错误映射**：后端 Controller 的 `handleError` 函数必须覆盖所有已知业务错误，不能忽略 error（`_`）
|
||
|
||
## 设计系统
|
||
|
||
持久化在 `design-system/echochat/` 目录：
|
||
- `MASTER.md` — 全局设计规范
|
||
- `pages/*.md` — 页面级覆盖规则
|
||
- 色板：Primary `#2563EB` / BG `#F8FAFC` / Text `#1E293B`
|