docs: 新增和更新多个模块的文档
新增SPC模块、托盘登录、生产批次不良报表、设备监控、半成品管理、托盘管理、系统监控、批次管理、班组模型、电池工序管理、电池复投管理、批次托盘、系统助手、SPC采集模型、产品模型管理、物料模型管理、用户管理、菜单配置等文档内容 更新文档指南,添加系统功能清单
This commit is contained in:
219
system_settings/menu_configuration.md
Normal file
219
system_settings/menu_configuration.md
Normal file
@@ -0,0 +1,219 @@
|
||||
# 菜单管理
|
||||
|
||||
## 1. 功能概述
|
||||
|
||||
菜单管理模块用于配置系统的菜单结构,支持后台管理端和PDA端的菜单配置,实现菜单的增删改查、排序和权限关联功能。
|
||||
|
||||
**核心功能:**
|
||||
|
||||
- 菜单树形结构管理:支持多层级菜单的创建、编辑和删除
|
||||
- 菜单分类管理:区分后台(admin)和PDA模块的菜单
|
||||
- 菜单状态控制:支持菜单的启用/禁用操作
|
||||
- 菜单排序:支持拖拽排序,调整菜单显示顺序
|
||||
- 菜单权限关联:新增菜单自动关联超级管理员角色
|
||||
- 菜单导航属性:控制菜单是否在导航栏显示
|
||||
|
||||
## 2. 术语说明
|
||||
|
||||
#### 2.1.1 菜单相关术语
|
||||
|
||||
| 术语 | 定义 | 说明 |
|
||||
|------|------|------|
|
||||
| 顶层菜单 | 没有上级菜单的菜单节点 | 作为菜单树的根节点 |
|
||||
| 子菜单 | 有上级菜单的菜单节点 | 可多级嵌套 |
|
||||
| 模块 | 菜单所属的系统模块 | admin(后台)、pda(PDA端) |
|
||||
| 导航属性 | 菜单是否在导航栏显示 | 可见(1)或隐藏(0) |
|
||||
| 链接类型 | 菜单链接的类型 | 模块(0)或外链(1) |
|
||||
| 打开方式 | 链接的打开方式 | 当前窗口(_self)或新窗口(_blank) |
|
||||
|
||||
## 3. 菜单管理操作
|
||||
|
||||
### 3.1 菜单查询
|
||||
|
||||
**查询条件:**
|
||||
|
||||
| 查询条件 | 说明 |
|
||||
|---------|------|
|
||||
| 模块 | 选择后台(admin)或PDA模块 |
|
||||
| 状态 | 筛选启用或禁用状态的菜单 |
|
||||
| 导航属性 | 筛选可见或隐藏的菜单 |
|
||||
| 菜单深度 | 控制菜单树的展开层级 |
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 进入【系统设置】→【菜单管理】→【菜单配置】
|
||||
2. 在顶部查询区域选择查询条件
|
||||
3. 点击【查询】按钮获取菜单列表
|
||||
4. 点击【重置】按钮清空查询条件
|
||||
|
||||
### 3.2 新增菜单
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 进入【系统设置】→【菜单管理】→【菜单配置】
|
||||
2. 点击【新增顶层菜单】按钮,或在已有菜单上点击【新增】按钮添加子菜单
|
||||
3. 填写菜单表单信息
|
||||
4. 点击【确定】完成新增
|
||||
|
||||
**字段说明:**
|
||||
|
||||
| 字段 | 说明 | 必填 |
|
||||
|------|------|------|
|
||||
| 上级菜单 | 选择父菜单,不选择表示顶层菜单 | 否 |
|
||||
| 名称 | 菜单的显示名称 | 是 |
|
||||
| 别名 | 菜单的别名标识,API类型菜单必填 | 否 |
|
||||
| 图标 | 菜单图标,可选择或自定义 | 否 |
|
||||
| 排序 | 菜单的排序序号,数值越小越靠前 | 是 |
|
||||
| 导航 | 控制菜单是否在导航栏显示 | 是 |
|
||||
| 链接类型 | 模块(0)或外链(1) | 是 |
|
||||
| 打开方式 | 当前窗口或新窗口 | 是 |
|
||||
| URL | 菜单链接地址 | 否 |
|
||||
| 参数 | 链接参数 | 否 |
|
||||
| 备注 | 菜单的备注说明 | 否 |
|
||||
|
||||
**【提示】** 新增菜单时,系统会自动将其关联到超级管理员角色。
|
||||
|
||||
### 3.3 编辑菜单
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在菜单树中点击需要编辑的菜单节点
|
||||
2. 在右侧表单中修改菜单信息
|
||||
3. 点击【修改】按钮保存更改
|
||||
|
||||
**【注意】** 菜单名称在同一模块内不能重复。
|
||||
|
||||
### 3.4 删除菜单
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在菜单树中找到需要删除的菜单
|
||||
2. 点击菜单右侧的【删除】按钮
|
||||
3. 在确认对话框中点击【确定】
|
||||
|
||||
**【重要】** 如果该菜单或其子级菜单正在被角色使用,则无法删除。
|
||||
|
||||
### 3.5 启用/禁用菜单
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在菜单树中找到需要操作的菜单
|
||||
2. 点击菜单右侧的【禁用】或【启用】按钮
|
||||
3. 在确认对话框中点击【确定】
|
||||
|
||||
**【注意】** 状态切换会影响该菜单及其所有子级菜单。
|
||||
|
||||
### 3.6 菜单排序
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在菜单树中拖拽菜单节点到目标位置
|
||||
2. 系统自动保存排序结果
|
||||
|
||||
**支持的拖拽操作:**
|
||||
- 拖拽到同级菜单的前面或后面
|
||||
- 拖拽到其他菜单下作为子菜单
|
||||
|
||||
## 4. 后台API接口
|
||||
|
||||
### 4.1 接口列表
|
||||
|
||||
| API路径 | 方法 | 功能描述 | 所属文件 |
|
||||
|---------|------|---------|---------|
|
||||
| `/api/background/v1/system_settings/menu_configuration/menu/all` | GET | 获取用户权限内的菜单列表 | MenuService.php:58 |
|
||||
| `/api/background/v1/system_settings/menu_configuration/menu/list` | GET | 获取菜单列表(带筛选条件) | MenuService.php:124 |
|
||||
| `/api/background/v1/system_settings/menu_configuration/menu/create` | POST | 创建新菜单 | MenuService.php:186 |
|
||||
| `/api/background/v1/system_settings/menu_configuration/menu/edit` | POST | 编辑菜单信息 | MenuService.php:250 |
|
||||
| `/api/background/v1/system_settings/menu_configuration/menu/delete` | POST | 删除菜单 | MenuService.php:307 |
|
||||
| `/api/background/v1/system_settings/menu_configuration/menu/update_status` | POST | 更新菜单状态 | MenuService.php:328 |
|
||||
| `/api/background/v1/system_settings/menu_configuration/menu/update_sort` | POST | 更新菜单排序 | MenuService.php:352 |
|
||||
|
||||
### 4.2 数据模型
|
||||
|
||||
**菜单表字段:**
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 菜单唯一标识 |
|
||||
| parent_id | int | 父菜单ID |
|
||||
| name | varchar | 菜单名称 |
|
||||
| alias | varchar | 菜单别名 |
|
||||
| icon | varchar | 菜单图标 |
|
||||
| is_navi | tinyint | 是否导航显示(0/1) |
|
||||
| module | varchar | 所属模块(admin/pda) |
|
||||
| params | varchar | 链接参数 |
|
||||
| remark | varchar | 备注说明 |
|
||||
| sort | int | 排序序号 |
|
||||
| status | tinyint | 状态(0禁用/1启用) |
|
||||
| target | varchar | 打开方式 |
|
||||
| type | tinyint | 链接类型(0模块/1外链) |
|
||||
| url | varchar | 链接地址 |
|
||||
|
||||
## 5. 前端组件结构
|
||||
|
||||
### 5.1 组件目录
|
||||
|
||||
```
|
||||
menu_configuration/
|
||||
└── menu/
|
||||
├── components/
|
||||
│ ├── PageHeader/
|
||||
│ │ └── index.vue # 查询条件头部组件
|
||||
│ └── PageMain/
|
||||
│ └── index.vue # 主内容区域组件
|
||||
└── index.vue # 页面入口组件
|
||||
```
|
||||
|
||||
### 5.2 核心组件功能
|
||||
|
||||
| 组件 | 功能 | 关键特性 |
|
||||
|------|------|---------|
|
||||
| PageHeader | 查询条件面板 | 支持模块切换、状态筛选、导航属性筛选 |
|
||||
| PageMain | 菜单树和表单 | 树形展示、拖拽排序、增删改操作 |
|
||||
|
||||
## 6. 权限控制
|
||||
|
||||
菜单管理涉及以下权限点:
|
||||
|
||||
| 权限标识 | 权限名称 | 说明 |
|
||||
|---------|---------|------|
|
||||
| `/system_settings/menu_configuration/menu/create` | 新增菜单 | 允许创建新菜单 |
|
||||
| `/system_settings/menu_configuration/menu/edit` | 编辑菜单 | 允许修改菜单信息 |
|
||||
| `/system_settings/menu_configuration/menu/delete` | 删除菜单 | 允许删除菜单 |
|
||||
| `/system_settings/menu_configuration/menu/disabled_enable` | 启用/禁用菜单 | 允许切换菜单状态 |
|
||||
|
||||
## 7. 数据流程图
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[用户请求] --> B{是否超级管理员}
|
||||
B -->|是| C[查询全部菜单]
|
||||
B -->|否| D[查询角色关联菜单]
|
||||
C --> E[返回菜单列表]
|
||||
D --> E
|
||||
E --> F[前端渲染树形结构]
|
||||
F --> G[用户操作]
|
||||
G --> H{操作类型}
|
||||
H -->|新增| I[校验名称唯一性]
|
||||
H -->|编辑| J[校验名称唯一性]
|
||||
H -->|删除| K[检查角色使用情况]
|
||||
H -->|状态切换| L[检查角色使用情况]
|
||||
I --> M[保存菜单数据]
|
||||
J --> M
|
||||
K --> N{是否被使用}
|
||||
L --> N
|
||||
N -->|是| O[提示错误信息]
|
||||
N -->|否| P[执行操作]
|
||||
M --> Q[关联超级管理员]
|
||||
Q --> R[返回结果]
|
||||
P --> R
|
||||
O --> R
|
||||
```
|
||||
|
||||
## 8. 注意事项
|
||||
|
||||
**【重要】** 删除或禁用菜单前,请确保该菜单未被任何角色使用,否则操作将失败。
|
||||
|
||||
**【提示】** 建议定期整理菜单结构,保持菜单树的清晰性和逻辑性。
|
||||
|
||||
**【注意】** 菜单排序数值越小,显示越靠前,默认值为50。
|
||||
183
system_settings/system_assistant.md
Normal file
183
system_settings/system_assistant.md
Normal file
@@ -0,0 +1,183 @@
|
||||
# 系统助手
|
||||
|
||||
## 1. 功能概述
|
||||
|
||||
系统助手模块提供系统操作日志和接口日志的查询功能,帮助管理员追踪系统操作记录和设备对接流程的交互日志。
|
||||
|
||||
**核心功能:**
|
||||
|
||||
- 操作日志查询:记录用户的系统操作行为,支持按用户、IP、时间等条件查询
|
||||
- 接口日志查询:记录与设备对接的接口交互日志,支持按IP、接口名称等条件查询
|
||||
|
||||
## 2. 术语说明
|
||||
|
||||
#### 2.1.1 日志相关术语
|
||||
|
||||
| 术语 | 定义 | 说明 |
|
||||
|------|------|------|
|
||||
| 操作日志 | 用户在系统中的操作记录 | 包括登录、增删改查等操作 |
|
||||
| 接口日志 | 系统与外部设备/系统的交互记录 | 包括设备对接、数据传输等 |
|
||||
| 托盘号(tray) | 设备托盘的唯一标识 | 用于设备对接追踪 |
|
||||
| 批次号(batch) | 生产批次的唯一标识 | 用于生产流程追踪 |
|
||||
| 接口状态码 | 接口调用的返回状态 | 0表示成功,4001/4002表示失败 |
|
||||
|
||||
## 3. 操作日志
|
||||
|
||||
### 3.1 操作日志查询
|
||||
|
||||
**查询条件:**
|
||||
|
||||
| 查询条件 | 说明 |
|
||||
|---------|------|
|
||||
| 用户 | 按用户ID筛选操作记录 |
|
||||
| IP地址 | 按操作IP地址筛选 |
|
||||
| 路由名称 | 按访问的路由名称筛选 |
|
||||
| 托盘号 | 按托盘号筛选相关操作 |
|
||||
| 批次号 | 按批次号筛选相关操作 |
|
||||
| 时间范围 | 按操作时间范围筛选,默认最近一周 |
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 进入【系统设置】→【系统助手】→【操作日志】
|
||||
2. 在顶部查询区域设置查询条件
|
||||
3. 点击【查询】按钮获取操作日志列表
|
||||
|
||||
### 3.2 操作日志字段说明
|
||||
|
||||
| 字段 | 说明 |
|
||||
|------|------|
|
||||
| ID | 日志唯一标识 |
|
||||
| 用户名 | 执行操作的用户 |
|
||||
| 请求路径 | 访问的URL路径 |
|
||||
| 控制器方法 | 执行的控制器和方法 |
|
||||
| IP地址 | 操作来源IP |
|
||||
| 状态 | 操作状态 |
|
||||
| 请求参数 | 传入的参数 |
|
||||
| 执行结果 | 返回的结果 |
|
||||
| 操作类型 | 操作的类型 |
|
||||
| 操作名称 | 操作的中文名称 |
|
||||
| 托盘号 | 关联的托盘号 |
|
||||
| 批次号 | 关联的批次号 |
|
||||
| 操作时间 | 操作发生时间 |
|
||||
|
||||
### 3.3 日志记录内容
|
||||
|
||||
系统会自动记录以下类型的操作:
|
||||
|
||||
- 用户登录/登出
|
||||
- 数据新增、编辑、删除
|
||||
- 状态变更
|
||||
- 权限配置
|
||||
- 系统设置修改
|
||||
|
||||
## 4. 接口日志
|
||||
|
||||
### 4.1 接口日志查询
|
||||
|
||||
**查询条件:**
|
||||
|
||||
| 查询条件 | 说明 |
|
||||
|---------|------|
|
||||
| 设备单元 | 按设备单元名称筛选 |
|
||||
| IP地址 | 按客户端IP地址筛选 |
|
||||
| 工序代码 | 按工序代码筛选 |
|
||||
| 托盘号 | 按托盘号筛选 |
|
||||
| 电池ID | 按电池ID筛选 |
|
||||
| 时间范围 | 按交互时间范围筛选,默认最近一周 |
|
||||
| 状态 | 筛选成功或失败的接口调用 |
|
||||
| 来源类别 | 筛选ERP/SPC来源的接口 |
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 进入【系统设置】→【系统助手】→【接口日志】
|
||||
2. 在顶部查询区域设置查询条件
|
||||
3. 点击【查询】按钮获取接口日志列表
|
||||
|
||||
### 4.2 接口日志字段说明
|
||||
|
||||
| 字段 | 说明 |
|
||||
|------|------|
|
||||
| ID | 日志唯一标识 |
|
||||
| 设备单元 | 设备单元名称 |
|
||||
| 客户端IP | 调用接口的设备IP |
|
||||
| 数据1 | 通常存储工序代码 |
|
||||
| 数据2 | 通常存储托盘号 |
|
||||
| 数据3 | 通常存储电池ID |
|
||||
| 创建时间 | 日志记录时间 |
|
||||
| 接口时间 | 接口调用时间 |
|
||||
| 状态 | 接口调用状态(0成功,4001/4002失败) |
|
||||
| 类别 | 接口类别(erp/spc等) |
|
||||
| 类型 | 接口类型 |
|
||||
| 请求参数 | 接口传入参数 |
|
||||
| 返回结果 | 接口返回结果 |
|
||||
| 数据4 | 扩展字段1 |
|
||||
| 数据5 | 扩展字段2 |
|
||||
|
||||
### 4.3 接口状态码说明
|
||||
|
||||
| 状态码 | 说明 |
|
||||
|--------|------|
|
||||
| 0 | 接口调用成功 |
|
||||
| 4001 | 接口调用失败 |
|
||||
| 4002 | 接口超时 |
|
||||
|
||||
## 5. 后台API接口
|
||||
|
||||
### 5.1 操作日志接口
|
||||
|
||||
| API路径 | 方法 | 功能描述 | 所属文件 |
|
||||
|---------|------|---------|---------|
|
||||
| `/api/background/v1/system_settings/system_assistant/operate_log/list` | GET | 获取操作日志列表 | OperateLogService.php:31 |
|
||||
|
||||
### 5.2 接口日志接口
|
||||
|
||||
| API路径 | 方法 | 功能描述 | 所属文件 |
|
||||
|---------|------|---------|---------|
|
||||
| `/api/background/v1/system_settings/system_assistant/interface_log/list` | GET | 获取接口日志列表 | InterfaceLogService.php:31 |
|
||||
|
||||
## 6. 数据模型
|
||||
|
||||
### 6.1 操作日志表
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 日志唯一标识 |
|
||||
| user_id | int | 用户ID |
|
||||
| username | varchar | 用户名 |
|
||||
| path | varchar | 请求路径 |
|
||||
| controller_action | varchar | 控制器和方法 |
|
||||
| ip | varchar | 操作IP |
|
||||
| status | tinyint | 操作状态 |
|
||||
| params | text | 请求参数(JSON) |
|
||||
| result | text | 返回结果(JSON) |
|
||||
| action | varchar | 操作类型 |
|
||||
| action_name | varchar | 操作名称 |
|
||||
| tray | varchar | 托盘号 |
|
||||
| batch | varchar | 批次号 |
|
||||
| create_time | datetime | 创建时间 |
|
||||
|
||||
### 6.2 接口日志表
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 日志唯一标识 |
|
||||
| unit | varchar | 设备单元 |
|
||||
| client_ip | varchar | 客户端IP |
|
||||
| data1 | varchar | 数据字段1(工序代码) |
|
||||
| data2 | varchar | 数据字段2(托盘号) |
|
||||
| data3 | varchar | 数据字段3(电池ID) |
|
||||
| data4 | varchar | 数据字段4 |
|
||||
| data5 | varchar | 数据字段5 |
|
||||
| create_time | datetime | 创建时间 |
|
||||
| insterface_time | datetime | 接口调用时间 |
|
||||
| status | int | 接口状态码 |
|
||||
| class | varchar | 接口类别 |
|
||||
| type | varchar | 接口类型 |
|
||||
| params | text | 请求参数(JSON) |
|
||||
| result | text | 返回结果(JSON) |
|
||||
|
||||
## 7. 注意事项
|
||||
|
||||
**【提示】** 操作日志和接口日志默认只保留最近一周的数据,如需查看更早的数据,请调整时间范围。
|
||||
|
||||
**【注意】** 接口日志中的数据字段(data1-data5)用途根据接口类型不同而有所差异,具体含义需要结合业务场景理解。
|
||||
119
system_settings/system_monitoring.md
Normal file
119
system_settings/system_monitoring.md
Normal file
@@ -0,0 +1,119 @@
|
||||
# 系统监控
|
||||
|
||||
## 1. 功能概述
|
||||
|
||||
系统监控模块用于配置和管理系统监控参数,实现对服务器资源的实时监控和告警设置。
|
||||
|
||||
**核心功能:**
|
||||
|
||||
- 监控配置管理:创建、编辑、删除监控配置
|
||||
- 资源告警设置:配置CPU、磁盘、内存的告警阈值
|
||||
- 监控刷新设置:配置监控数据的刷新间隔
|
||||
- 监控列表查询:支持按名称和编号筛选
|
||||
|
||||
## 2. 术语说明
|
||||
|
||||
#### 2.1.1 监控相关术语
|
||||
|
||||
| 术语 | 定义 | 说明 |
|
||||
|------|------|------|
|
||||
| 监控编号 | 监控配置的唯一标识 | 用于区分不同的监控目标 |
|
||||
| 刷新间隔 | 监控数据更新的时间间隔 | 单位通常为秒 |
|
||||
| CPU告警阈值 | CPU使用率的告警界限 | 超过此值触发告警 |
|
||||
| 磁盘告警阈值 | 磁盘使用率的告警界限 | 超过此值触发告警 |
|
||||
| 内存告警阈值 | 内存使用率的告警界限 | 超过此值触发告警 |
|
||||
|
||||
## 3. 监控设置管理
|
||||
|
||||
### 3.1 监控配置查询
|
||||
|
||||
**查询条件:**
|
||||
|
||||
| 查询条件 | 说明 |
|
||||
|---------|------|
|
||||
| 名称 | 按监控名称模糊查询 |
|
||||
| 编号 | 按监控编号模糊查询 |
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 进入【系统设置】→【系统监控】→【监控设置】
|
||||
2. 在顶部查询区域设置查询条件
|
||||
3. 点击【查询】按钮获取监控配置列表
|
||||
|
||||
### 3.2 新增监控配置
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 点击【新增】按钮
|
||||
2. 填写监控配置信息
|
||||
3. 点击【确定】完成新增
|
||||
|
||||
**字段说明:**
|
||||
|
||||
| 字段 | 说明 | 必填 |
|
||||
|------|------|------|
|
||||
| 监控编号 | 监控的唯一标识代码 | 是 |
|
||||
| 监控名称 | 监控的中文名称 | 是 |
|
||||
| IP地址 | 被监控服务器的IP地址 | 是 |
|
||||
| 端口 | 监控服务端口 | 是 |
|
||||
| 刷新间隔 | 数据刷新间隔(秒) | 是 |
|
||||
| CPU告警阈值 | CPU使用率告警阈值(%) | 是 |
|
||||
| 磁盘告警阈值 | 磁盘使用率告警阈值(%) | 是 |
|
||||
| 内存告警阈值 | 内存使用率告警阈值(%) | 是 |
|
||||
| 版本 | 监控服务版本号 | 否 |
|
||||
|
||||
**【提示】** 监控编号和监控名称不能重复。
|
||||
|
||||
### 3.3 编辑监控配置
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在监控列表中点击需要编辑的配置
|
||||
2. 修改配置信息
|
||||
3. 点击【确定】保存更改
|
||||
|
||||
### 3.4 删除监控配置
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在监控列表中选择需要删除的配置
|
||||
2. 点击【删除】按钮
|
||||
3. 在确认对话框中点击【确定】
|
||||
|
||||
**【提示】** 支持批量删除多个监控配置。
|
||||
|
||||
## 4. 后台API接口
|
||||
|
||||
| API路径 | 方法 | 功能描述 | 所属文件 |
|
||||
|---------|------|---------|---------|
|
||||
| `/api/background/v1/system_settings/system_monitoring/monitoring_setting/list` | GET | 获取监控配置列表 | MonitoringSettingService.php:31 |
|
||||
| `/api/background/v1/system_settings/system_monitoring/monitoring_setting/create` | POST | 创建监控配置 | MonitoringSettingService.php:84 |
|
||||
| `/api/background/v1/system_settings/system_monitoring/monitoring_setting/edit` | POST | 编辑监控配置 | MonitoringSettingService.php:145 |
|
||||
| `/api/background/v1/system_settings/system_monitoring/monitoring_setting/delete` | POST | 删除监控配置 | MonitoringSettingService.php:201 |
|
||||
|
||||
## 5. 数据模型
|
||||
|
||||
### 5.1 监控配置表
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 配置唯一标识 |
|
||||
| code | varchar | 监控编号 |
|
||||
| name | varchar | 监控名称 |
|
||||
| port | int | 监控端口 |
|
||||
| ip | varchar | 服务器IP地址 |
|
||||
| refresh_interval | int | 刷新间隔(秒) |
|
||||
| cpu_warning | int | CPU告警阈值(%) |
|
||||
| disk_warning | int | 磁盘告警阈值(%) |
|
||||
| mem_warning | int | 内存告警阈值(%) |
|
||||
| version | varchar | 版本号 |
|
||||
| sort | int | 排序序号 |
|
||||
| create_time | datetime | 创建时间 |
|
||||
|
||||
## 6. 注意事项
|
||||
|
||||
**【提示】** 告警阈值建议设置在合理范围,避免过于频繁的告警通知。
|
||||
|
||||
**【注意】** 监控配置删除后无法恢复,请谨慎操作。
|
||||
|
||||
**【重要】** 确保配置的IP地址和端口可以正常访问,否则监控数据无法获取。
|
||||
316
system_settings/user_management.md
Normal file
316
system_settings/user_management.md
Normal file
@@ -0,0 +1,316 @@
|
||||
# 用户管理
|
||||
|
||||
## 1. 功能概述
|
||||
|
||||
用户管理模块用于管理系统用户账号和角色权限,实现用户的增删改查、角色分配、密码管理以及权限配置功能。
|
||||
|
||||
**核心功能:**
|
||||
|
||||
- 用户账号管理:创建、编辑、删除用户账号
|
||||
- 用户状态控制:启用/禁用用户账号
|
||||
- 角色管理:创建、编辑、删除角色(用户组)
|
||||
- 权限分配:为角色分配菜单和API权限
|
||||
- 密码管理:修改密码、重置密码
|
||||
- 用户数据导入导出:支持批量导入和导出用户数据
|
||||
|
||||
## 2. 术语说明
|
||||
|
||||
#### 2.1.1 用户管理术语
|
||||
|
||||
| 术语 | 定义 | 说明 |
|
||||
|------|------|------|
|
||||
| 用户组/角色 | 用户所属的权限分组 | 同一角色的用户拥有相同权限 |
|
||||
| 出入证编号 | 用户的证件编号 | 用于门禁等场景 |
|
||||
| 超级管理员 | 系统最高权限角色 | 默认拥有所有菜单权限 |
|
||||
| is_all_menu | 是否拥有全部菜单权限 | 1表示拥有全部权限 |
|
||||
|
||||
## 3. 角色管理
|
||||
|
||||
### 3.1 角色列表查询
|
||||
|
||||
**查询条件:**
|
||||
|
||||
| 查询条件 | 说明 |
|
||||
|---------|------|
|
||||
| 状态 | 筛选启用或禁用状态的角色 |
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 进入【系统设置】→【用户管理】→【角色】
|
||||
2. 在顶部查询区域选择状态条件
|
||||
3. 点击【查询】按钮获取角色列表
|
||||
|
||||
### 3.2 新增角色
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 点击【新增角色】按钮
|
||||
2. 填写角色名称和描述
|
||||
3. 设置角色状态
|
||||
4. 点击【确定】完成新增
|
||||
|
||||
**字段说明:**
|
||||
|
||||
| 字段 | 说明 | 必填 |
|
||||
|------|------|------|
|
||||
| 名称 | 角色名称,如"管理员"、"普通用户" | 是 |
|
||||
| 描述 | 角色的详细说明 | 否 |
|
||||
| 状态 | 启用或禁用 | 是 |
|
||||
|
||||
**【提示】** 角色名称不能重复。
|
||||
|
||||
### 3.3 编辑角色
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在角色列表中点击需要编辑的角色
|
||||
2. 修改角色信息
|
||||
3. 点击【确定】保存更改
|
||||
|
||||
### 3.4 删除角色
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在角色列表中找到需要删除的角色
|
||||
2. 点击【删除】按钮
|
||||
3. 在确认对话框中点击【确定】
|
||||
|
||||
**【重要】** 如果角色下存在用户,无法删除该角色。
|
||||
|
||||
### 3.5 权限分配
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在角色列表中点击【权限配置】按钮
|
||||
2. 在权限配置页面选择需要分配的菜单和API
|
||||
3. 点击【确定】保存权限配置
|
||||
|
||||
**【提示】** 权限配置会覆盖角色原有的所有权限。
|
||||
|
||||
## 4. 用户管理
|
||||
|
||||
### 4.1 用户列表查询
|
||||
|
||||
**查询条件:**
|
||||
|
||||
| 查询条件 | 说明 |
|
||||
|---------|------|
|
||||
| 账号 | 按用户名模糊查询 |
|
||||
| 姓名 | 按昵称模糊查询 |
|
||||
| 用户组 | 按角色筛选 |
|
||||
| 状态 | 筛选启用或禁用状态的用户 |
|
||||
|
||||
### 4.2 新增用户
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 点击【新增用户】按钮
|
||||
2. 填写用户信息
|
||||
3. 设置用户组和状态
|
||||
4. 点击【确定】完成新增
|
||||
|
||||
**字段说明:**
|
||||
|
||||
| 字段 | 说明 | 必填 |
|
||||
|------|------|------|
|
||||
| 账号 | 用户登录账号 | 是 |
|
||||
| 姓名 | 用户昵称或真实姓名 | 是 |
|
||||
| 出入证编号 | 用户的证件编号 | 否 |
|
||||
| 密码 | 用户登录密码 | 是 |
|
||||
| 确认密码 | 再次输入密码确认 | 是 |
|
||||
| 用户组 | 选择用户所属角色 | 是 |
|
||||
| 状态 | 启用或禁用 | 是 |
|
||||
|
||||
**【注意】** 两次输入的密码必须一致,已删除或禁用的用户组无法选择。
|
||||
|
||||
### 4.3 编辑用户
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在用户列表中点击需要编辑的用户
|
||||
2. 修改用户信息
|
||||
3. 点击【确定】保存更改
|
||||
|
||||
**【注意】** 不能禁用自己的账号。
|
||||
|
||||
### 4.4 删除用户
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在用户列表中找到需要删除的用户
|
||||
2. 点击【删除】按钮
|
||||
3. 在确认对话框中点击【确定】
|
||||
|
||||
**【重要】** 不能删除自己的账号。
|
||||
|
||||
### 4.5 批量操作
|
||||
|
||||
**支持的批量操作:**
|
||||
|
||||
- 批量删除:选择多个用户后点击【批量删除】
|
||||
- 批量启用/禁用:选择多个用户后点击【批量启用】或【批量禁用】
|
||||
|
||||
### 4.6 密码管理
|
||||
|
||||
#### 修改密码
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在用户列表中点击【修改密码】按钮
|
||||
2. 输入旧密码和新密码
|
||||
3. 点击【确定】完成修改
|
||||
|
||||
#### 重置密码
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 在用户列表中点击【重置密码】按钮
|
||||
2. 在确认对话框中点击【确定】
|
||||
3. 密码将被重置为默认密码"123456"
|
||||
|
||||
### 4.7 用户数据导入导出
|
||||
|
||||
#### 导入用户数据
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 点击【下载导入模板】获取导入模板文件
|
||||
2. 按照模板格式填写用户数据
|
||||
3. 上传填写好的Excel文件
|
||||
4. 点击【导入】完成批量导入
|
||||
|
||||
**导入模板字段:**
|
||||
|
||||
| 字段 | 说明 | 必填 |
|
||||
|------|------|------|
|
||||
| 账号 | 用户登录账号 | 是 |
|
||||
| 姓名 | 用户昵称 | 是 |
|
||||
| 出入证编号 | 用户证件编号 | 否 |
|
||||
| 密码 | 用户密码 | 是 |
|
||||
| 状态 | 启用或禁用 | 是 |
|
||||
| 用户组 | 用户所属角色名称 | 是 |
|
||||
|
||||
#### 导出用户数据
|
||||
|
||||
**操作步骤:**
|
||||
|
||||
1. 设置查询条件筛选需要导出的用户
|
||||
2. 点击【导出】按钮
|
||||
3. 系统后台生成导出任务
|
||||
4. 在下载管理中获取导出文件
|
||||
|
||||
## 5. 后台API接口
|
||||
|
||||
### 5.1 用户管理接口
|
||||
|
||||
| API路径 | 方法 | 功能描述 | 所属文件 |
|
||||
|---------|------|---------|---------|
|
||||
| `/api/background/v1/system_settings/user_management/user/all` | GET | 获取启用状态的用户列表 | UserService.php:44 |
|
||||
| `/api/background/v1/system_settings/user_management/user/list` | GET | 获取用户列表(分页) | UserService.php:77 |
|
||||
| `/api/background/v1/system_settings/user_management/user/create` | POST | 创建用户 | UserService.php:144 |
|
||||
| `/api/background/v1/system_settings/user_management/user/edit` | POST | 编辑用户 | UserService.php:192 |
|
||||
| `/api/background/v1/system_settings/user_management/user/delete` | POST | 删除用户 | UserService.php:239 |
|
||||
| `/api/background/v1/system_settings/user_management/user/batch_delete` | POST | 批量删除用户 | UserService.php:269 |
|
||||
| `/api/background/v1/system_settings/user_management/user/enable` | POST | 启用用户 | UserService.php:302 |
|
||||
| `/api/background/v1/system_settings/user_management/user/disable` | POST | 禁用用户 | UserService.php:321 |
|
||||
| `/api/background/v1/system_settings/user_management/user/update_pwd` | POST | 修改密码 | UserService.php:346 |
|
||||
| `/api/background/v1/system_settings/user_management/user/reset_pwd` | POST | 重置密码 | UserService.php:372 |
|
||||
| `/api/background/v1/system_settings/user_management/user/get_import_template` | GET | 获取导入模板 | UserService.php:392 |
|
||||
| `/api/background/v1/system_settings/user_management/user/user_data_import` | POST | 导入用户数据 | UserService.php:458 |
|
||||
| `/api/background/v1/system_settings/user_management/user/user_data_export_task` | POST | 创建导出任务 | UserService.php:515 |
|
||||
|
||||
### 5.2 角色管理接口
|
||||
|
||||
| API路径 | 方法 | 功能描述 | 所属文件 |
|
||||
|---------|------|---------|---------|
|
||||
| `/api/background/v1/system_settings/user_management/role/all` | GET | 获取启用状态的角色列表 | RoleService.php:55 |
|
||||
| `/api/background/v1/system_settings/user_management/role/list` | GET | 获取角色列表(分页) | RoleService.php:81 |
|
||||
| `/api/background/v1/system_settings/user_management/role/create` | POST | 创建角色 | RoleService.php:154 |
|
||||
| `/api/background/v1/system_settings/user_management/role/edit` | POST | 编辑角色 | RoleService.php:185 |
|
||||
| `/api/background/v1/system_settings/user_management/role/delete` | POST | 删除角色 | RoleService.php:218 |
|
||||
| `/api/background/v1/system_settings/user_management/role/update_status` | POST | 更新角色状态 | RoleService.php:243 |
|
||||
| `/api/background/v1/system_settings/user_management/role/get_role_menu` | GET | 获取角色权限 | RoleService.php:257 |
|
||||
| `/api/background/v1/system_settings/user_management/role/give_role_menu` | POST | 分配角色权限 | RoleService.php:300 |
|
||||
|
||||
## 6. 数据模型
|
||||
|
||||
### 6.1 用户表
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 用户唯一标识 |
|
||||
| username | varchar | 登录账号 |
|
||||
| password | varchar | 加密后的密码 |
|
||||
| nickname | varchar | 用户昵称 |
|
||||
| role_id | int | 所属角色ID |
|
||||
| head_pic | varchar | 头像URL |
|
||||
| pass_number | varchar | 出入证编号 |
|
||||
| last_login | datetime | 最后登录时间 |
|
||||
| last_ip | varchar | 最后登录IP |
|
||||
| is_all_menu | tinyint | 是否拥有全部菜单权限 |
|
||||
| status | tinyint | 状态(0禁用/1启用) |
|
||||
| sort | int | 排序序号 |
|
||||
| create_time | datetime | 创建时间 |
|
||||
| update_time | datetime | 更新时间 |
|
||||
|
||||
### 6.2 角色表
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 角色唯一标识 |
|
||||
| name | varchar | 角色名称 |
|
||||
| description | varchar | 角色描述 |
|
||||
| system | tinyint | 是否系统内置角色 |
|
||||
| status | tinyint | 状态(0禁用/1启用) |
|
||||
| sort | int | 排序序号 |
|
||||
|
||||
### 6.3 角色菜单关联表
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| id | int | 关联ID |
|
||||
| role_id | int | 角色ID |
|
||||
| menu_id | int | 菜单ID |
|
||||
| module | varchar | 模块(admin/pda/api) |
|
||||
|
||||
## 7. 数据流程图
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[用户管理] --> B[新增用户]
|
||||
A --> C[编辑用户]
|
||||
A --> D[删除用户]
|
||||
A --> E[修改密码]
|
||||
|
||||
B --> F{验证用户名唯一性}
|
||||
F -->|已存在| G[提示错误]
|
||||
F -->|不存在| H{验证密码一致性}
|
||||
H -->|不一致| I[提示错误]
|
||||
H -->|一致| J{验证角色有效性}
|
||||
J -->|无效| K[提示错误]
|
||||
J -->|有效| L[保存用户数据]
|
||||
|
||||
C --> M{验证用户名唯一性}
|
||||
M -->|重复| N[提示错误]
|
||||
M -->|唯一| O{是否禁用自己}
|
||||
O -->|是| P[提示错误]
|
||||
O -->|否| Q[更新用户数据]
|
||||
|
||||
D --> R{是否删除自己}
|
||||
R -->|是| S[提示错误]
|
||||
R -->|否| T[删除用户并重新排序]
|
||||
|
||||
E --> U{验证密码一致性}
|
||||
U -->|不一致| V[提示错误]
|
||||
U -->|一致| W{新旧密码是否相同}
|
||||
W -->|相同| X[提示错误]
|
||||
W -->|不同| Y[更新密码]
|
||||
```
|
||||
|
||||
## 8. 注意事项
|
||||
|
||||
**【重要】** 用户在进行删除或禁用操作时,不能操作自己的账号。
|
||||
|
||||
**【注意】** 删除或禁用角色前,请确保该角色下没有关联的用户。
|
||||
|
||||
**【提示】** 导入用户数据时,如果用户名已存在,该行数据将被跳过。
|
||||
Reference in New Issue
Block a user