FastAPI搭建Python后台管理系统文件概述（五）
-
-
john 在知识的海洋中遨游
0 人点赞了该文章 · 534 浏览
### 文件功能概述表1
| 文件路径 | 功能描述 |
|-----------------------------------------------------|----------------------------------------------------------------------------------------|
| `fastapi-backend/app.py` | 启动 FastAPI 应用并配置必要的中间件和路由。 |
| `fastapi-backend/server.py` | 定义 FastAPI 应用的核心，设置生命周期事件和路由。 |
| `fastapi-backend/utils/pwd_util.py` | 提供密码处理方法，如密码哈希和验证。 |
| `fastapi-backend/utils/time_format_util.py` | 格式化日期时间的工具类，转换 `datetime` 对象为字符串格式。 |
| `fastapi-backend/utils/string_util.py` | 提供字符串处理方法，如检查字符串是否为空或仅包含空格。 |
| `fastapi-backend/utils/upload_util.py` | 处理文件上传逻辑，包括生成随机文件名和检查文件存在性。 |
| `fastapi-backend/utils/response_util.py` | 生成标准化的 HTTP 响应，简化成功和错误响应的构建。 |
| `fastapi-backend/utils/common_util.py` | 包含多种实用方法，如字符串格式转换和 Excel 文件操作。 |
| `fastapi-backend/utils/page_util.py` | 提供分页数据的响应模型和处理方法。 |
| `fastapi-backend/utils/message_util.py` | 处理短信验证码的发送和记录。 |
| `fastapi-backend/utils/cron_util.py` | 验证 Cron 表达式的有效性。 |
| `fastapi-backend/utils/log_util.py` | 配置并管理日志记录，包括日志输出目录和格式。 |
| `fastapi-backend/sub_applications/staticfiles.py` | 挂载静态文件目录，以支持客户端静态资源的访问。 |
| `fastapi-backend/sub_applications/handle.py` | 处理在 FastAPI 应用中处理子应用相关的挂载和设置。 |
| `fastapi-backend/exceptions/handle.py` | 定义全局异常处理器，处理不同的错误类型并返回 JSON 响应。 |
| `fastapi-backend/exceptions/exception.py` | 定义各种自定义异常类，用于表示特定的错误和警告。 |
### 文件功能概览表2
| 文件路径 | 功能描述 |
|-------------------------------------------------------------------------------|------------------------------------------------|
| `fastapi-backend/module_admin/annotation/pydantic_annotation.py` | 通过装饰器减少Pydantic模型的重复性和简化使用。 |
| `fastapi-backend/module_admin/annotation/log_annotation.py` | 提供日志记录功能，专门用于API请求的操作和诊断。 |
| `fastapi-backend/module_admin/aspect/data_scope.py` | 处理用户的数据访问权限，生成相应的查询 SQL 语句。 |
| `fastapi-backend/module_admin/aspect/interface_auth.py` | 用于接口权限的验证，检查用户的接口访问权限。 |
| `fastapi-backend/module_admin/entity/do/user_do.py` | 定义用户实体模型，包括用户相关的数据库字段。 |
| `fastapi-backend/module_admin/entity/do/post_do.py` | 定义岗位实体模型，存储系统中岗位相关的字段和属性。 |
| `fastapi-backend/module_admin/entity/do/log_do.py` | 定义系统访问记录和操作日志的实体模型。 |
| `fastapi-backend/module_admin/entity/do/role_do.py` | 定义角色实体模型，用于管理用户角色及其属性。 |
| `fastapi-backend/module_admin/entity/do/config_do.py` | 定义系统参数配置实体模型，存储各种系统配置项。 |
| `fastapi-backend/module_admin/entity/do/job_do.py` | 定义定时任务调度模型和任务执行日志模型。 |
| `fastapi-backend/module_admin/entity/do/dept_do.py` | 定义部门实体模型，管理系统中的部门信息。 |
| `fastapi-backend/module_admin/entity/do/notice_do.py` | 定义通知公告实体模型，存储系统中的公告信息。 |
| `fastapi-backend/module_admin/entity/do/dict_do.py` | 定义字典类型及字典数据模型，用于管理系统的字典信息。 |
| `fastapi-backend/module_admin/entity/do/menu_do.py` | 定义菜单实体模型，管理系统中的菜单与权限信息。 |
| `fastapi-backend/module_admin/entity/vo/notice_vo.py` | 定义通知公告的数据传输对象（VO），用于接口响应。 |
| `fastapi-backend/module_admin/entity/vo/config_vo.py` | 定义系统参数配置的数据传输对象（VO），用于接口响应。 |
### 文件功能概述表3
| 文件路径 | 功能描述 |
|------------------------------------------------|---------------------------------------------------|
| `role_vo.py` | 定义与角色管理相关的Pydantic模型。 |
| `server_vo.py` | 定义与服务器监控相关的Pydantic模型。 |
| `post_vo.py` | 定义与岗位信息相关的Pydantic模型。 |
| `log_vo.py` | 定义操作和登录日志的数据模型。 |
| `user_vo.py` | 定义与用户信息和验证相关的Pydantic模型。 |
| `dept_vo.py` | 定义与部门管理相关的Pydantic模型。 |
| `job_vo.py` | 定义与定时任务及其日志相关的Pydantic模型。 |
| `cache_vo.py` | 定义缓存监控的相关Pydantic模型。 |
| `common_vo.py` | 定义通用的响应模型，包括CRUD响应和上传响应。 |
| `login_vo.py` | 定义用户登录和注册的Pydantic模型。 |
| `menu_vo.py` | 定义与菜单管理相关的Pydantic模型。 |
| `online_vo.py` | 定义在线用户信息相关的Pydantic模型。 |
| `dict_vo.py` | 定义字典类型和字典数据的Pydantic模型。 |
| `cache_service.py` | 实现与缓存相关的服务方法，如获取和清空缓存。 |
| `job_log_service.py` | 提供对定时任务日志的管理服务，包括增、刪和查。 |
| `captcha_service.py` | 负责生成和处理验证码功能的服务。 |
### 文件功能概述表4
| 文件路径 | 功能描述 |
|------------------------------------------------------|----------------------------------------------------|
| `module_admin/service/menu_service.py` | 处理菜单的 CRUD 操作，支持菜单树的生成与验证。 |
| `module_admin/service/server_service.py` | 收集服务器监控信息，包括 CPU 和内存使用情况。 |
| `module_admin/service/job_service.py` | 管理定时任务，包括增删改查和验证任务唯一性。 |
| `module_admin/service/dept_service.py` | 提供部门管理功能，包括部门的 CRUD 操作和权限校验。 |
| `module_admin/service/dict_service.py` | 管理字典类型和字典数据，包括 CRUD 操作和数据校验。 |
| `module_admin/service/notice_service.py` | 管理通知公告，包括创建、编辑、删除和查询公告。 |
| `module_admin/service/common_service.py` | 处理文件上传和下载服务，包括基本文件管理功能。 |
| `module_admin/service/role_service.py` | 管理角色，包括角色权限的 CRUD 操作和校验。 |
| `module_admin/service/config_service.py` | 管理系统参数配置的增删改查、校验和缓存功能。 |
| `module_admin/service/login_service.py` | 处理用户登录、注册、密码重置和身份验证。 |
| `module_admin/service/user_service.py` | 用户管理，包括用户的 CRUD 操作和角色分配。 |
| `module_admin/service/online_service.py` | 管理在线用户状态，包括获取在线列表和用户踢出功能。 |
| `module_admin/service/log_service.py` | 记录和管理操作日志及登录日志，包括获取和导出功能。 |
| `module_admin/service/post_service.py` | 岗位管理服务，包括岗位的 CRUD 操作及验证。 |
| `module_admin/controller/post_controler.py` | 提供岗位管理相关的 API 接口，包括新增、修改、获取和删除操作。 |
| `module_admin/controller/user_controller.py` | 提供用户管理相关的 API 接口，包括用户的创建、更新、查询和删除。 |
### 文件功能概述表5
| 文件路径 | 功能描述 |
|-----------------------------------------------------|------------------------------------------|
| `dict_controller.py` | 提供字典类型和字典数据的管理功能，包括CRUD操作。 |
| `config_controller.py` | 管理系统配置，包括创建、查询、更新和删除配置项。 |
| `common_controller.py` | 处理文件上传和下载等通用功能。 |
| `online_controller.py` | 监控在线用户状态，并提供用户列表和强制登出功能。 |
| `job_controller.py` | 管理定时任务，包括任务的创建、查询、更新和删除功能。 |
| `role_controller.py` | 管理用户角色，包括角色的增删改查功能。 |
| `server_controller.py` | 提供服务器监控功能，获取服务器状态和性能指标。 |
| `notice_controller.py` | 管理系统通知公告，包括增删改查和获取通知详情。 |
| `captcha_controller.py` | 处理验证码的生成和验证功能。 |
| `dept_controller.py` | 管理部门信息，包括部门的增删改查功能。 |
| `cache_controller.py` | 监控和管理缓存，包括缓存信息获取和清理功能。 |
| `log_controller.py` | 记录和管理操作日志及登录日志，包括查询和清理日志。 |
| `menu_controller.py` | 管理系统菜单，包括菜单的增删改查功能。 |
| `login_controller.py` | 处理用户登录、注册及会话管理。 |
| `menu_dao.py` | 提供菜单管理相关的数据库操作接口。 |
| `job_dao.py` | 提供定时任务管理相关的数据库操作接口。 |
### 文件功能概览表6
| 文件路径 | 功能描述 |
|-----------------------------------------------------|------------------------------------------------------------|
| `fastapi-backend/module_admin/dao/user_dao.py` | 管理用户数据的增删改查操作。 |
| `fastapi-backend/module_admin/dao/post_dao.py` | 管理岗位数据的增删改查操作。 |
| `fastapi-backend/module_admin/dao/role_dao.py` | 处理角色信息的数据库操作，包括获取角色列表和角色权限管理。 |
| `fastapi-backend/module_admin/dao/dept_dao.py` | 管理部门数据的增删改查操作。 |
| `fastapi-backend/module_admin/dao/log_dao.py` | 处理操作日志与登录日志的管理，包括增删与查询。 |
| `fastapi-backend/module_admin/dao/job_log_dao.py` | 管理定时任务日志的增删与查询操作。 |
| `fastapi-backend/module_admin/dao/config_dao.py` | 管理系统参数配置的增删改查操作。 |
| `fastapi-backend/module_admin/dao/notice_dao.py` | 处理通知公告的数据库操作，包括增删改查。 |
| `fastapi-backend/module_admin/dao/dict_dao.py` | 管理字典类型和字典数据的增删改查操作。 |
| `fastapi-backend/module_admin/dao/login_dao.py` | 处理用户登录相关的数据库操作。 |
| `fastapi-backend/module_task/__init__.py` | 初始化调度任务模块。 |
| `fastapi-backend/module_task/scheduler_test.py` | 定义调度任务执行的具体逻辑。 |
| `fastapi-backend/config/constant.py` | 定义常量，包括 HTTP 状态码、消息提示等。 |
| `fastapi-backend/config/enums.py` | 定义业务操作类型和 Redis 键名的枚举。 |
| `fastapi-backend/config/database.py` | 配置数据库连接及异步会话管理。 |
| `fastapi-backend/config/get_db.py` | 提供数据库连接的上下文管理，确保会话按照请求的生命周期进行管理。 |
### 文件功能简要描述表7
| 文件路径 | 功能描述 |
|-------------------------------------------------|------------------------------------------------------------------------------------------|
| `fastapi-backend/config/env.py` | 提供应用的全局配置，包括数据库、Redis、JWT、文件上传等设置。 |
| `fastapi-backend/config/get_redis.py` | 实现与Redis数据库的异步交互，包括连接、关闭、初始化系统字典和配置缓存等功能。 |
| `fastapi-backend/config/get_scheduler.py` | 负责定时任务的调度管理，支持任务的添加、删除、查询，以及事件监听。 |
| `fastapi-backend/middlewares/gzip_middleware.py`| 添加GZip压缩中间件以减少HTTP响应体的大小，提高数据传输效率。 |
| `fastapi-backend/middlewares/handle.py` | 集中处理中间件的添加，包括CORS和GZip中间件的设置，提供灵活的配置方法。 |
| `fastapi-backend/middlewares/cors_middleware.py`| 提供CORS中间件支持，允许特定来源的跨域请求，增强前后端的通信能力。 |
全部 0条评论