首页  思维导图  详情



 



服务端 - FastAPI架构

2026-08-25 17:37:34   0  举报





AI智能生成

FastAPI是一个现代的、快速（高性能）的Web框架，用于构建APIs，具备异步支持。它基于标准的Python类型提示，能提供自动化的交互式API文档，如基于Swagger的OpenAPI和基于ReDoc。FastAPI以其易于使用、简洁的编码风格而闻名，内置的验证和安全特性确保了代码的健壮性和安全性。此外，它兼容Docker和Kubernetes，支持自动的数据库模型创建和迁移，适合于现代微服务架构。该架构优化了开发速度和代码可读性，使得开发者能快速构建高效可靠的APIs。

fastapi

api

架构

后端

异步

模板推荐

作者其他创作

大纲/内容

基本能力

快速开发与高性能

异步支持

基于 Python async/await语法

支持高并发 I/O密集型操作

与 ASGI标准完全兼容

内置 Starlette提供异步基础

自动数据验证

基于 Pydantic模型定义

请求/响应数据的自动序列化与反序列化

提供详细的验证错误信息

支持复杂嵌套数据模型验证

类型提示与自动补全

充分利用 Python类型提示

为 IDE提供卓越的代码补全和错误检查支持

减少运行时错误，提升代码可维护性

类型声明即文档

依赖注入系统

声明式依赖定义

支持子依赖和共享依赖

自动处理依赖项的生命周期

便于测试和代码复用

路由与请求处理

路径操作装饰器

GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD

支持路径参数和查询参数

可定义操作摘要和描述

支持响应状态码自定义

请求参数解析

路径参数：类型转换与验证

查询参数：默认值、必填、多值处理

请求体：JSON、表单数据、文件上传

请求头与 Cookie的便捷访问

响应模型与状态码

使用 Pydantic模型定义响应结构

设置默认响应状态码

自定义响应模型，过滤输出字段

支持多种响应类型（JSON, HTML,文件等）

后台任务

使用 `BackgroundTasks`添加后台任务

适用于发送邮件、处理文件等无需即时响应的操作

任务在响应返回后执行

与依赖注入系统良好集成

架构流程

ASGI服务器与应用程序生命周期

ASGI协议概述

异步服务器网关接口标准

支持 WebSocket和 HTTP/2

为 FastAPI应用提供底层通信协议

与 Uvicorn, Hypercorn等服务器配合

应用启动与事件

`startup`事件：初始化数据库连接池、加载配置

`shutdown`事件：关闭连接、清理资源

通过装饰器或列表添加事件处理器

确保资源的正确初始化和释放

请求生命周期流程

中间件处理（如 CORS,日志）

路由匹配与路径操作函数调用

依赖项解析与执行

请求体解析与验证

视图函数执行与业务逻辑处理

响应模型序列化与返回

后台任务调度

依赖注入系统详解

依赖项的工作原理

可调用对象（函数、类）作为依赖项

FastAPI自动解析参数并调用

依赖项的结果可被路径操作函数和其他依赖项使用

依赖项的作用域与缓存

默认每次请求都重新执行依赖项

使用 `lru_cache`或自定义缓存实现单例/请求级缓存

注意依赖项中的状态管理

避免在依赖项中进行昂贵的重复计算

子依赖与依赖覆盖

依赖项可以拥有自己的依赖（子依赖）

形成清晰的依赖树

在测试或特定场景下可覆盖依赖项

提升代码的模块化和可测试性

依赖项与安全

结合 `OAuth2PasswordBearer`等实现认证

从请求中提取令牌、用户信息作为依赖

自动处理认证失败，返回401错误

实现基于角色的权限控制依赖

中间件

内置中间件与 Starlette中间件

CORS（跨源资源共享）

配置允许的源、方法、头部、凭证

处理预检（OPTIONS）请求

保护 API免受恶意跨域请求

GZip压缩

自动压缩响应体，减少网络传输量

可配置最小压缩长度和包含的媒体类型

提升 API响应速度，尤其对于文本数据

HTTPS重定向与信任代理

强制将 HTTP请求重定向到 HTTPS

在反向代理（如 Nginx）后正确获取客户端信息

增强应用的安全性

请求日志与性能监控

记录请求方法、路径、状态码、耗时

集成结构化日志（如 JSON格式）

便于问题排查和性能分析

可结合 Prometheus, OpenTelemetry进行指标收集

自定义中间件开发

中间件函数签名与执行顺序

接收 `request`和 `call_next`

在 `call_next`前后添加处理逻辑

中间件按照添加顺序执行

Starlette中间件与 FastAPI装饰器中间件

修改请求与响应

在 `call_next`前：读取/修改请求体、头部、路径

在 `call_next`后：读取/修改响应体、状态码、头部

注意：请求体流可能只能读取一次

使用 `request.scope`访问底层 ASGI信息

错误处理与异常捕获

在中间件中捕获路径操作函数抛出的异常

统一异常响应格式

实现全局的异常日志记录

注意不要掩盖关键的业务逻辑错误

数据库会话与事务管理

在中间件中创建数据库会话并注入请求

在请求处理后提交或回滚事务

确保每个请求拥有独立的会话

正确处理请求处理过程中的异常

权限系统

认证（Authentication）

OAuth2与 JWT集成

使用 `OAuth2PasswordBearer`流程

