Simon
caf9b7ed85
解决改代码 30-60min 才能看到结果的痛点。本地拉起完整 stack, 改代码 → 1-2min 看到结果,无需服务器。 ## 交付物 ### Docker stack (docker-compose.dev.yml) - postgres:16-alpine 端口 5432 - redis:7-alpine 端口 6379 - backend 端口 8000,代码 volume mount + uvicorn --reload ### Dev 镜像 (backend/Dockerfile.dev) - 单阶段(无需 gcc / libpq-dev) - apt 源换阿里云(公司内网) - 装 pytest pytest-asyncio httpx watchfiles - CMD: uvicorn --reload ### 配置 (.env.dev, 强制 add 因 .env.* 在 .gitignore) 内容是 dev 占位符,无任何真实密钥: - DEV_MODE=true (启用 Mock OAuth) - WECOM_* 全部 dev_xxx 占位 - 集成系统 API 全 dev_ 占位(调用会失败但不影响主流程) ### Mock OAuth (backend/app/api/dev_auth.py) - GET /api/dev/login?userid=xxx&name=xxx&role=xxx 走完全真实的 TokenService.create_token(不绕过业务逻辑) - GET /api/dev/users 列出 6 个预设 dev 用户 - GET /api/dev/health dev 模式状态自检 - 6 预设用户覆盖所有角色(user/agent/supervisor/security/admin/多角色) - 每个端点 _dev_mode_enabled() 二次校验,生产环境访问 403 ### 集成改动 - backend/app/main.py: 加 _is_dev_mode() + DEV_MODE=true 时条件挂载 dev_auth 路由 + 启动时大声警告 - backend/app/config.py: Settings 加 dev_mode / dev_default_userid / dev_default_name / dev_default_dept 字段 ### PowerShell 脚本 - scripts/dev-start.ps1: 5 步验证(检查 Docker / .env / compose / 健康 / dev health),首次 2-5min build,后续秒起 - scripts/dev-stop.ps1: 停止,支持 -v 清数据卷 - scripts/dev-test.ps1: 一键跑 pytest(可选 -Frontend 跑 vitest) ## 阶段 - ✅ Phase 0 基础(本 commit) - ⏳ Phase 1 pytest(任务 #90) - 500 bug 回归测试已就绪 - ⏳ Phase 2 vitest - ⏳ Phase 3 playwright E2E ## 安全保证 - DEV_MODE 三个地方都校验(环境变量/settings/端点内) - 生产环境 /api/dev/* 端点根本不存在(未挂载) - .env.dev 是 dev 占位符,无敏感,可入 git
企微智能IT支持服务台 (IT Smart Desk)
环境状态: 预生产（独立主机，共享域名）→ 正式环境迁移 K8s
维护者: 税友集团 IT支持组（宋献）
最后更新: 2026-06-03
📖 阅读指南（按对象）
| 阅读对象 | 推荐文档 | 内容 |
|---|---|---|
| 新人/产品经理 | 本文档 + docs/ARCHITECTURE.md 前半部分 | 项目背景、功能清单、如何使用 |
| 开发人员 | docs/ARCHITECTURE.md + backend/app/ 代码 | 架构设计、API 接口、数据模型、开发规范 |
| 运维/部署人员 | 本文档「部署」章节 + scripts/deploy.sh | Docker 编排、Nginx 配置、环境变量 |
| 测试人员 | docs/ARCHITECTURE.md 「任务清单」 | 功能模块划分、待完善项 |
🎯 项目背景
税友集团内部 IT 支持渠道分散（企微群、电话、走访），缺乏统一 SLA 追踪。本项目构建一个 AI + 人工坐席协作 的智能服务台：
- 员工端（H5）：企微 OAuth2 免登，AI 自动回复 + 人工兜底，支持「敲桌子」趣味呼叫
- 坐席端（Web）：三栏工作台，会话分配/抢单/协作/转接，实时 WebSocket 推送
- AI 层：接入 RAGFLOW/Dify 知识库，自动回复常见 IT 问题
核心指标：AI 自助解决率 55%（实际 1-5月已达 70.2%）
✅ 当前实现进度
后端（FastAPI + PostgreSQL + Redis）
- 企微回调加解密（AES-CBC-256）
- 消息路由（VIP 识别、紧急度评分 1-5、标记检测）
- WebSocket 实时推送（心跳、重连、定向广播）
- 会话全生命周期（创建→分配→处理→结单→转接）
- 坐席管理（登录、状态切换、在线列表）
- H5 端 OAuth2 认证、审批链接、软件下载
- 应急模式（系统故障时手动开启）
- Alembic 数据库迁移（初始表结构）
- AI 回复集成（需接入 Dify，目前新会话直接进入队列）
- 自动化测试（pytest）
坐席前端（Vue 3 + Element Plus）
- 登录页（用户ID + 姓名，无密码）
- 三栏工作台（会话列表 + 对话区 + AI 助手面板）
- 6 分区会话列表（待接单/我的/协作/其他坐席/AI处理/已结单）
- 协作功能（摇人邀请、接受/拒绝）
- WebSocket + 轮询双模式（自动降级）
- 操作步骤、风险提示、用户信息面板（需确认后端数据）
员工前端（Vue 3 + Vant）
- OAuth2 静默授权登录
- 聊天界面（员工/坐席/AI/系统 4 种消息气泡）
- 「敲桌子」呼叫坐席（7 种 SVG 动画）
- AI 助手面板、审批流程链接、软件下载
- AI 回复展示（依赖后端 AI 集成）
部署
- Docker Compose 4 容器编排（nginx + backend + postgres + redis）
- Nginx 反向代理（与数据平台共享域名，独立主机部署）
- 部署脚本（build.sh + deploy.sh）
- HTTPS 启用（nginx.conf 已预留模板）
- 预生产环境验证（独立主机，路径路由到数据平台远程主机）
🚀 快速启动
前置条件
- Docker Desktop / Docker Compose
- 企微企业应用（需配置 Token、EncodingAESKey、CorpID）
- 公钥上传至服务器（部署用）
本地开发
# 1. 复制环境变量
cp .env.example .env
# 编辑 .env 填入企微凭据和数据库密码
# 2. 启动数据库（仅 PostgreSQL）
docker compose up -d postgres redis
# 3. 后端开发模式
cd backend
python -m venv venv && venv\Scripts\activate
pip install -r requirements.txt
uvicorn app.main:app --reload
# 4. 前端开发模式（另开终端）
cd frontend-agent
npm install && npm run dev
预生产部署
注意：预生产环境中，智能咨询系统与数据平台在不同主机上。部署前需将
nginx/nginx.conf中DATAQUERY_HOST替换为数据平台实际 IP。
# 1. 修改 nginx 反代地址
# 编辑 nginx/nginx.conf，将 DATAQUERY_HOST 改为数据平台主机 IP
# 2. 使用部署脚本
bash scripts/deploy.sh deploy
# 3. 或手动
docker compose up -d --build
正式环境将迁移到 K8s 集群，届时部署方式另行调整。
📂 项目结构
wecom_it_smart_desk/
├── backend/ # FastAPI 后端
│ ├── app/
│ │ ├── api/ # 8 个路由模块
│ │ ├── models/ # 9 个数据模型
│ │ ├── services/ # 核心服务（消息路由、会话管理、企微API）
│ │ ├── schemas/ # Pydantic 请求/响应 Schema
│ │ └── utils/ # 加解密、Token管理、WebSocket
│ └── alembic/ # 数据库迁移
├── frontend-agent/ # 坐席工作台（Vue 3 + Element Plus）
├── frontend-h5/ # 员工端（Vue 3 + Vant）
├── nginx/ # Nginx 反向代理配置
├── scripts/ # 构建和部署脚本
├── docs/ # 项目文档（架构/PRD/测试报告等）
└── docker-compose.yml # 容器编排
🔧 核心配置项（.env）
| 变量 | 说明 | 示例 |
|---|---|---|
WECOM_CORPID |
企微企业ID | ww... |
WECOM_AGENT_TOKEN |
企微应用 Token | your_token |
WECOM_AGENT_ENCODING_AES_KEY |
企微消息加解密密钥 | 32位Base64 |
DATABASE_URL |
数据库连接串 | postgresql+asyncpg://... |
REDIS_URL |
Redis 连接串 | redis://... |
BACKEND_PORT |
后端端口（容器内需 8000） | 8000 |
📊 API 端点概览
| 模块 | 端点前缀 | 核心功能 |
|---|---|---|
| 坐席管理 | /api/v1/agents |
登录、状态切换、在线列表 |
| 会话管理 | /api/v1/conversations |
列表、详情、分配、结单、转接 |
| 消息管理 | /api/v1/messages |
消息列表、发送、轮询 |
| 企微回调 | /api/v1/wecom |
GET 验证、POST 接收消息 |
| H5 员工端 | /api/v1/h5 |
OAuth2、消息、举手、审批 |
| 快速回复 | /api/v1/quick-replies |
模板 CRUD |
| 系统 | /api/v1/system |
应急模式开关 |
详细请求/响应格式见
docs/ARCHITECTURE.md或运行后访问/docs（Swagger UI）
🐛 已知问题 / 待完善
- AI 回复未集成：目前新会话直接进入
queued状态，需接入 Dify 工作流 - 无自动化测试：后端 pytest、前端 Vitest 均未配置
- Alembic 迁移不完整：仅初始迁移，后续模型变更需手动管理
- HTTPS 未启用：nginx.conf 有模板但未配置证书
- VIP 缓存未实现：
message_router.py中 Redis 缓存被注释
📝 相关文档
- docs/ARCHITECTURE.md：完整架构设计、数据模型、调用流程、任务清单
- docs/现有系统交接文档内容.txt：现有 IT 客服机器人系统交接信息（RAGFLOW、Dify 部署环境）
- scripts/deploy.sh：部署脚本详细说明（5 种运行模式）
📞 联系
- 项目负责人：宋献 — 税友集团 IT支持组
- 企业微信：通过内部企微联系
- Issue 反馈：在项目目录创建任务文档或联系开发组
最后更新：2026-06-03 - 合并文档，反映当前实际完成进度
🏛️ 仓库与治理
- Gitea 仓库（公网 Funnel）:
https://ds923plus.tail58d872.ts.net/simon/wecom_it_smart_desk - Gitea 内网地址（LAN 加速）:
http://100.85.152.112:8418/simon/wecom_it_smart_desk - 贡献指南:
CONTRIBUTING.md— 分支模型 + Commit 规范 + PR 流程 - 评审报告:
docs/评审报告/— 历次 workbuddy 推送评审 - 风险跟踪表:
docs/风险跟踪表.md— 22 项审计追踪 - workbuddy 记忆:
.workbuddy/memory/— workbuddy 启动读这里接任务
评审与提交约定
- 🔴 所有 P0 鉴权修复必须走评审（
docs/评审报告/留档，含 workbuddy 推送） - 🟡 端点变更需
Depends(get_current_agent)或_get_current_employee鉴权依赖 - 🟡 数据库 schema 变化必须 alembic 迁移（无手动 ALTER）
- 🟢 workbuddy 推送前自检: 鉴权 + 依赖 + alembic + 配置 4 件套
- 🟢 任何部署包 / SSL 私钥 / 推送 token 不入仓（见
.gitignore）