James/HF-MES-manual
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs(user_management): 添加用户管理功能截图并更新文档

Browse Source 
更新用户管理模块文档，添加各功能对应的中文截图
补充EXCEL模板图片和操作流程图
This commit is contained in:
sheng
2026-05-06 15:11:02 +08:00
parent 3a40db0260
commit fb4cedb504
18 changed files with 75 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
system_settings/user_management.md
View File

@@ -11,7 +11,10 @@
- 角色管理：创建、编辑、删除角色（用户组）
- 权限分配：为角色分配菜单和API权限
- 密码管理：修改密码、重置密码
- 用户数据导入导出：支持批量导入和导出用户数据
**功能对应截图** ：
![图片：用户管理功能截图](/public/image/user_management/图片：用户管理功能截图.png)
## 2. 术语说明
@@ -22,7 +25,7 @@
| 用户组/角色 | 用户所属的权限分组 | 同一角色的用户拥有相同权限 |
| 出入证编号 | 用户的证件编号 | 用于门禁等场景 |
| 超级管理员 | 系统最高权限角色 | 默认拥有所有菜单权限 |
| is_all_menu | 是否拥有全部菜单权限 | 1表示拥有全部权限 |
## 3. 角色管理
@@ -40,6 +43,10 @@
2. 在顶部查询区域选择状态条件
3. 点击【查询】按钮获取角色列表
**功能对应截图** ：
![图片：角色管理查询功能截图](/public/image/user_management/图片：角色管理查询功能截图.png)
### 3.2 新增角色
**操作步骤：**
@@ -59,6 +66,10 @@
**【提示】** 角色名称不能重复。
**功能对应截图** ：
![图片：角色管理新增功能截图](/public/image/user_management/图片：角色管理新增功能截图.png)
### 3.3 编辑角色
**操作步骤：**
@@ -67,6 +78,10 @@
2. 修改角色信息
3. 点击【确定】保存更改
**功能对应截图** ：
![图片：角色管理编辑功能截图](/public/image/user_management/图片：角色管理编辑功能截图.png)
### 3.4 删除角色
**操作步骤：**
@@ -77,6 +92,10 @@
**【重要】** 如果角色下存在用户，无法删除该角色。
**功能对应截图** ：
![图片：角色管理删除功能截图](/public/image/user_management/图片：角色管理删除功能截图.png)
### 3.5 权限分配
**操作步骤：**
@@ -87,6 +106,11 @@
**【提示】** 权限配置会覆盖角色原有的所有权限。
**功能对应截图** ：
![图片：角色管理权限分配功能截图](/public/image/user_management/图片：角色管理权限分配功能截图.png)
## 4. 用户管理
### 4.1 用户列表查询
@@ -100,6 +124,11 @@
| 用户组 | 按角色筛选 |
| 状态 | 筛选启用或禁用状态的用户 |
**功能对应截图** ：
![图片：用户管理查询功能截图](/public/image/user_management/图片：用户管理查询功能截图.png)
### 4.2 新增用户
**操作步骤：**
@@ -123,6 +152,12 @@
**【注意】** 两次输入的密码必须一致，已删除或禁用的用户组无法选择。
**功能对应截图** ：
![图片：用户管理新增功能截图](/public/image/user_management/图片：用户管理新增功能截图.png)
### 4.3 编辑用户
**操作步骤：**
@@ -133,6 +168,11 @@
**【注意】** 不能禁用自己的账号。
**功能对应截图** ：
![图片：用户管理编辑功能截图](/public/image/user_management/图片：用户管理编辑功能截图.png)
### 4.4 删除用户
**操作步骤：**
@@ -143,6 +183,10 @@
**【重要】** 不能删除自己的账号。
**功能对应截图** ：
![图片：用户管理删除功能截图](/public/image/user_management/图片：用户管理删除功能截图.png)
### 4.5 批量操作
**支持的批量操作：**
@@ -150,16 +194,24 @@
- 批量删除：选择多个用户后点击【批量删除】
- 批量启用/禁用：选择多个用户后点击【批量启用】或【批量禁用】
**功能对应截图** ：
![图片：用户管理批量操作功能截图](/public/image/user_management/图片：用户管理批量操作功能截图.png)
### 4.6 密码管理
#### 修改密码
**操作步骤：**
1. 在用户列表中点击【修改密码】按钮
1. 在页面右上角鼠标移动到用户名字，点击下拉框中的【修改密码】按钮
2. 输入旧密码和新密码
3. 点击【确定】完成修改
**功能对应截图** ：
![图片：用户管理修改密码功能截图](/public/image/user_management/图片：用户管理修改密码功能截图.png)
#### 重置密码
**操作步骤：**
@@ -168,6 +220,11 @@
2. 在确认对话框中点击【确定】
3. 密码将被重置为默认密码"123456"
**功能对应截图** ：
![图片：用户管理重置密码功能截图](/public/image/user_management/图片：用户管理重置密码功能截图.png)
### 4.7 用户数据导入导出
#### 导入用户数据
@@ -190,6 +247,10 @@
| 状态 | 启用或禁用 | 是 |
| 用户组 | 用户所属角色名称 | 是 |
**功能对应截图** ：
![图片：用户管理导入功能截图](/public/image/user_management/图片：用户管理导入功能截图.png)
![图片：EXCEL模板](/public/image/user_management/图片：EXCEL模板.png)
#### 导出用户数据
**操作步骤：**
@@ -199,81 +260,11 @@
3. 系统后台生成导出任务
4. 在下载管理中获取导出文件
## 5. 后台API接口
**功能对应截图** ：
### 5.1 用户管理接口
![图片：用户管理导出功能截图](/public/image/user_management/图片：用户管理导出功能截图.png)
| 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. 数据流程图
## 5. 操作逻辑流程图
```mermaid
flowchart TD
@@ -307,7 +298,7 @@ flowchart TD
W -->|不同| Y[更新密码]
```
## 8. 注意事项
## 6. 注意事项
**【重要】** 用户在进行删除或禁用操作时，不能操作自己的账号。