解析 JWT令牌并验证签名

从令牌中提取用户声明（Claims）

设置令牌过期时间与刷新机制

基于密码与 Bearer令牌的认证

用户提供用户名/密码获取访问令牌

后续请求在 `Authorization`头部携带 Bearer令牌

FastAPI自动从指定 URL提取令牌

令牌无效或过期时自动返回401

API密钥认证

在查询参数、请求头或 Cookie中传递 API Key

使用 `APIKeyHeader`, `APIKeyQuery`, `APIKeyCookie`

验证密钥的有效性（如查询数据库）

适用于机器对机器的通信场景

第三方 OAuth登录（社交登录）

集成 Google, GitHub, Facebook等 OAuth提供商

处理授权码流程，获取用户信息

在本地创建或关联用户账户

生成并返回本系统的 JWT令牌

授权（Authorization）

基于角色的访问控制（RBAC）

定义角色（如 `admin`, `user`, `guest`）

为用户或用户组分配角色

在路径操作依赖项中检查用户角色

权限不足时返回403 Forbidden错误

基于权限/资源的访问控制

定义具体的权限（如 `article:read`, `user:delete`）

将权限与角色关联，或直接赋予用户

在业务逻辑中检查用户是否拥有特定权限

实现更细粒度的访问控制

依赖项实现权限检查

创建接受当前用户（来自认证依赖）的权限依赖项

在该依赖项中执行角色或权限验证

验证失败时抛出 `HTTPException(status_code=403)`

路径操作函数只需声明依赖，逻辑简洁清晰

路径操作级别的权限覆盖

为不同路径操作设置不同的权限依赖

支持公开端点（无需认证）和受保护端点

在 OpenAPI文档中自动标记需要认证的端点

便于 API消费者理解访问要求

用户与会话管理

用户模型与数据库集成

使用 SQLAlchemy, Tortoise-ORM等定义用户模型

安全地哈希存储用户密码（如使用 passlib）

包含用户名、邮箱、角色、创建时间等字段

建立与其他业务模型的关系

登录与令牌颁发端点

提供 `/login`或 `/token`端点验证凭证

验证成功后生成 JWT访问令牌和刷新令牌

在响应中返回令牌及用户基本信息

设置适当的令牌过期策略

获取当前用户信息

创建 `get_current_user`或 `get_current_active_user`依赖项

该依赖项调用认证依赖获取令牌，并查询数据库获取完整用户对象

将用户对象注入到路径操作函数中

可扩展为 `get_current_admin_user`等特定依赖

用户注册、资料修改与密码重置

提供公开的注册端点，验证数据并创建用户

受保护的端点允许用户修改自己的资料

实现密码重置流程（通过邮件发送重置链接）

确保所有操作都有适当的验证和安全性

fastapi文档系统

自动生成的交互式 API文档

OpenAPI标准与 JSON模式

FastAPI自动从代码中提取 OpenAPI规范

核心概念与架构

FastAPI框架基础

基于 Pydantic的数据验证

定义请求/响应模型

自动生成 JSON Schema

利用 Python类型提示

异步请求处理支持

使用 `async`和 `await`

与 ASGI服务器集成

提升高并发性能

依赖注入系统

声明式依赖函数

子依赖与共享逻辑

依赖项的作用域管理

OpenAPI与 API文档

自动生成 OpenAPI规范

路径操作与参数映射

模型定义与引用

安全方案的定义

交互式 API文档界面

集成 Swagger UI

集成 ReDoc

自定义文档界面

开发与部署

项目结构与配置

应用初始化与配置

创建 FastAPI实例

配置 CORS、中间件

设置根路径与版本

路由组织与管理

使用 APIRouter

模块化路由设计

全局和局部依赖

数据验证与错误处理

请求参数验证

路径参数验证

查询参数验证

请求体参数验证

响应模型与状态码

定义响应模型

设置 HTTP状态码

自定义响应头

异常处理机制

HTTPException使用

自定义异常处理器

请求验证错误处理

安全与认证

OAuth2与 JWT集成

OAuth2密码流配置

JWT令牌的生成与验证

保护路径操作

基于角色的访问控制

依赖项实现权限检查

用户角色与权限模型

细粒度权限控制

测试与调试

编写 API测试

使用 TestClient

模拟依赖项

测试异步端点

性能分析与监控

集成日志系统

使用中间件记录请求

性能瓶颈分析

高级特性与生态

后台任务与 WebSocket

后台任务处理

使用 `BackgroundTasks`

集成 Celery任务队列

处理长时间运行任务

WebSocket实时通信

建立 WebSocket连接

双向消息传递

连接管理与状态

数据库集成

SQLAlchemy ORM集成

定义数据库模型

创建会话与依赖

执行 CRUD操作

NoSQL数据库支持

MongoDB驱动集成

Redis缓存集成

异步数据库驱动

部署与性能优化

生产环境部署

使用 Uvicorn或 Gunicorn

Docker容器化部署

云平台部署实践

性能优化策略

响应缓存机制

数据库连接池

代码与查询优化

 Collect

Get Started

服务端测试流程

 Collect

Get Started

服务端 - 后端服务架构;

 Collect

Get Started

http服务客户端

 Collect

Get Started

产品经理要了解的技术（二）服务端知识





0 条评论

下一页