FastAPI搭建Python后台管理系统详细解析（四）
-
-
john 在知识的海洋中遨游
0 人点赞了该文章 · 485 浏览
## [60/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/service/online_service.py
### 概述：在线用户管理服务（online_service.py）
该文件包含一个名为 `OnlineService` 的类，主要负责在线用户管理的服务逻辑，使用 FastAPI 框架和 Redis 存储。
#### 类与方法
1. **类：`OnlineService`**
- 该类提供在线用户管理的相关服务。
2. **方法：`get_online_list_services`**
- **功能**：获取当前在线用户列表。
- **参数**：
- `request`: FastAPI 的请求对象，用于访问应用状态中的 Redis。
- `query_object`: 包含查询参数的对象，支持根据用户名或 IP 地址进行筛选。
- **返回**：在线用户信息列表，使用 `CamelCaseUtil` 进行格式转换。
3. **方法：`delete_online_services`**
- **功能**：强制退还在线用户，依据提供的 `session_id`。
- **参数**：
- `request`: 请求对象。
- `page_object`: 包含要强退的用户 token IDs 的对象。
- **返回**：操作是否成功的结果封装在 `CrudResponseModel` 中，或者抛出服务异常。
#### 依赖模块
- `jwt`：用于解析 JWT 令牌以获取用户信息。
- `FastAPI`：用于处理请求。
- `config`：包含 Redis 和 JWT 配置。
- `exceptions`：自定义异常处理。
- `entity.vo`：包含请求和响应的数据模型。
- `utils`：实用工具类，用于CamelCase转换。
#### 功能概述
- **在线用户查询**：可以根据不同条件查询在线用户信息。
- **强制用户退还**：支持根据 session ID 强制用户下线，确保系统对在线用户的管理。
该模块为在线用户管理提供了必要的后端支持，能够高效获取和处理用户在线状态。
## [61/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/service/log_service.py
### 概述
文件名：`log_service.py`
#### 主要功能
该文件包含两个主要服务类：`OperationLogService`和`LoginLogService`，用于处理操作日志和登录日志的相关业务逻辑。
#### 类与方法
1. **OperationLogService**
- 主要负责操作日志的管理，包括获取、添加、删除和清除操作日志，以及导出操作日志数据。
- **方法**：
- `get_operation_log_list_services`: 获取操作日志列表。
- `add_operation_log_services`: 新增操作日志。
- `delete_operation_log_services`: 删除指定的操作日志。
- `clear_operation_log_services`: 清除所有操作日志。
- `export_operation_log_list_services`: 导出操作日志为Excel格式。
2. **LoginLogService**
- 主要负责登录日志的管理，包括获取、添加、删除和清除登录日志，以及解锁用户和导出登录日志数据。
- **方法**：
- `get_login_log_list_services`: 获取登录日志列表。
- `add_login_log_services`: 新增登录日志。
- `delete_login_log_services`: 删除指定的登录日志。
- `clear_login_log_services`: 清除所有登录日志。
- `unlock_user_services`: 解锁被锁定用户。
- `export_login_log_list_services`: 导出登录日志为Excel格式。
#### 数据访问
- 此文件通过`OperationLogDao`和`LoginLogDao`类与数据库进行交互，完成数据的增删改查操作。
#### 异常处理
- 文件中的方法借助`ServiceException`来处理特定的业务逻辑异常，确保对用户友好的错误反馈。
#### 使用的库
- 利用了FastAPI (用于HTTP请求)，SQLAlchemy (用于异步数据库操作)，以及工具函数`export_list2excel`（用于数据导出）。
#### 总结
`log_service.py`是一个后端服务模块，专注于操作日志与登录日志的管理，提供了清晰的异步服务接口以支持不同的日志处理需求，并实现了数据的安全性与有效性保障。
## [62/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/service/post_service.py
### 概述文件：post_service.py
#### 文件位置
`fastapi-backend/module_admin/service/post_service.py`
#### 文件功能
该文件定义了一个 `PostService` 类，主要负责处理岗位管理模块中的业务逻辑，包括岗位的查询、添加、编辑、删除及导出等功能。
#### 类和方法概述
- **类：PostService**
- 作为岗位管理的服务层，与数据访问层 (DAO) 交互，提供业务相关的操作。
- **方法：**
1. **get_post_list_services**：异步获取岗位列表，可选择是否分页。
2. **check_post_name_unique_services**：检查岗位名称是否唯一。
3. **check_post_code_unique_services**：检查岗位编码是否唯一。
4. **add_post_services**：新增岗位信息，并验证岗位名称和编码的唯一性。
5. **edit_post_services**：编辑现有岗位，校验名称和编码的唯一性，若存在则报错。
6. **delete_post_services**：删除指定岗位，确保岗位未被分配后才执行删除。
7. **post_detail_services**：获取指定岗位的详细信息。
8. **export_post_list_services**：导出岗位信息至Excel格式，并返回其二进制数据。
#### 依赖组件
- **AsyncSession**：用于异步数据库会话。
- **PostDao**：数据访问对象，实际执行数据库操作。
- **CrudResponseModel**：通用的增删改查响应模型。
- **CommonConstant**：存储常量，例如返回值状态。
- **ServiceException**：自定义异常，用于服务层错误处理。
- **CamelCaseUtil**、**export_list2excel**：工具类和方法，用于数据转换和导出操作。
#### 适用场景
该服务类适用于基于FastAPI框架的后端应用，帮助管理系统中的岗位信息。提供了一整套方法以处理岗位的 CRUD 操作及其验证逻辑，确保数据的一致性和合规性。
## [63/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/post_controler.py
文件 `post_controler.py` 是一个 FastAPI 控制器，负责处理与“岗位管理”相关的 API 请求，提供对岗位的增删改查功能。以下是其主要内容的概述：
1. **导入模块**：引入了 FastAPI 的基础模块、数据库会话、参数校验和日志处理等工具。
2. **路由定义**：使用 `APIRouter` 创建了一个路由前缀为 `/system/post` 的路由器，该路由器应用了一些依赖，比如用户认证。
3. **API 端点**：
- **获取岗位列表** (`GET /list`)：分页查询岗位列表，并返回响应数据。
- **添加岗位** (`POST /`)：接收岗位数据，添加新岗位，同时记录创建者和时间，并返回操作结果。
- **编辑岗位** (`PUT /`)：更新现有岗位的数据，记录更新者和时间。
- **删除岗位** (`DELETE /{post_ids}`)：根据岗位 IDs 删除岗位，并返回操作结果。
- **查询岗位细节** (`GET /{post_id}`)：根据岗位 ID 查询详细信息，并返回相应数据。
- **导出岗位列表** (`POST /export`)：导出岗位数据，返回流式响应。
4. **日志与异常处理**：每个操作都通过 `logger` 记录日志，以及使用 `ResponseUtil` 处理响应，保持一致的返回格式和信息。
5. **依赖注入**：使用 `Depends()` 注入数据库会话和当前用户，通过 `CheckUserInterfaceAuth` 进行权限验证。
整体来说，该控制器的结构清晰，涵盖了基本的 CRUD 操作，并通过日志和响应工具增强了可读性和可维护性。
## [64/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/user_controller.py
文件 `user_controller.py` 是一个 FastAPI 控制器，主要处理用户管理相关的 API 请求，功能包括用户的创建、更新、删除、信息查询等。以下是该文件的概述：
1. **导入依赖**：文件导入了必须的库和模块，包括 FastAPI 路由器、数据库依赖、日志记录工具、用户和角色相关的服务等。
2. **路由定义**：
- 使用 `APIRouter` 设置了多个用户管理相关的路由，以 `/system/user` 为前缀。
3. **API 功能**：
- **获取部门树**：`get_system_dept_tree` 接口返回组织的部门结构。
- **获取用户列表**：`get_system_user_list`，实现分页查询用户信息。
- **添加用户**：`add_system_user` 通过接收用户信息，添加新用户。
- **编辑用户**：`edit_system_user` 修改已有用户的信息。
- **删除用户**：`delete_system_user` 支持批量删除用户。
- **重置用户密码**：`reset_system_user_pwd` 允许当前用户重置其他用户的密码。
- **修改用户状态**：`change_system_user_status` 修改用户的活跃状态。
- **获取用户详细信息**：`query_detail_system_user` 提供指定用户的详细信息。
- **用户头像上传**：`change_system_user_profile_avatar` 支持用户头像的上传和更新。
- **用户信息更新**：`change_system_user_profile_info` 修改个人信息。
- **用户密码更新**：`reset_system_user_password` 实现密码的更新功能。
- **批量导入用户**：`batch_import_system_user` 批量导入用户数据。
- **导出用户数据模板**：`export_system_user_template` 提供用户数据的导出模板。
- **导出用户列表**：`export_system_user_list` 导出用户信息的完整列表。
- **获取用户角色列表**：`get_system_allocated_role_list` 返回用户已分配的角色信息。
- **更新用户角色**：`update_system_role_user` 用于增加或更新用户的角色。
4. **权限和注解**：
- 许多接口使用 `CheckUserInterfaceAuth` 装饰器进行权限检查，确保只有拥有相应权限的用户才能访问对应的功能。
- 日志记录功能通过 `@Log` 注解实现。
5. **数据验证**：使用 `@ValidateFields` 装饰器对用户输入的数据进行验证，确保数据的完整性和有效性。
6. **响应处理**：文件使用 `ResponseUtil` 工具类统一格式化成功或失败的响应。
本文件发挥了 FastAPI 的非阻塞特性，适合高并发环境下的用户管理需求。
## [65/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/dict_controller.py
### 概述：dict_controller.py
#### 概要
`dict_controller.py` 是一个使用 FastAPI 框架构建的 RESTful API 控制器，负责字典类型和字典数据的管理。它实现了 CRUD（创建、读取、更新、删除）操作，并包含日志记录和用户权限检查功能。
#### 主要组成部分
1. **依赖模块**
- FastAPI：用于创建 API 路由。
- SQLAlchemy：数据库操作（使用异步会话）。
- Pydantic：数据验证。
- 工具函数与响应处理：如日志记录、分页和响应格式化。
2. **API 路由**
- **字典类型相关接口**
- 获取字典类型列表（`GET /type/list`）
- 添加字典类型（`POST /type`）
- 修改字典类型（`PUT /type`）
- 刷新字典缓存（`DELETE /type/refreshCache`）
- 删除字典类型（`DELETE /type/{dict_ids}`）
- 获取字典类型选项（`GET /type/optionselect`）
- 获取字典类型详情（`GET /type/{dict_id}`）
- 导出字典类型列表（`POST /type/export`）
- **字典数据相关接口**
- 获取字典数据列表（`GET /data/list`）
- 添加字典数据（`POST /data`）
- 修改字典数据（`PUT /data`）
- 删除字典数据（`DELETE /data/{dict_codes}`）
- 获取字典数据详情（`GET /data/{dict_code}`）
- 导出字典数据列表（`POST /data/export`）
3. **功能特性**
- **用户认证与授权**：使用 `Depends` 机制来检查当前用户的权限。
- **数据验证**：利用 Pydantic 的装饰器来验证请求中的数据。
- **日志记录**：对每个操作记录相关日志，以便于审计和监控。
- **响应处理**：统一响应格式，处理成功和错误情况。
#### 总结
`dict_controller.py` 模块实现了全面的字典类型和字典数据管理功能，结合了异步数据库操作、数据验证和用户权限控制，为后端应用提供了强大的支持。通过清晰的 API 设计，应对现代 Web 应用对数据管理和操作的需求。
## [66/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/config_controller.py
### 概述文件: config_controller.py
#### 文件路径
`fastapi-backend.zip.extract/fastapi-backend/module_admin/controller/config_controller.py`
#### 目的
该文件实现了一个FastAPI控制器，用于管理系统配置，包括创建、查询、更新和删除配置项。
#### 主要功能
1. **路由设置**:
- 设置路由前缀`/system/config`，并依赖用户登录验证。
2. **接口定义**:
- **获取配置列表**:
- 路径: `/list`
- 方法: GET
- 描述: 获取系统配置的分页数据。
- **添加配置**:
- 路径: `''`
- 方法: POST
- 描述: 添加新的系统配置。
- **编辑配置**:
- 路径: `''`
- 方法: PUT
- 描述: 编辑现有系统配置。
- **刷新配置缓存**:
- 路径: `/refreshCache`
- 方法: DELETE
- 描述: 刷新系统配置的缓存。
- **删除配置**:
- 路径: `/{config_ids}`
- 方法: DELETE
- 描述: 删除指定的系统配置。
- **查询配置详情**:
- 路径: `/{config_id}`
- 方法: GET
- 描述: 获取特定配置的详细信息。
- **根据配置键查询配置**:
- 路径: `/configKey/{config_key}`
- 方法: GET
- 描述: 使用配置键获取配置。
- **导出配置列表**:
- 路径: `/export`
- 方法: POST
- 描述: 导出系统配置列表。
#### 依赖与注解
- **依赖注入**:
- 使用`Depends`实现用户身份验证和数据库会话的获取。
- **日志记录**:
- 使用`Log`注解记录操作的相关信息，包括类型和描述。
- **数据验证**:
- 使用`ValidateFields`对输入数据进行验证。
#### 返回结果
- 所有接口返回的数据均采用`ResponseUtil`进行统一处理，确保返回格式的一致性。
#### 总结
此控制器是管理系统配置的核心组件，提供了与配置相关的基本增删改查操作，并集成了用户权限检查和数据验证，确保系统的安全和数据的正确性。
## [67/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/common_controller.py
该文件 `common_controller.py` 是一个 FastAPI 控制器模块，负责处理与文件上传和下载相关的 API 请求。以下是该文件的主要功能概述：
1. **导入依赖**：
- 引入 FastAPI 的核心组件，例如 `APIRouter`, `BackgroundTasks`, `Depends`, `File`, `Query`, `Request`, `UploadFile`。
- 引入服务层处理逻辑和工具类，如 `CommonService`, `LoginService`, `logger`, `ResponseUtil`。
2. **路由设置**：
- 创建一个名为 `commonController` 的 API 路由，路径前缀为 `/common`，并依赖于 `LoginService.get_current_user` 进行用户认证。
3. **上传接口**：
- `POST /upload`：处理文件上传，接收文件并调用 `CommonService.upload_service` 方法进行上传处理。成功后记录日志，并返回上传结果。
4. **下载接口**：
- `GET /download`：处理文件下载，接收文件名和可选的删除标志，并调用 `CommonService.download_services` 进行下载处理，记录日志并返回下载结果。
5. **资源下载接口**：
- `GET /download/resource`：处理特定资源的下载，接收资源名称，并调用 `CommonService.download_resource_services`，记录日志并返回对应的下载结果。
总体而言，该控制器模块为文件操作提供了简单有效的接口，结合了认证、日志记录和统一的响应处理。
## [68/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/online_controller.py
### 概述：online_controller.py
**文件路径**: `fastapi-backend/module_admin/controller/online_controller.py`
**功能概述**:
该文件是一个FastAPI控制器，负责处理与在线用户监控相关的API请求，具体实现在线用户列表的查询和用户强制登出的功能。
**主要组成部分**:
1. **路由定义**:
- 创建了一个`APIRouter`实例`onlineController`，指定请求路径前缀为`/monitor/online`，并依赖于`LoginService.get_current_user`以确保用户已登录。
2. **API端点**:
- **GET `/list`**:
- 使用`CheckUserInterfaceAuth`依赖，确保用户有权限访问列表。
- 接受`OnlineQueryModel`请求参数，返回在线用户的分页数据。
- 调用`OnlineService.get_online_list_services`获取数据，并通过`ResponseUtil.success`返回成功响应。
- **DELETE `/{token_ids}`**:
- 强制登出在线用户，依赖`CheckUserInterfaceAuth`验证用户权限。
- 接受包含用户身份令牌的路径参数，并使用`DeleteOnlineModel`模型封装请求数据。
- 调用`OnlineService.delete_online_services`执行删除操作，记录日志。
3. **依赖和工具**:
- 使用了SQLAlchemy异步会话处理数据库连接。
- 引入了一些工具类如`logger`用于记录日志，`ResponseUtil`用于统一格式化响应，`PageResponseModel`用于返回分页信息。
**代码结构**:
- 导入所需库和模块。
- 路由器定义和API端点实现。
- 业务逻辑由服务层(`OnlineService`和`LoginService`)处理。
**总结**:
该控制器为在线用户管理提供了RESTful接口，具备基本的安全性和灵活性。通过合理的依赖注入和服务组件的使用，确保了代码的可维护性与扩展性。
## [69/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/job_controller.py
`job_controller.py` 是一个用于管理定时任务的 API 控制器，基于 FastAPI 框架实现。该文件提供多个 RESTful 接口，允许用户对定时任务及其对应的日志进行 CRUD（创建、读取、更新和删除）操作。具体功能如下：
1. **获取任务列表**：`get_system_job_list` - 获取任务分页列表。
2. **添加任务**：`add_system_job` - 创建新的定时任务。
3. **编辑任务**：`edit_system_job` - 更新现有定时任务信息。
4. **改变任务状态**：`change_system_job_status` - 更新定时任务的运行状态。
5. **执行任务**：`execute_system_job` - 手动触发某个定时任务执行。
6. **删除任务**：`delete_system_job` - 根据任务 ID 删除指定的定时任务。
7. **获取任务详情**：`query_detail_system_job` - 获取特定任务的详细信息。
8. **导出任务列表**：`export_system_job_list` - 导出当前任务数据。
9. **获取任务日志列表**：`get_system_job_log_list` - 获取定时任务日志的分页列表。
10. **清除任务日志**：`clear_system_job_log` - 删除所有任务日志。
11. **删除特定日志**：`delete_system_job_log` - 根据日志 ID 删除指定的任务日志。
12. **导出日志列表**：`export_system_job_log_list` - 导出当前日志数据。
各个接口使用依赖注入处理用户认证和数据库会话，使用 Pydantic 进行数据验证和序列化。日志记录功能和响应处理均通过工具类来实现。整体设计即符合异步编程模式，支持高并发请求，适合现代 web 应用场景。
## [70/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/role_controller.py
### 概述：角色控制器 (role_controller.py)
该文件定义了一个使用 FastAPI 框架构建的角色管理 API 路由，主要负责处理与角色相关的 CRUD 操作。下面是主要功能的概述：
#### 1. **API 路由配置**
- **前缀**: `'/system/role'`
- **身份验证**: 每个路由都依赖于 `CheckUserInterfaceAuth` 来进行权限验证，确保只有有权限的用户才能访问相应的功能。
#### 2. **主要功能**
- **获取角色部门树** (`GET /deptTree/{role_id}`): 返回指定角色关联的部门树结构。
- **获取角色列表** (`GET /list`): 支持分页查询，返回所有角色的列表。
- **新增角色** (`POST`): 创建新角色，自动记录创建时间和创建者信息。
- **编辑角色** (`PUT`): 更新已有角色的信息，并验证修改权限。
- **编辑角色数据范围** (`PUT /dataScope`): 更新角色的访问数据范围。
- **删除角色** (`DELETE /{role_ids}`): 根据角色 ID 删除指定角色，并验证权限。
- **获取角色详细信息** (`GET /{role_id}`): 查询特定角色的详细信息。
- **导出角色列表** (`POST /export`): 导出所有角色的数据。
- **更改角色状态** (`PUT /changeStatus`): 更新角色的状态，例如启用或禁用。
- **获取分配用户列表** (`GET /authUser/allocatedList`): 获取已分配给角色的用户列表。
- **获取未分配用户列表** (`GET /authUser/unallocatedList`): 获取未分配给角色的用户列表。
- **添加用户到角色** (`PUT /authUser/selectAll`): 将用户批量添加到角色中。
- **取消用户角色** (`PUT /authUser/cancel`): 从角色中取消特定用户的角色。
- **批量取消用户角色** (`PUT /authUser/cancelAll`): 批量将选定用户从角色中移除。
#### 3. **服务与依赖**
- **服务调用**: 文件中多次调用了 `RoleService` 和 `UserService` 来处理业务逻辑。
- **数据库会话**: 使用 `AsyncSession` 实现异步数据库操作，通过 `get_db` 函数获取数据库会话。
- **响应处理**: 使用 `ResponseUtil` 处理 API 响应以及返回数据。
#### 4. **注解与日志**
- **数据校验**: 使用 `ValidateFields` 装饰器对请求体进行字段验证。
- **日志记录**: 使用 `Log` 装饰器自动记录操作日志，包括标题和业务类型。
总的来说，该控制器实现了对角色管理相关操作的封装，提供了一套完善的 API 接口供前端调用，支持对角色的增删改查、权限验证和用户角色分配等操作。
## [71/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/server_controller.py
该文件 `server_controller.py` 是一个 FastAPI 控制器模块，主要用于处理与服务器监控相关的 API 请求。以下是该文件的概述：
1. **模块导入**:
- 引入了 FastAPI 框架的相关模块。
- 导入了权限验证、服务器监控的数据模型、登录服务和服务器服务，以及响应和日志工具。
2. **API 路由器**:
- 创建了一个 `APIRouter` 实例 `serverController`，设置了路径前缀为 `/monitor/server`，并依赖于获取当前用户（通过 `LoginService.get_current_user`）。
3. **获取服务器监控信息的 API**:
- 定义了一个 GET 请求的路由，路径为 `/monitor/server`，返回值模型为 `ServerMonitorModel`。
- 该路由依赖于用户权限检查（通过 `CheckUserInterfaceAuth`）。
- 异步函数 `get_monitor_server_info` 用于查询服务器监控信息，并记录日志。
4. **实现逻辑**:
- 在请求处理中，调用 `ServerService.get_server_monitor_info()` 获取服务器监控信息。
- 使用 `ResponseUtil.success` 方法将获取到的数据封装成响应返回。
整体上，该文件实现了一个用于监控服务器信息的接口，并确保了用户认证和权限控制。
## [72/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/notice_controller.py
### 概述：`notice_controller.py`
该文件定义了一个用于处理通知公告相关操作的 FastAPI 控制器。主要功能包括获取通知列表、添加、编辑、删除通知，以及获取通知详情。以下是文件的详细功能概述：
#### 1. **导入模块**
- 从多个模块中导入所需的库和方法，包括日期时间处理、FastAPI 路由器、数据库会话、请求验证以及响应构造等工具。
#### 2. **APIRouter 实例**
- 创建了一个名为 `noticeController` 的路由器，所有路由的前缀为 `/system/notice`，并依赖于用户登录验证。
#### 3. **主要路由及其功能**
- **获取通知列表**
- 路由：`GET /list`
- 功能：分页获取通知列表，返回 `PageResponseModel` 格式的数据。
- 依赖：用户权限验证（权限：`system:notice:list`）。
- **添加通知**
- 路由：`POST /`
- 功能：添加新的通知，通过调用服务层方法。
- 依赖：用户权限验证（权限：`system:notice:add`），字段验证和日志记录。
- **编辑通知**
- 路由：`PUT /`
- 功能：编辑已有的通知，更新通知信息，并日志记录。
- 依赖：用户权限验证（权限：`system:notice:edit`），字段验证和日志记录。
- **删除通知**
- 路由：`DELETE /{notice_ids}`
- 功能：删除指定 ID 的通知。
- 依赖：用户权限验证（权限：`system:notice:remove`）和日志记录。
- **获取通知详情**
- 路由：`GET /{notice_id}`
- 功能：获取指定 ID 的通知详细信息。
- 依赖：用户权限验证（权限：`system:notice:query`）。
#### 4. **工具类**
- 使用 `ResponseUtil` 来统一构建 API 响应格式。
- 采用 `logger` 记录操作日志信息，便于后续追踪。
### 总结
`notice_controller.py` 提供了一套完整的 API 接口，用于管理通知公告，确保了通过用户权限验证和数据验证来保障操作的安全性和准确性。
## [73/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/captcha_controller.py
### 概述：captcha_controller.py
**文件路径**: `fastapi-backend/module_admin/controller/captcha_controller.py`
**功能**:
该文件定义了一个名为 `captchaController` 的 FastAPI 路由器，用于处理与验证码相关的请求。
**主要组件**:
1. **依赖库**:
- `uuid` 和 `timedelta`: 生成唯一会话 ID 和设置验证码有效时间。
- `fastapi`: 框架本身，提供 API 路由功能。
- `config.enums.RedisInitKeyConfig`: 用于配置 Redis 的键。
- `module_admin.entity.vo.login_vo.CaptchaCode`: 验证码返回的数据模型。
- `module_admin.service.captcha_service.CaptchaService`: 处理验证码生成的服务。
- `utils.response_util.ResponseUtil`: 用于统一API响应格式的工具。
- `utils.log_util.logger`: 用于记录日志。
2. **路由**:
- `GET /captchaImage`:
- 处理获取验证码图片的请求。
- 检查验证码和注册用户功能是否启用，分别从Redis获取配置。
- 生成一个唯一的 `session_id` 用于关联验证码。
- 调用 `CaptchaService.create_captcha_image_service()` 创建验证码图像，并返回图像及相关信息。
- 将验证码计算结果存储在Redis中，设定为2分钟有效期。
- 使用 `ResponseUtil.success` 返回成功响应，包含验证码的相关信息。
**日志**:
- 成功生成验证码时，会记录关于会话ID的日志信息。
### 使用场景
本控制器适用于用户注册或需要验证码验证的场景，通过管理验证码生成和状态，确保用户操作的有效性和安全性。
## [74/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/dept_controller.py
该文件 `dept_controller.py` 是一个 FastAPI 控制器，专注于管理系统中的部门。它使用异步模式并结合 SQLAlchemy 进行数据库操作。以下是文件的主要功能概述：
1. **路由定义**: 使用 `APIRouter` 创建一个以 `/system/dept` 为前缀的路由模块，并引入必要的依赖项。
2. **部门列表接口**:
- `get_system_dept_tree_for_edit_option`: 获取某一部门的编辑选项 (通过部门ID排除该部门)。
- `get_system_dept_list`: 获取部门列表，支持查询参数。
3. **部门管理接口**:
- `add_system_dept`: 添加新部门，使用数据验证装饰器 `@ValidateFields`，并记录操作日志。
- `edit_system_dept`: 编辑现有部门，更新该部门的信息。
4. **部门删除接口**:
- `delete_system_dept`: 根据部门ID列表删除部门，确保只有管理员有权限执行此操作，并记录日志。
5. **部门详情查询**:
- `query_detail_system_dept`: 查询特定部门的详细信息，权限控制和数据范围验证确保安全性。
### 其他关键功能：
- **依赖注入**: 文件中的多个路由使用 `Depends` 进行依赖注入，确保适当的用户和数据库会话。
- **权限控制**: 通过 `CheckUserInterfaceAuth` 处理不同操作的权限验证。
- **日志记录**: 每个操作都记录了操作的日志，便于审计和追踪。
该控制器可更好地支持部门的 CRUD（创建、读取、更新和删除）操作，是系统管理的重要组成部分。
## [75/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/cache_controller.py
文件 `cache_controller.py` 是一个 FastAPI 控制器，处理与缓存监控相关的 API 请求。该文件定义了一组 RESTful 路由，提供缓存信息的获取和清理功能。以下是主要内容概述：
1. **导入依赖**：
- 引入 FastAPI 的核心组件、类型提示、认证和日志工具等。
2. **路由定义**：
- 使用 `APIRouter` 创建一个路由前缀为 `/monitor/cache` 的路由器，并强制依赖用户登录验证。
3. **API 路由**：
- `GET /`: 获取缓存监控统计信息，返回 `CacheMonitorModel` 类型的数据。
- `GET /getNames`: 获取所有缓存名称，返回 `CacheInfoModel` 列表。
- `GET /getKeys/{cache_name}`: 获取指定缓存名称下的所有键，返回字符串列表。
- `GET /getValue/{cache_name}/{cache_key}`: 获取特定缓存键的值，返回 `CacheInfoModel`。
- `DELETE /clearCacheName/{cache_name}`: 清除指定缓存名称的缓存。
- `DELETE /clearCacheKey/{cache_key}`: 清除指定缓存键的缓存。
- `DELETE /clearCacheAll`: 清除所有缓存。
4. **日志记录**：
- 每个路由处理函数在成功获取或操作数据时记录信息，便于调试和监控。
5. **依赖管理**：
- 每个请求都使用 `Depends` 确保用户认证，增加了安全性。
总的来说，该模块提供了管理和监控缓存的功能，含有一系列API接口，便于其他模块或用户进行缓存的查询和管理。
## [76/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/log_controller.py
### 概述文件: log_controller.py
#### 文件路径
`fastapi-backend.zip.extract/fastapi-backend/module_admin/controller/log_controller.py`
#### 简介
此模块使用FastAPI框架实现了操作日志和登录日志的管理功能，包括日志的查询、删除、清除和导出等功能。所有的操作都依赖于用户认证，确保只有授权的用户可以访问这些API端点。
#### 主要组成部分
1. **导入模块**
- 导入了FastAPI相关、SQLAlchemy异步会话、日志注解、用户认证接口、业务模型等所需的模块。
2. **APIRouter实例**
- 创建一个API路由器`logController`，其路径前缀为`/monitor`，并依赖于用户认证。
3. **API端点**
- **获取操作日志列表** (`GET /operlog/list`): 获取分页的操作日志。
- **清除操作日志** (`DELETE /operlog/clean`): 清除所有操作日志。
- **删除指定操作日志** (`DELETE /operlog/{oper_ids}`): 删除指定ID的操作日志。
- **导出操作日志** (`POST /operlog/export`): 导出操作日志为文件。
- **获取登录日志列表** (`GET /logininfor/list`): 获取分页的登录日志。
- **清除登录日志** (`DELETE /logininfor/clean`): 清除所有登录日志。
- **删除指定登录日志** (`DELETE /logininfor/{info_ids}`): 删除指定ID的登录日志。
- **解锁用户账户** (`GET /logininfor/unlock/{user_name}`): 解锁指定用户名的账户。
- **导出登录日志** (`POST /logininfor/export`): 导出登录日志为文件。
4. **依赖关系**
- 每个端点都依赖于数据库会话的注入和用户权限验证。
- 使用`ResponseUtil`来统一响应格式。
5. **日志记录**
- 通过`logger`记录操作成功的信息，以便于追踪和审计。
#### 功能总结
此控制器管理了两种类型的日志数据（操作日志和登录日志），提供了丰富的功能以支持日志的管理，增强了系统的安全性和可审计性。每个操作都与用户权限紧密结合，确保符合业务逻辑和用户授权。
## [77/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/menu_controller.py
该文件 `menu_controller.py` 负责管理菜单相关的 API 路由，主要用于一个基于 FastAPI 的系统。以下是该文件的主要功能概述：
1. **导入模块**：引入必要的库和模块，包括 FastAPI、SQLAlchemy、Pydantic 数据验证、依赖管理等。
2. **APIRouter 实例**：创建一个 `APIRouter` 实例 `menuController`，设置路由前缀为 `/system/menu`，并依赖于当前用户的身份验证。
3. **接口功能**：
- **获取菜单树**：`get_system_menu_tree` 接口返回当前用户的菜单树结构。
- **获取角色菜单树**：`get_system_role_menu_tree` 接口，根据角色 ID 返回相应的菜单树。
- **获取菜单列表**：`get_system_menu_list` 接口，返回菜单的列表，并支持查询参数。
- **添加菜单**：`add_system_menu` 接口用于添加新菜单，并记录创建和更新信息。
- **编辑菜单**：`edit_system_menu` 接口用于编辑已有菜单，更新相关信息。
- **删除菜单**：`delete_system_menu` 接口根据菜单 ID 删除指定菜单。
- **查询菜单详情**：`query_detail_system_menu` 接口根据菜单 ID 查询特定菜单的详细信息。
4. **权限控制**：多个接口使用 `CheckUserInterfaceAuth` 装饰器对用户的权限进行检查，确保只有具备相应权限的用户才能执行操作。
5. **日志记录**：为添加、编辑和删除操作添加日志记录，实现对这些操作的跟踪。
6. **返回响应**：使用 `ResponseUtil` 工具类规范化 API 的响应格式。
整体来看，该文件主要用于提供菜单管理的 API 功能，支持对菜单的增、删、改、查操作，并确保仅授权用户能够进行相关操作。
## [78/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/controller/login_controller.py
该文件 `login_controller.py` 是一个 FastAPI 后端模块，主要负责用户登录、注册和信息获取的功能。以下是该文件的概述：
### 主要功能：
1. **用户登录 (`/login`)**：
- 接收用户的登录信息（用户名、密码、验证码等）。
- 验证用户信息并生成 JWT 访问令牌。
- 将登录状态存储在 Redis，以支持会话管理。
- 支持 Swagger 文档的认证格式。
2. **获取当前用户信息 (`/getInfo`)**：
- 返回登录用户的当前信息。
3. **获取用户路由 (`/getRouters`)**：
- 根据当前用户的 ID 返回用户能够访问的路由信息。
4. **用户注册 (`/register`)**：
- 提供用户注册的功能，返回注册结果。
5. **用户登出 (`/logout`)**：
- 接收用户的注销请求，清理用户会话信息。
### 依赖模块：
- 使用异步数据库会话处理（`AsyncSession`）。
- 对接 Redis 存储会话信息。
- 引入多种服务和工具类处理业务逻辑和响应格式化（如 `LoginService`、`ResponseUtil`、`logger`）。
### 关键组件：
- **JWT 处理**：生成和验证令牌。
- **Redis 管理**：用于存储用户会话的状态。
- **依赖注入**：通过 FastAPI 的 `Depends` 机制处理请求数据和上下文。
### 日志记录：
- 通过 `logger` 记录重要操作，如登录成功、注册结果等，便于后续调试和审计。
### 潜在待完善功能：
- 有些功能（如 SMS 验证码获取和密码重置）被注释掉，可能是待实现或暂时不需要的特性。
总之，该文件实现了用户认证和管理的核心 API，为前端提供了必要的接口支持。
## [79/102] 请对下面的程序文件做一个概述: fastapi-backend/module_admin/dao/menu_dao.py
### 概述：`menu_dao.py`
这个文件是一个数据访问对象（DAO）类 `MenuDao` 的实现，它负责处理与菜单管理相关的数据库操作。使用了 SQLAlchemy 进行异步数据库交互，以支持高性能的非阻塞操作。
#### 类及其方法：
1. **MenuDao**
- 这是菜单管理模块的数据库操作层，提供多种与菜单相关的数据库操作方法。
2. **`get_menu_detail_by_id(db, menu_id)`**
- 根据菜单 ID 获取菜单的详细信息。
3. **`get_menu_detail_by_info(db, menu)`**
- 根据提供的菜单参数（如父级菜单 ID、菜单名称和类型）获取菜单信息。
4. **`get_menu_list_for_tree(db, user_id, role)`**
- 根据用户角色获取所有可用菜单的列表。若角色列表包含超级管理员角色（ID 为 1），则查询所有菜单，否则基于用户角色过滤菜单。
5. **`get_menu_list(db, page_object, user_id, role)`**
- 根据查询参数（如菜单状态和名称）获取菜单的列表信息，考虑用户角色的权限。
6. **`add_menu_dao(db, menu)`**
- 向数据库中新增菜单。
7. **`edit_menu_dao(db, menu)`**
- 编辑现有菜单数据。
8. **`delete_menu_dao(db, menu)`**
- 删除指定菜单。
9. **`has_child_by_menu_id_dao(db, menu_id)`**
- 查询特定菜单 ID 是否有子菜单，返回子菜单的数量。
10. **`check_menu_exist_role_dao(db, menu_id)`**
- 查询特定菜单 ID 是否被角色关联，返回受影响的角色数量。
#### 总结：
`menu_dao.py` 提供了异步访问数据库的功能，支持菜单的基本 CRUD（创建、读取、更新、删除）操作，并且根据用户角色来过滤菜单数据，确保了系统的灵活性和安全性。
全部 0条评论