0666c3ec7b
- 添加 backend/项目实施规范.md - 添加 backend/业务应用模块创建规则.md - 添加 backend/guides/deployment-guide.md - 添加 frontend/admin-ui-icon-guide.md - 添加 frontend/admin-ui-status.md - 更新 README.md 文档索引
207 lines
9.0 KiB
Markdown
207 lines
9.0 KiB
Markdown
# Admin-UI 功能状态跟踪文档
|
||
|
||
> 本文档用于记录 admin-ui 前端功能实现状态,避免每次重复分析。
|
||
> **规则**:每次修改 admin-ui 功能后,必须同步更新此文档。
|
||
|
||
---
|
||
|
||
## 一、项目概览
|
||
|
||
- **技术栈**: Vue 3 + Element Plus + Pinia + Vue Router + Axios
|
||
- **构建工具**: Vite + TypeScript + UnoCSS
|
||
- **布局类型**: 侧边栏 / 顶栏 / 混合 / 双栏(4种布局支持)
|
||
- **国际化**: 支持 zh-CN / en-US
|
||
|
||
---
|
||
|
||
## 二、功能模块清单
|
||
|
||
### 1. 系统框架功能
|
||
|
||
| 功能 | 状态 | 说明 |
|
||
|------|------|------|
|
||
| 登录页 | ✅ 完成 | 支持账号密码登录、记住密码 |
|
||
| 布局切换 | ✅ 完成 | 4种布局(侧边栏/顶栏/混合/双栏)|
|
||
| 主题配置 | ✅ 完成 | 暗黑/明亮模式、主题色、字号 |
|
||
| 多标签页 | ✅ 完成 | TagsBar 支持右键菜单(关闭/刷新/全屏/关闭其他/关闭所有)|
|
||
| 个人中心 | ✅ 完成 | 个人信息修改、密码修改 |
|
||
| 全屏功能 | ✅ 完成 | 支持页面全屏 |
|
||
| 国际化 | ✅ 完成 | 中文/英文切换 |
|
||
| 路由守卫 | ✅ 完成 | 未登录自动跳转、已登录禁止访问登录页 |
|
||
|
||
### 2. 用户管理模块
|
||
|
||
| 功能 | 页面 | 状态 | 说明 |
|
||
|------|------|------|------|
|
||
| 用户信息 | user/info/Index.vue | ✅ 完成 | 增删改查、批量删除、状态切换、导出、角色分配、详情查看 |
|
||
| 用户详情 | user/detail/Index.vue | ✅ 完成 | 增删改查、批量删除、导出 |
|
||
| 等级管理 | user/level/Index.vue | ✅ 完成 | 增删改查、批量删除、状态切换、导出 |
|
||
| 等级日志 | user/level-log/Index.vue | ✅ 完成 | 增删改查、批量删除、状态切换、导出 |
|
||
| 收货地址 | user/address/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
| 账户流水 | user/account/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
|
||
**缺失功能**:
|
||
- ❌ **用户管理页面缺少导入功能**(后端 `/user/admin/user/import` 已提供)
|
||
- ❌ **缺少用户详情管理页面**(后端 `/user/admin/detail/**` 已提供)
|
||
|
||
### 3. 系统管理模块
|
||
|
||
| 功能 | 页面 | 状态 | 说明 |
|
||
|------|------|------|------|
|
||
| 菜单管理 | system/menu/Index.vue | ✅ 完成 | 树形展示、图标选择、平台切换、修复图标 |
|
||
| 角色管理 | system/role/Index.vue | ✅ 完成 | 增删改查、菜单权限分配、状态切换、导出 |
|
||
| 部门管理 | system/dept/Index.vue | ✅ 完成 | 树形展示、增删改查、状态切换 |
|
||
| 字典管理 | system/dict/Index.vue | ✅ 完成 | 字典项管理、增删改查、状态切换、导出 |
|
||
| 参数配置 | system/config/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
| 操作日志 | system/log/Index.vue | ✅ 完成 | 查看详情、清空日志、删除、导出 |
|
||
| 登录日志 | system/login-log/Index.vue | ✅ 完成 | 清空日志、删除、导出 |
|
||
| 租户管理 | system/tenant/Index.vue | ✅ 完成 | 初始化租户、修改密码、模块编辑、增删改查、导出 |
|
||
| OAuth2客户端 | system/oauth2-client/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
|
||
**缺失功能**:
|
||
- ❌ **部门管理页面缺少导出功能**(后端 `/system/admin/dept/export` 已提供)
|
||
- ❌ **菜单管理页面缺少导出功能**(后端 `/system/admin/menu/export` 已提供)
|
||
|
||
### 4. 订单管理模块
|
||
|
||
| 功能 | 页面 | 状态 | 说明 |
|
||
|------|------|------|------|
|
||
| 订单列表 | order/list/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
| 退款记录 | order/refund/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
|
||
### 5. 内容管理模块 (CMS)
|
||
|
||
| 功能 | 页面 | 状态 | 说明 |
|
||
|------|------|------|------|
|
||
| 文章管理 | cms/article/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
| 分类管理 | cms/category/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
| 轮播图 | cms/banner/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
|
||
### 6. 营销中心模块
|
||
|
||
| 功能 | 页面 | 状态 | 说明 |
|
||
|------|------|------|------|
|
||
| 优惠券 | marketing/coupon/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
| 活动管理 | marketing/activity/Index.vue | ⚠️ 待检查 | 页面存在,需确认功能完整性 |
|
||
|
||
### 7. 演示模块
|
||
|
||
| 功能 | 页面 | 状态 | 说明 |
|
||
|------|------|------|------|
|
||
| 图标演示 | demo/Icons.vue | ✅ 完成 | Tabler 图标库展示 |
|
||
| 列表演示 | demo/list/Index.vue | ✅ 完成 | 标准 CRUD 示例 |
|
||
|
||
---
|
||
|
||
## 三、前后端 API 对照表
|
||
|
||
### 已对接的后端 API
|
||
|
||
| 后端 Controller | 前端 Service | 对接状态 |
|
||
|----------------|-------------|---------|
|
||
| UserController | userService.ts | ✅ 已对接(缺少 import) |
|
||
| UserDetailController | ❌ 无 | ❌ 未对接 |
|
||
| UserLevelController | levelService.ts | ✅ 已对接 |
|
||
| UserLevelLogController | levelLogService.ts | ✅ 已对接 |
|
||
| SysMenuController | menuService.ts | ✅ 已对接 |
|
||
| SysRoleController | roleService.ts | ✅ 已对接 |
|
||
| SysDeptController | deptService.ts | ✅ 已对接 |
|
||
| SysDictTypeController | dictService.ts | ✅ 已对接 |
|
||
| SysDictItemController | dictItemService.ts | ✅ 已对接 |
|
||
| SysConfigController | configService.ts | ✅ 已对接 |
|
||
| SysOperLogController | operLogService.ts | ✅ 已对接 |
|
||
| SysLoginLogController | loginLogService.ts | ✅ 已对接 |
|
||
| SysTenantController | tenantService.ts | ✅ 已对接 |
|
||
| SystemOAuth2ClientController | oauth2ClientService.ts | ✅ 已对接 |
|
||
|
||
### 后端有但前端未对接的 API
|
||
|
||
| 后端接口 | 说明 | 优先级 |
|
||
|---------|------|--------|
|
||
| `GET/POST /user/admin/user/import` | 用户导入 | 低 |
|
||
| `GET /system/admin/dept/export` | 部门导出 | 低 |
|
||
| `GET /system/admin/menu/export` | 菜单导出 | 低 |
|
||
| `POST /system/admin/menu/fix-icons` | 修复菜单图标 | 中(已在前端调用) |
|
||
| `POST /system/admin/tenant/{tenantId}/init` | 初始化租户 | 已对接 |
|
||
| `POST /system/admin/tenant/{tenantId}/admin/password` | 修改租户管理员密码 | 已对接 |
|
||
| `GET /user/admin/detail/**` | 用户详情管理 | **高**(完整页面缺失) |
|
||
|
||
---
|
||
|
||
## 四、待办事项 (TODO)
|
||
|
||
### 高优先级
|
||
- [x] **用户详情管理页面** - ✅ 已完成
|
||
|
||
### 中优先级
|
||
- [ ] **订单管理功能完善** - 检查订单列表和退款记录页面功能完整性
|
||
- [ ] **CMS 功能完善** - 检查文章、分类、轮播图页面功能完整性
|
||
- [ ] **营销中心功能完善** - 检查优惠券、活动管理页面功能完整性
|
||
- [ ] **用户地址、账户流水页面** - 确认功能是否完整
|
||
|
||
### 低优先级
|
||
- [ ] **导入导出功能补全** - 用户管理导入、部门管理导出、菜单管理导出
|
||
- [ ] **参数配置页面** - 确认功能完整性
|
||
- [ ] **OAuth2客户端页面** - 确认功能完整性
|
||
|
||
---
|
||
|
||
## 五、更新记录
|
||
|
||
| 日期 | 更新内容 | 更新人 |
|
||
|------|---------|--------|
|
||
| 2025-06-01 | 初始版本,完成系统框架、用户管理、系统管理模块的详细分析 | AI Assistant |
|
||
| 2025-06-01 | 新增用户详情管理页面(Index.vue + UserDetailFormDialog.vue),完善路由、国际化、Service 导出 | AI Assistant |
|
||
| 2025-06-01 | 菜单配置改为 config/menus/ 目录按模块拆分;增加模块管理功能(Nacos配置 + 后端API + 前端模块编辑) | AI Assistant |
|
||
|
||
---
|
||
|
||
## 六、使用说明
|
||
|
||
### 维护规范
|
||
|
||
1. **新增功能时**:在对应模块表格中添加一行,标记状态
|
||
2. **修改功能时**:更新对应行的状态和说明
|
||
3. **发现问题时**:添加到「待办事项」章节
|
||
4. **完成事项时**:将 TODO 项标记为完成,并记录到「更新记录」
|
||
|
||
### 提示词模板(复制即用)
|
||
|
||
#### 场景 1:查看 admin-ui 当前功能状态
|
||
```
|
||
请读取 docs/admin-ui-status.md 文档,告诉我 admin-ui 当前的功能完成情况和还有哪些待办事项。
|
||
```
|
||
|
||
#### 场景 2:基于文档开发新功能
|
||
```
|
||
请读取 docs/admin-ui-status.md 文档,根据「待办事项」中的高优先级任务,帮我实现【具体功能名称】。
|
||
实现完成后,记得同步更新 docs/admin-ui-status.md 文档中的状态。
|
||
```
|
||
|
||
#### 场景 3:检查某个模块是否完整
|
||
```
|
||
请读取 docs/admin-ui-status.md 文档,检查【模块名称】模块的功能是否完整,还有哪些缺失?
|
||
```
|
||
|
||
#### 场景 4:完成修改后更新文档
|
||
```
|
||
我已经完成了【修改内容】,请更新 docs/admin-ui-status.md 文档:
|
||
1. 将对应功能状态标记为完成
|
||
2. 如完成待办事项,将其标记为 [x]
|
||
3. 在「更新记录」中添加一行
|
||
```
|
||
|
||
#### 场景 5:对比前后端接口
|
||
```
|
||
请读取 docs/admin-ui-status.md 文档,检查「前后端 API 对照表」,告诉我还有哪些后端接口前端未对接。
|
||
```
|
||
|
||
#### 场景 6:新对话快速上手
|
||
```
|
||
请读取 docs/admin-ui-status.md 文档,快速了解 admin-ui 项目现状,无需分析整个项目。
|
||
```
|
||
|
||
---
|
||
|
||
> **提示**:本文档位于 `/docs/admin-ui-status.md`,请确保与代码同步更新。
|