feat: 完成老项目文档化工作
- 新增 openspec-propose 技能，支持快速提案生成变更及相关文档。 - 新增接口汇总文档，整理后端接口及其用途。 - 新增页面功能说明文档，描述各页面的功能及路由。 - 新增项目总览文档，概述项目结构、技术栈及运行方式。 - 新增工具与非标准实现说明文档，记录项目中的特殊实现及约定。 - 创建 legacy-project-documentation 变更，整合现有文档并迁移至正式 OpenSpec 目录。 - 记录项目中的高风险历史实现特征，明确页面启用状态及接口调用关系。
This commit is contained in:
172
docs/page-functions.md
Normal file
172
docs/page-functions.md
Normal file
@@ -0,0 +1,172 @@
|
||||
# 页面功能说明
|
||||
|
||||
## 页面总表
|
||||
|
||||
| 页面 | 路由 | 是否在主菜单展示 | 功能摘要 | 主要接口 |
|
||||
| ------------ | ------------------ | ---------------- | --------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| 登录 | `/login` | 否 | 账号密码验证码登录，支持记住我和错误次数锁定 | 当前未接正式后端登录接口 |
|
||||
| 主页 | `/home` | 否 | 中转页，进入后自动跳到 UDP 监控 | 无 |
|
||||
| UDP 监控 | `/udplog` | 是 | 查看 UDP 汇总指标、时间筛选、酒店筛选、导出、配置下发、主机详情 | `UDPPackage/*`、`LowerMachineLog/*`、`BlockIP/*`、`iis/Recly` |
|
||||
| 线程耗时记录 | `/tasktimelog` | 是 | 查询线程步骤耗时、分页、导出 | `UDPPackage/GetUDPPackageTimeAnalysis` |
|
||||
| 黑名单管理 | `/blacklist` | 是 | 酒店维度黑名单查看、过滤、取消过滤、按酒店查主机 | `BlockIP/*`、`LowerMachineLog/*` |
|
||||
| TFTP 管理 | `/tftpwhitelist` | 是 | 酒店和房间维度 TFTP 上传设置、白名单管理 | `values/*`、`LowerMachineLog/*` |
|
||||
| 语音助手日志 | `/voicelog` | 是 | 语音请求链路日志、异常筛选、懒加载 | `UDPPackage/Get_IOTLog*`、`LowerMachineLog/*` |
|
||||
| 房态日志 | `/statuslog` | 是 | 房态/取电/离在线统计、房间时序详情、历史状态查询 | `UDPPackage/Get_*Status`、`LowerMachineLog/*` |
|
||||
| 功率记录 | `/powerlog` | 否 | 查询酒店功率分析数据 | `Power/GetPowerAnalysis`、`LowerMachineLog/*` |
|
||||
| 字典管理 | 已注释 | 否 | 维护配置字典与区域字典 | `ConfigPY/GetConfigString`、`ConfigPY/SaveOrAddConfigString` |
|
||||
| 个人设置 | 未接路由 | 否 | 查看并修改当前用户资料，带头像上传 | `Company/*`、`Users/*`、`FileUpload/UploadFile` |
|
||||
| 404 | `/:pathMatch(.*)*` | 否 | 未匹配路由兜底页 | 无 |
|
||||
|
||||
## 登录页
|
||||
|
||||
文件：`src/pages/login/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 账号、密码、验证码三段式表单。
|
||||
- 支持“记住我”，将用户名和密码写入本地存储。
|
||||
- 连续输错达到阈值后锁定，锁定结束时间也写入本地存储。
|
||||
|
||||
关键注意事项：
|
||||
|
||||
- 当前登录是前端硬编码账号密码校验。
|
||||
- 注释里保留了旧的后端登录接口 `LeiDa/Login`，但未启用。
|
||||
- 登录成功后通过 `localStorage.login` 与 `localStorage.TokenT` 控制会话。
|
||||
|
||||
## UDP 监控页
|
||||
|
||||
文件：`src/pages/udplog/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 支持“今天 / 3 天内 / 更多”时间筛选。
|
||||
- 支持普通模式与全屏模式切换。
|
||||
- 支持按酒店查看聚合数据，也支持查看某酒店主机详情。
|
||||
- 支持导出 UDP 统计结果。
|
||||
- 支持获取和下发监控配置参数。
|
||||
- 包含对 RCU 侧 `iis/Recly` 的调用入口。
|
||||
|
||||
接口特征：
|
||||
|
||||
- 统计与导出走 `UDPPackage`。
|
||||
- 酒店和主机信息来自 `LowerMachineLog`。
|
||||
- 参数配置和房间计数来自 `BlockIP`。
|
||||
|
||||
## 线程耗时记录页
|
||||
|
||||
文件：`src/pages/tasktimelog/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 根据起止时间查询 UDP 包各处理步骤耗时。
|
||||
- 表格列根据步骤动态展开。
|
||||
- 支持分页、快捷时间按钮、导出 Excel。
|
||||
|
||||
维护价值：
|
||||
|
||||
- 适合排查某条命令链路在哪一步耗时异常。
|
||||
- Popover 中能看到步骤描述、触发时间、部分消息内容。
|
||||
|
||||
## 黑名单管理页
|
||||
|
||||
文件：`src/pages/blacklist/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 查看所有酒店是否已进入过滤名单。
|
||||
- 可按酒店名称或编号搜索。
|
||||
- 支持“只显示过滤名单”。
|
||||
- 支持整酒店加入或移出黑名单。
|
||||
|
||||
接口特征：
|
||||
|
||||
- 黑名单增删改查全部走 `BlockIP`。
|
||||
- 酒店列表与主机列表走 `LowerMachineLog`。
|
||||
|
||||
## TFTP 管理页
|
||||
|
||||
文件：`src/pages/tftpwhitelist/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 查看酒店维度 TFTP 上传白名单。
|
||||
- 支持整酒店上传和单房间上传。
|
||||
- 支持打开房间列表查看设备版本、机型、MAC。
|
||||
- 支持配置端口、域名、上传时长等 TFTP 设置。
|
||||
|
||||
接口特征：
|
||||
|
||||
- 白名单和房间数据来自 `LowerMachineLog`。
|
||||
- RCU 侧配置由 `values/GetTFTPInfo` 与 `values/TFTPSet_Execute` 完成。
|
||||
|
||||
## 语音助手日志页
|
||||
|
||||
文件：`src/pages/voicelog/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 按酒店、房间和时间区间查询语音请求日志。
|
||||
- 日志按 `requestId` 折叠分组展示。
|
||||
- 支持异常过滤和“加载全部”开关。
|
||||
- 做了懒加载和时间片拉取，适合大数据量场景。
|
||||
|
||||
接口特征：
|
||||
|
||||
- 主日志来自 `UDPPackage/Get_IOTLog` 与 `UDPPackage/Get_IOTLogCount`。
|
||||
- 酒店、房间、房间总数来自 `LowerMachineLog` 和 `BlockIP/GetRoomCount`。
|
||||
|
||||
## 房态日志页
|
||||
|
||||
文件：`src/pages/statuslog/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 可以按酒店、房间、多酒店、时间区间查询房态。
|
||||
- 汇总表展示当前在线状态、离线次数、当前取电状态、取断电次数。
|
||||
- 点击房间可进入时序详情弹窗，查看在线/离线与取电/断电时间轴。
|
||||
- 支持查询某个历史时刻的在线状态和取电状态。
|
||||
|
||||
接口特征：
|
||||
|
||||
- 核心状态查询走 `UDPPackage/Get_RCUStatus`、`Get_TakeCardStatus`、`Get_BeforeTakeCardStatus`。
|
||||
- 酒店、房间基础数据走 `LowerMachineLog`。
|
||||
|
||||
## 功率记录页
|
||||
|
||||
文件：`src/pages/powerlog/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 当前实现较轻，核心是选择酒店并请求功率分析数据。
|
||||
- 页面代码更像实验或预研状态，尚未形成完整运营页面。
|
||||
|
||||
接口特征：
|
||||
|
||||
- 主数据接口是 `Power/GetPowerAnalysis`。
|
||||
- 酒店列表和房间总数仍来自 `LowerMachineLog` 与 `BlockIP/GetRoomCount`。
|
||||
|
||||
## 字典管理页
|
||||
|
||||
文件：`src/pages/dicmanage/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 展示并编辑通用字典值。
|
||||
- 对“区域”字典提供省份选择弹窗和结构化编辑能力。
|
||||
- 适合后台配置维护，但当前路由被注释，默认不可达。
|
||||
|
||||
## 个人设置页
|
||||
|
||||
文件：`src/pages/logsetup/index.vue`
|
||||
|
||||
主要内容：
|
||||
|
||||
- 展示登录用户信息。
|
||||
- 支持编辑真实姓名、手机号、邮箱、微信号。
|
||||
- 预留头像上传能力。
|
||||
|
||||
关键注意事项：
|
||||
|
||||
- 页面未接入当前路由。
|
||||
- 头像上传代码存在明显不完整逻辑，`filedata` 变量在启用分支中未定义。
|
||||
- 当前更像未完全收尾的个人中心页。
|
||||
Reference in New Issue
Block a user