Phase 2c 全部 14 个 Task 完成,包含: 后端(Go): - MinIO 文件存储服务集成(Docker + Go SDK + 通用上传 API) - Group 模块完整实现(DAO + Service + Controller + Router + Wire) - 18 个群管理 REST API + 11 个 WS 群事件推送 - 群创建/解散/邀请/踢人/退出/转让群主/设管理员/禁言/全体禁言/群公告/群昵称/免打扰/搜索 - IM Service 扩展(群消息发送/撤回 + @提醒 + 管理员无时限撤回) - 已读回执后端(单聊会话级 last_read_msg_id + 群聊消息级 im_message_reads) - 管理端群组管理(列表/详情/解散) - 数据库迁移(3 张新表 + 2 张表字段扩展) 前端(uni-app): - 群聊 Store + API 封装 + 11 个 WS 事件监听 - 已读回执 UI(单聊已读/未读标记 + 群聊 X人已读 + 已读详情页) - 7 个群聊页面(对话/创建/设置/成员/邀请/审批/搜索) - 会话列表改造(全部/单聊/群聊 Tab + @标记 + 免打扰标识) 管理端(Vue 3 + Element Plus): - 群组列表页(搜索/分页/详情弹窗/解散群聊) - 侧边栏群组管理入口 文档同步:进度/架构/设计/API/规范文档全部更新 Made-with: Cursor
346 lines
17 KiB
Markdown
346 lines
17 KiB
Markdown
# EchoChat 项目开发进度
|
||
|
||
> **最后更新**:2026-03-04(Phase 2c 代码审查修复完成)
|
||
> **当前阶段**:Phase 2c 代码审查修复完成,待最终验证
|
||
> **当前分支**:`feature/phase2c-group-read-receipt`
|
||
> **实施计划**:`docs/plans/2026-03-04-phase2c-implementation.plan.md`
|
||
> **设计文档**:`docs/plans/2026-03-04-phase2c-design.md`
|
||
|
||
---
|
||
|
||
## 一、Phase 2b Task 完成状态
|
||
|
||
| Task | 描述 | 状态 | 备注 |
|
||
|------|------|------|------|
|
||
| Task 0 | IM Model + 数据库迁移 + 常量 | ✅ 完成 | 3 张表 + init.sql + AutoMigrate |
|
||
| Task 1 | WS 事件路由表机制 | ✅ 完成 | Hub.RegisterEvent/DispatchEvent |
|
||
| Task 2 | IM DAO 层 | ✅ 完成 | ConversationDAO + MessageDAO |
|
||
| Task 3 | IM Service 核心业务 + DTO | ✅ 完成 | 9 个业务方法 + 接口注入 |
|
||
| Task 4 | WS 事件处理器 + 离线推送 | ✅ 完成 | 4 个事件 + OfflinePusher |
|
||
| Task 5 | REST Controller + Router + Wire | ✅ 完成 | 7 个 REST API + 完整 Wire 集成 |
|
||
| Task 6 | 前台 Store + API + WS 事件 | ✅ 完成 | chat.js Store + API + TabBar badge |
|
||
| Task 7 | 会话列表页 + 聊天对话页 | ✅ 完成 | 2 个核心页面 |
|
||
| Task 8 | 设置页 + 搜索页 + 联系人改造 | ✅ 完成 | 2 个辅助页面 + 发消息跳转 |
|
||
| Task 9 | 文档更新 + 代码审查 | ✅ 完成 | 进度/架构文档同步 |
|
||
| UI 改造 | ui-ux-pro-max 规范改造 | ✅ 完成 | uni-icons 替换 emoji + 设计规范文件 |
|
||
| 代码审查修复 | 后端 7 项修复 | ✅ 完成 | P0×2 + P1×3 + 推送补全×2 |
|
||
| 用户测试修复 | 8 项 Bug 修复 | ✅ 完成 | 好友申请/接受、在线状态、UI 布局等 |
|
||
|
||
### 代码审查修复详情
|
||
|
||
| # | 优先级 | 修复内容 |
|
||
|---|--------|----------|
|
||
| Fix 1 | P0 | ClearHistory 改为个人视图操作(ClearBeforeMsgID),不再删除双方消息 |
|
||
| Fix 2 | P0 | Redis 未读数负数保护(Lua 脚本原子递减,下限为 0) |
|
||
| Fix 3 | P1 | GetConversationList N+1 查询优化(LEFT JOIN 一次获取 peerID) |
|
||
| Fix 4 | P1 | 消息搜索改用 GIN 全文索引(to_tsvector/plainto_tsquery 替代 LIKE) |
|
||
| Fix 5 | P1 | 撤回消息后更新会话预览(last_msg_content = "XX 撤回了一条消息") |
|
||
| Fix 6 | - | im.message.new 推送补充 sender_name、sender_avatar |
|
||
| Fix 7 | - | im.message.recalled 推送补充 sender_id |
|
||
|
||
### 用户测试修复详情
|
||
|
||
| # | 修复内容 |
|
||
|---|----------|
|
||
| Fix 8 | 好友申请拒绝后重新申请失败 — FriendshipDAO 新增 ReactivateRejectedRequest 方法 |
|
||
| Fix 9 | 好友接受申请失败(反向记录 UNIQUE 冲突)— AcceptRequest 先查后改,避免重复插入 |
|
||
| Fix 10 | Redis 在线状态残留 — OnlineService 启动时清理旧在线数据(cleanStaleOnlineData) |
|
||
| Fix 11 | WS 断开时在线状态未清理 — 修正 onDisconnect 判断条件(closedByHub && isOnline) |
|
||
| Fix 12 | 前端 WS 连接未全局初始化 — App.vue onLaunch/onShow + login.vue 登录后建立连接 |
|
||
| Fix 13 | 后台管理端好友关系页用户 A 列名称错误 — 修正字段绑定 row.user_username |
|
||
| Fix 14 | 前台好友在线状态初始值缺失 — ContactService 注入 OnlineChecker,GetFriendList 返回 is_online |
|
||
| Fix 15 | 聊天页消息过多时输入框被挤出 — scroll-view 添加 height:0 + min-height:0 约束 |
|
||
|
||
---
|
||
|
||
## 二、Phase 2b 新增功能
|
||
|
||
### 即时通讯(IM)
|
||
- **消息收发**:WebSocket 全双工通讯,im.message.send → ACK + 推送
|
||
- **三态确认**:sending → sent/ACK → failed
|
||
- **消息撤回**:2 分钟内可撤回,推送 im.message.recalled
|
||
- **正在输入**:im.typing 事件,3 秒超时自动清除
|
||
- **离线消息**:WebSocket 重连后服务端主动推送未读会话摘要
|
||
|
||
### 会话管理
|
||
- **自动创建**:首次发消息时自动创建单聊会话
|
||
- **会话列表**:置顶优先 → 最后消息时间降序,LEFT JOIN 一次获取 peerID(N+1 优化)
|
||
- **会话操作**:置顶/取消、软删除(不影响对方)、清空聊天记录(个人视图 ClearBeforeMsgID)
|
||
- **未读管理**:DB unread_count + Redis STRING 全局未读数(Lua 脚本负数保护),TabBar badge 显示
|
||
|
||
### WebSocket 事件路由表
|
||
- **Hub.RegisterEvent**:业务模块注册事件处理器
|
||
- **Hub.DispatchEvent**:消息分发到匹配的处理器
|
||
- **事件清单**:im.message.send / im.message.recall / im.conversation.read / im.typing
|
||
|
||
### REST API(7 个)
|
||
| 方法 | 路径 | 描述 |
|
||
|------|------|------|
|
||
| GET | /api/v1/im/conversations | 会话列表 |
|
||
| GET | /api/v1/im/messages | 历史消息(游标分页) |
|
||
| PUT | /api/v1/im/conversations/:id/pin | 置顶/取消 |
|
||
| DELETE | /api/v1/im/conversations/:id | 删除会话 |
|
||
| DELETE | /api/v1/im/conversations/:id/messages | 清空记录 |
|
||
| GET | /api/v1/im/messages/search | 全局搜索 |
|
||
| GET | /api/v1/im/unread | 全局未读数 |
|
||
|
||
### 前端页面(4 个)
|
||
- `pages/chat/index.vue` — 会话列表(TabBar 页面)
|
||
- `pages/chat/conversation.vue` — 聊天对话页
|
||
- `pages/chat/settings.vue` — 聊天设置页
|
||
- `pages/chat/search.vue` — 消息搜索页
|
||
|
||
### 数据库表(3 张)
|
||
- `im_conversations` — 会话表(含冗余 last_msg_* 字段)
|
||
- `im_conversation_members` — 会话成员表(个人视图:置顶/未读/软删除)
|
||
- `im_messages` — 消息表(游标分页索引 + GIN 全文搜索索引)
|
||
|
||
---
|
||
|
||
## 三、Phase 2a 完成总结
|
||
|
||
| Task | 描述 | 状态 | 备注 |
|
||
|------|------|------|------|
|
||
| Task 0-12 | WebSocket + 联系人 + 管理端 | ✅ 全部完成 | 13 个 Task + 8 项 Bug 修复 |
|
||
|
||
- WebSocket 实时通讯(Hub + Client + PubSub)
|
||
- 联系人管理 17 个 API
|
||
- 在线状态管理(Redis SET + TTL)
|
||
- 管理端扩展(在线监控 + 好友管理)
|
||
|
||
---
|
||
|
||
## 四、Phase 1 完成总结
|
||
|
||
| Task | 描述 | 状态 |
|
||
|------|------|------|
|
||
| Task 1-11 | 基础设施 + 认证 + 用户管理 | ✅ 全部完成 |
|
||
|
||
- Go 后端 15+ API、JWT 有状态认证、RBAC 角色权限
|
||
- 前台 uni-app 登录/注册/TabBar/个人中心
|
||
- 管理端 Vue 3 登录/仪表盘/用户列表/详情
|
||
- Docker Compose 一键启动
|
||
|
||
---
|
||
|
||
## 五、关键技术决策记录
|
||
|
||
### 后端(Go)
|
||
1. **框架组合**:Gin + GORM + Wire + Zap + Viper
|
||
2. **JWT 策略**:有状态 JWT,Token 按 clientType 隔离存储在 Redis
|
||
3. **WebSocket**:`gorilla/websocket` + Redis Pub/Sub 跨实例路由
|
||
4. **WS 事件路由**:Hub.eventHandlers map[string]EventHandler + RegisterEvent/DispatchEvent
|
||
5. **IM 跨模块**:FriendChecker + UserInfoGetter 接口注入(contact → im)
|
||
6. **IM 推送**:OfflineMessagePusher 接口注入(im → ws)
|
||
7. **在线状态**:混合方案(Redis SET + STRING TTL + Pub/Sub 推送)
|
||
8. **角色等级**:`auth_roles.level`(1=超管, 10=管理员, 100=普通用户)
|
||
|
||
### 前台用户端(frontend/)
|
||
1. **框架**:uni-app 3.0(Vue 3.4.21)
|
||
2. **状态管理**:Pinia 2.1.7 + pinia-plugin-persistedstate@3
|
||
3. **WebSocket**:`uni.connectSocket`(小程序)/ `WebSocket`(H5)
|
||
4. **IM Store**:chat.js(会话列表 + 消息缓存 + 三态确认 + 全局未读)
|
||
5. **设计系统**:ui-ux-pro-max 规范,MASTER.md + 页面覆盖规范
|
||
6. **图标方案**:@dcloudio/uni-ui uni-icons(easycom 自动引入,跨平台兼容)
|
||
7. **预处理器**:sass(uni-icons SCSS 依赖)
|
||
|
||
### 后台管理端(admin/)
|
||
1. **框架**:Vue 3.5+ + Vite 7.x + Element Plus
|
||
2. **HTTP 客户端**:Axios
|
||
3. **存储隔离**:localStorage key 前缀 `admin_`
|
||
|
||
---
|
||
|
||
## 六、目录结构概览
|
||
|
||
```
|
||
EchoChat/
|
||
├── backend/go-service/
|
||
│ ├── app/
|
||
│ │ ├── admin/ # 管理端
|
||
│ │ ├── auth/ # 认证模块
|
||
│ │ ├── contact/ # [Phase 2a] 联系人模块
|
||
│ │ ├── im/ # [Phase 2b] 即时通讯模块
|
||
│ │ │ ├── controller/ # REST API 控制器
|
||
│ │ │ ├── dao/ # 数据访问(ConversationDAO + MessageDAO)
|
||
│ │ │ ├── handler/ # WS 事件处理器 + 离线推送
|
||
│ │ │ ├── model/ # 数据库模型
|
||
│ │ │ ├── service/ # 核心业务 + 接口定义
|
||
│ │ │ ├── router.go
|
||
│ │ │ └── provider.go
|
||
│ │ ├── ws/ # [Phase 2a] WebSocket 模块
|
||
│ │ ├── constants/ # 含 im.go 常量
|
||
│ │ ├── dto/ # 含 im_dto.go
|
||
│ │ └── provider/
|
||
│ ├── pkg/
|
||
│ │ ├── ws/ # WS 核心(Hub 含事件路由表)
|
||
│ │ ├── db/ logs/ middleware/ utils/
|
||
│ └── router/router.go
|
||
├── frontend/ # 前台(uni-app)
|
||
│ └── src/
|
||
│ ├── api/{auth,contact,user,im,group,file}.js
|
||
│ ├── constants/group.js # [Phase 2c] 群聊角色/状态常量
|
||
│ ├── services/websocket.js
|
||
│ ├── store/{user,websocket,contact,chat,group}.js
|
||
│ ├── pages/chat/ # [Phase 2b] 5 个页面
|
||
│ │ ├── index.vue # 会话列表(含群聊 Tab)
|
||
│ │ ├── conversation.vue # 单聊对话
|
||
│ │ ├── read-detail.vue # [Phase 2c] 已读详情
|
||
│ │ ├── settings.vue # 聊天设置
|
||
│ │ └── search.vue # 消息搜索
|
||
│ ├── pages/group/ # [Phase 2c] 7 个页面
|
||
│ │ ├── conversation.vue # 群聊对话(含 @选择器 + 已读计数 + 禁言提示)
|
||
│ │ ├── create.vue # 创建群聊
|
||
│ │ ├── settings.vue # 群设置
|
||
│ │ ├── members.vue # 成员管理
|
||
│ │ ├── invite.vue # 邀请入群
|
||
│ │ ├── join-requests.vue # 入群审批
|
||
│ │ └── search.vue # 搜索群聊
|
||
│ ├── pages/contact/ # [Phase 2a] 6 个页面
|
||
│ └── components/CustomTabBar.vue(含 badge)
|
||
├── admin/ # 管理端(Vue 3 + Element Plus)
|
||
├── deploy/
|
||
├── design-system/
|
||
└── docs/
|
||
├── api/
|
||
├── plans/
|
||
├── progress/CURRENT_STATUS.md
|
||
└── conventions/
|
||
```
|
||
|
||
---
|
||
|
||
## 七、开发测试指南
|
||
|
||
### 启动命令
|
||
|
||
```bash
|
||
# 1. 启动 PostgreSQL + Redis
|
||
cd deploy && docker compose -f docker-compose.dev.yml up -d postgres redis
|
||
|
||
# 2. 启动 Go 后端(http://localhost:8085)
|
||
cd backend/go-service && go run cmd/server/main.go
|
||
|
||
# 3. 启动管理端(http://localhost:3100)
|
||
cd admin && npm run dev
|
||
|
||
# 4. 启动前台 H5(http://localhost:5173+)
|
||
cd frontend && npm run dev:h5
|
||
```
|
||
|
||
### 测试账号
|
||
|
||
| 账号 | 密码 | 角色 | 用途 |
|
||
|------|------|------|------|
|
||
| `super_admin` | `admin123456` | super_admin | 系统预置唯一超管 |
|
||
| `admin_test` | `admin123456` | user + admin | 管理端登录推荐 |
|
||
| `testuser1` | `test123456` | user + admin | 前台登录测试 |
|
||
| `testuser` | `test123456` | user | 前台登录测试 |
|
||
|
||
### Phase 2b 可测试功能
|
||
|
||
- **会话列表**:发消息自动创建会话 → 列表排序 → 置顶 → 长按删除
|
||
- **聊天**:发送文本 → 三态确认 → 撤回(2分钟内)→ 正在输入提示
|
||
- **离线消息**:断开重连 → 自动推送未读摘要 → TabBar badge 更新
|
||
- **消息搜索**:全局关键词搜索 → 跳转到对应会话
|
||
- **联系人入口**:好友详情页 → 发消息 → 跳转聊天页
|
||
|
||
---
|
||
|
||
## 八、Phase 2c — 群聊与已读回执
|
||
|
||
> **状态:** 实施中
|
||
> **设计文档:** `docs/plans/2026-03-04-phase2c-design.md`
|
||
> **实施计划:** `docs/plans/2026-03-04-phase2c-implementation.plan.md`
|
||
> **分支:** `feature/phase2c-group-read-receipt`
|
||
|
||
### 功能范围
|
||
|
||
| 模块 | 内容 |
|
||
|------|------|
|
||
| 群聊管理 | 建群/加入/退出/解散/搜索/三级角色/禁言/全体禁言/群公告/群昵称/免打扰 |
|
||
| 群消息 | 复用 im.message.* 事件 + @某人/@所有人 + 管理员撤回(无时限)+ 系统消息 |
|
||
| 已读回执 | 单聊会话级(last_read_msg_id)+ 群聊消息级(im_message_reads 表)+ 实时推送 |
|
||
| MinIO | Docker 容器 + Go SDK + 通用上传 API(群头像) |
|
||
| 管理端 | 群列表/群详情/解散群 |
|
||
| 前端 | 9 个新页面 + 群聊 Store + 会话列表 Tab 改造 |
|
||
|
||
### Task 完成状态
|
||
|
||
| Task | 描述 | 状态 |
|
||
|------|------|------|
|
||
| Task 0 | MinIO Docker + SDK + 通用上传 API | ✅ 完成 |
|
||
| Task 1 | 数据库迁移 + Model + 常量 | ✅ 完成 |
|
||
| Task 2 | Group DAO 层 | ✅ 完成 |
|
||
| Task 3 | Group Service 业务逻辑 + WS 推送 | ✅ 完成 |
|
||
| Task 4 | Group Controller + Router + Wire | ✅ 完成 |
|
||
| Task 5 | IM Service 扩展(群消息/@提醒/管理员撤回) | ✅ 完成 |
|
||
| Task 6 | 已读回执后端(单聊 + 群聊) | ✅ 完成 |
|
||
| Task 7 | 代码审查修复(Critical 4 项 + Important 4 项) | ✅ 完成 |
|
||
| Task 8 | 前端已读回执 UI(单聊标记 + 群聊计数 + 详情页) | ✅ 完成 |
|
||
| Task 9 | 前端群聊 Store + API 封装 + WS 事件监听 | ✅ 完成 |
|
||
| Task 10 | 群聊核心页面(Tab 切换 + 群聊对话页 + 创建群聊页) | ✅ 完成 |
|
||
| Task 11 | 群聊管理页面(群设置 + 成员管理 + 邀请入群) | ✅ 完成 |
|
||
| Task 12 | 群聊辅助功能(入群审批 + 搜索群聊) | ✅ 完成 |
|
||
| Task 13 | 管理端群组管理 + 文档更新 | ✅ 完成 |
|
||
| 代码审查修复 | 14 项修复(Critical×5 + Important×4 + Minor×2 + Suggestion×3) | ✅ 完成 |
|
||
|
||
### 代码审查修复详情(Phase 2c)
|
||
|
||
| # | 优先级 | 修复内容 |
|
||
|---|--------|----------|
|
||
| Fix C1 | Critical | conversation.vue 角色类型不匹配:字符串改为 GROUP_ROLE 数字常量 |
|
||
| Fix C2 | Critical | settings.vue 群公告字段名 announcement 改为 notice(对齐后端 DTO) |
|
||
| Fix C3 | Critical | chat.js sendMessage 未传递 at_user_ids 到 WS payload |
|
||
| Fix C4 | Critical | create.vue 创建成功后导航错误:改为 /pages/group/conversation + 正确参数 |
|
||
| Fix C5 | Critical | admin/provider.go Wire Set 未注册 GroupManageService/Controller |
|
||
| Fix I1 | Important | store/group.js searchGroups 添加 append 参数解决分页加载竞态 |
|
||
| Fix I2 | Important | settings.vue 改为 fetchMembers() 刷新数据,不直接修改 computed 引用 |
|
||
| Fix I3 | Important | 新增 constants/group.js 前端角色常量定义,消除魔数 |
|
||
| Fix I4 | Important | group_manage_service.go 列表查询 N+1 优化:批量查询用户名和成员数 |
|
||
| Fix M1 | Minor | file.js JSON.parse 添加 try/catch 异常保护 |
|
||
| Fix M2 | Minor | conversation.vue isSelf 移除冗余临时状态条件 |
|
||
| Fix S1 | Suggestion | 群聊对话页新增禁言状态检测和输入栏禁用提示 |
|
||
| Fix S2 | Suggestion | join-requests.vue 注册 WS group.join.request 事件实时刷新 |
|
||
| Fix S3 | Suggestion | read-detail.vue 获取失败时添加 uni.showToast 用户提示 |
|
||
|
||
### Phase 2c 新增内容
|
||
|
||
#### 后端新增模块
|
||
- **file/** — 文件上传(MinIO SDK + 通用上传 API)
|
||
- **group/** — 群聊管理(Controller + Service + DAO + Model + Router)
|
||
- 18 个群管理 REST API + 11 个 WS 群事件推送
|
||
- **im/ 扩展** — 群消息发送/撤回 + @提醒 + 单聊/群聊已读回执
|
||
- **admin/ 扩展** — 群组列表 + 群组详情 + 解散群聊
|
||
|
||
#### 前端新增页面(9 个)
|
||
| 页面 | 路径 | 功能 |
|
||
|------|------|------|
|
||
| 群聊对话页 | `pages/group/conversation.vue` | 群消息收发 + @选择器 + 已读计数 |
|
||
| 创建群聊页 | `pages/group/create.vue` | 好友多选 + 群名称输入 |
|
||
| 群设置页 | `pages/group/settings.vue` | 群信息修改 + 成员概览 + 退出/解散 |
|
||
| 群成员页 | `pages/group/members.vue` | 成员列表 + 角色管理 + 禁言操作 |
|
||
| 邀请入群页 | `pages/group/invite.vue` | 好友多选 + 排除已在群内成员 |
|
||
| 入群审批页 | `pages/group/join-requests.vue` | 申请列表 + 通过/拒绝操作 |
|
||
| 搜索群聊页 | `pages/group/search.vue` | 关键词搜索 + 申请加入 |
|
||
| 已读详情页 | `pages/chat/read-detail.vue` | 已读/未读成员列表(群聊消息级) |
|
||
| 会话列表改造 | `pages/chat/index.vue` | Tab 切换(全部/单聊/群聊)+ @标记 + 免打扰标识 |
|
||
|
||
#### 管理端新增
|
||
| 页面 | 路径 | 功能 |
|
||
|------|------|------|
|
||
| 群组列表 | `views/group/list.vue` | 搜索 + 分页 + 详情弹窗 + 解散群聊 |
|
||
|
||
#### 数据库新增/变更
|
||
- `im_groups` — 群信息表(新增)
|
||
- `im_group_join_requests` — 入群申请表(新增)
|
||
- `im_message_reads` — 群消息已读表(新增)
|
||
- `im_conversation_members` — 扩展字段(role, nickname, is_muted, is_do_not_disturb, joined_at, at_me_count)
|
||
- `im_messages` — 扩展字段(at_user_ids BIGINT[])
|
||
|
||
### 留待后续阶段
|
||
|
||
- 消息类型扩展(图片/语音/文件)
|
||
- 管理端消息管理功能
|
||
- 群头像上传 UI 完善
|