FastAPI 核心机制：分页参数的实现与最佳实践

最新推荐文章于 2025-03-17 01:31:49 发布
最新推荐文章于 2025-03-17 01:31:49 发布
阅读量81 收藏
点赞数
文章标签： fastapi 前端
合集 - 2025/03(12)
1.FastAPI路由与请求处理全解：手把手打造用户管理系统 🔌 2.FastAPI路由与请求处理进阶指南：解锁企业级API开发黑科技 🔥 3.FastAPI路由：微服务架构下的路由艺术与工程实践 🌐 4.FastAPI 路径参数完全指南：从基础到高级校验实战 🚀 5.FastAPI 查询参数完全指南：从基础到高级用法 🚀 6.FastAPI 请求体参数与 Pydantic 模型完全指南：从基础到嵌套模型实战 🚀 7.FastAPI 表单参数与文件上传完全指南：从基础到高级实战 🚀 8.FastAPI Cookie 和 Header 参数完全指南：从基础到高级实战 🚀 9.FastAPI 参数别名与自动文档生成完全指南：从基础到高级实战 🚀 10.FastAPI 自定义参数验证器完全指南：从基础到高级实战 11.FastAPI 错误处理与自定义错误消息完全指南：构建健壮的 API 应用 🛠️
12. FastAPI 核心机制：分页参数的实现与最佳实践
收起

title: FastAPI 核心机制：分页参数的实现与最佳实践
date: 2025/3/13
updated: 2025/3/13
author: cmdragon

excerpt:
在构建现代Web应用程序时，分页是一个不可或缺的功能。无论是处理大量数据还是优化用户体验，分页都起到了至关重要的作用。本文将深入探讨如何在FastAPI中实现分页参数（如page、page_size以及总页数计算），并涵盖相关的核心机制、最佳实践、常见问题及解决方案。

categories:

  • 后端开发
  • FastAPI

tags:

  • FastAPI
  • 分页
  • Web开发
  • 数据库查询
  • 性能优化
  • 安全实践
  • 错误处理


扫描二维码关注或者微信搜一搜：编程智域 前端至全栈交流与成长

探索数千个预构建的 AI 应用，开启你的下一个伟大创意

1. 分页的基本概念

分页是将大量数据分割成多个小块（即“页”），以便用户或系统可以逐步加载和处理这些数据。在Web应用中，分页通常用于处理数据库查询结果、API响应等场景。常见的分页参数包括：

  • page：当前页码。
  • page_size：每页显示的数据条数。
  • total_pages：总页数。

2. FastAPI中的分页实现

在FastAPI中，分页可以通过查询参数来实现。以下是一个简单的示例，展示了如何在FastAPI中实现分页功能。

from fastapi import FastAPI, Query
from typing import List, Optional

app = FastAPI()

# 模拟数据库数据
fake_items_db = [{"item_name": f"Item {i}"} for i in range(100)]


@app.get("/items/")
async def read_items(page: int = Query(1, gt=0), page_size: int = Query(10, gt=0)):
    start = (page - 1) * page_size
    end = start + page_size
    items = fake_items_db[start:end]
    total_items = len(fake_items_db)
    total_pages = (total_items + page_size - 1) // page_size
    return {
        "items": items,
        "page": page,
        "page_size": page_size,
        "total_items": total_items,
        "total_pages": total_pages,
    }

在这个示例中，我们定义了两个查询参数page和page_size，并通过计算start和end
来获取当前页的数据。我们还计算了总页数total_pages，并将其包含在响应中。

3. 分页参数的最佳实践

3.1 参数验证

为了确保分页参数的有效性，我们需要对page和page_size进行验证。FastAPI提供了Query参数验证功能，可以轻松实现这一点。

from fastapi import Query


@app.get("/items/")
async def read_items(page: int = Query(1, gt=0), page_size: int = Query(10, gt=0, le=100)):
    # 分页逻辑
    pass

在这个示例中，我们使用gt（大于）和le（小于等于）来限制page和page_size的取值范围。如果用户提供的参数不符合要求，FastAPI会自动返回422
Validation Error。

3.2 默认值设置

为分页参数设置合理的默认值可以提升用户体验。例如，将page_size的默认值设置为10或20，可以避免用户一次性加载过多数据。

@app.get("/items/")
async def read_items(page: int = Query(1, gt=0), page_size: int = Query(10, gt=0, le=100)):
    # 分页逻辑
    pass
3.3 总页数计算

总页数的计算公式为：

total_pages = (total_items + page_size - 1) // page_size

这个公式确保了总页数的准确性，即使total_items不能被page_size整除。

4. 数据库查询中的分页

在实际应用中，分页通常与数据库查询结合使用。以下是一个使用SQLAlchemy进行分页查询的示例。

from sqlalchemy.orm import Session
from fastapi import Depends
from .database import SessionLocal


def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()


@app.get("/items/")
async def read_items(page: int = Query(1, gt=0), page_size: int = Query(10, gt=0, le=100),
                     db: Session = Depends(get_db)):
    start = (page - 1) * page_size
    items = db.query(Item).offset(start).limit(page_size).all()
    total_items = db.query(Item).count()
    total_pages = (total_items + page_size - 1) // page_size
    return {
        "items": items,
        "page": page,
        "page_size": page_size,
        "total_items": total_items,
        "total_pages": total_pages,
    }

在这个示例中，我们使用offset和limit来实现分页查询，并通过count方法获取总数据条数。

5. 分页的安全性

5.1 避免SQL注入

在使用原始SQL查询时，必须注意避免SQL注入攻击。SQLAlchemy等ORM框架已经内置了防止SQL注入的机制，但在使用原始SQL时，仍需谨慎。

from sqlalchemy.sql import text


@app.get("/items/")
async def read_items(page: int = Query(1, gt=0), page_size: int = Query(10, gt=0, le=100),
                     db: Session = Depends(get_db)):
    start = (page - 1) * page_size
    query = text("SELECT * FROM items LIMIT :limit OFFSET :offset")
    items = db.execute(query, {"limit": page_size, "offset": start}).fetchall()
    total_items = db.execute(text("SELECT COUNT(*) FROM items")).scalar()
    total_pages = (total_items + page_size - 1) // page_size
    return {
        "items": items,
        "page": page,
        "page_size": page_size,
        "total_items": total_items,
        "total_pages": total_pages,
    }

在这个示例中，我们使用参数化查询来避免SQL注入。

5.2 数据隐私

在处理敏感数据时，确保分页查询不会泄露隐私信息。例如，避免在分页查询中返回未授权的数据。

6. 性能优化

6.1 索引优化

在数据库查询中，为分页字段（如id、created_at等）创建索引可以显著提升查询性能。

CREATE INDEX idx_items_created_at ON items (created_at);
6.2 缓存

对于频繁访问的分页数据，可以使用缓存机制（如Redis）来减少数据库查询次数。

from fastapi_cache import FastAPICache
from fastapi_cache.decorator import cache


@app.get("/items/")
@cache(expire=60)
async def read_items(page: int = Query(1, gt=0), page_size: int = Query(10, gt=0, le=100)):
    # 分页逻辑
    pass

在这个示例中，我们使用fastapi-cache库来缓存分页查询结果，缓存有效期为60秒。

7. 常见错误及解决方案

7.1 422 Validation Error

当分页参数不符合验证规则时，FastAPI会返回422 Validation Error。解决方案是确保分页参数的取值范围正确，并在API文档中明确说明。

@app.get("/items/")
async def read_items(page: int = Query(1, gt=0), page_size: int = Query(10, gt=0, le=100)):
    # 分页逻辑
    pass
7.2 500 Internal Server Error

当数据库查询失败或分页逻辑出现错误时，可能会返回500 Internal Server Error。解决方案是捕获异常并返回友好的错误信息。

from fastapi import HTTPException


@app.get("/items/")
async def read_items(page: int = Query(1, gt=0), page_size: int = Query(10, gt=0, le=100),
                     db: Session = Depends(get_db)):
    try:
        start = (page - 1) * page_size
        items = db.query(Item).offset(start).limit(page_size).all()
        total_items = db.query(Item).count()
        total_pages = (total_items + page_size - 1) // page_size
        return {
            "items": items,
            "page": page,
            "page_size": page_size,
            "total_items": total_items,
            "total_pages": total_pages,
        }
    except Exception as e:
        raise HTTPException(status_code=500, detail=str(e))

在这个示例中，我们捕获了所有异常，并返回500 Internal Server Error。

8. 课后Quiz

  1. 如何避免SQL注入攻击？

    • 使用参数化查询。
    • 避免拼接SQL语句。
    • 使用ORM框架。

  2. 如何优化分页查询的性能？

    • 为分页字段创建索引。
    • 使用缓存机制。
    • 减少查询返回的字段数量。

  3. 如何处理分页参数无效的情况？

    • 使用FastAPI的Query参数验证功能。
    • 返回422 Validation Error。
    • 在API文档中明确说明参数要求。

常见报错解决方案：

  • 422 Validation Error：检查分页参数的取值范围，确保符合验证规则。
  • 500 Internal Server Error：捕获异常并返回友好的错误信息，检查数据库查询逻辑。
  • 404 Not Found：确保分页参数不会导致查询结果为空，处理边界情况。

余下文章内容请点击跳转至 个人博客页面 或者 扫码关注或者微信搜一搜：编程智域 前端至全栈交流与成长，阅读完整的文章：FastAPI 核心机制：分页参数的实现与最佳实践 | cmdragon's Blog

往期文章归档：


__EOF__

 原创作者: Amd794 转载于: https://www.cnblogs.com/Amd794/p/18769003
SBZH
关注
FastAPI依赖注入：链式调用与多级参数传递
04-05 1300
title: FastAPI依赖注入：链式调用与多级参数传递author:excerpt:FastAPI的依赖注入系统通过链式调用和多级参数传递实现组件间的解耦和复用。核心特性包括解耦性、可复用性、可测试性和声明式依赖解析。链式依赖通过多级函数调用传递参数，如电商订单处理流程中的用户认证、VIP校验和库存检查。多级参数传递模式包括垂直传递、水平聚合和动态参数传递。常见错误如422验证错误和循环引用，可通过参数验证和依赖重构解决。最佳实践包括依赖分层、参数验证、性能优化和异步支持。扫描。
fastapi发布web配置页面
sinat_35773915的博客
08-18 1367
运行应用程序。
使用FastAPI创建一个后台登录页面
追求卓越
05-28 1523
这只是一个简单的示例，用于展示如何在FastAPI中创建一个后台登录页面。可以根据自己的需求进行定制和扩展。的文件夹，并在其中添加任何所需的静态文件（例如CSS文件、图像等）。
fastapi 入门系列
qq_38195610的博客
05-09 8878
FastAPI是一个现代、快速（高性能）的Web框架，用于构建API。它基于Python 3.7+的类型提示（type hints）和异步编程（asyncio）能力，使得代码易于编写、阅读和维护。FastAPI具有自动交互式文档（基于OpenAPI规范和JSON Schema）、数据验证、依赖注入（Dependency Injection）等功能，这些功能使得API的开发速度更快、更可靠。FastAPI还支持WebSocket和GraphQL，可以轻松地扩展到更复杂的应用场景。
还在学Django! FastAPI Web 框架教程来了！
cainiao_python的博客
02-25 1303
点击上方“菜鸟学Python”，选择“星标”公众号超级无敌干货，第一时间送达！！！大家好，我是菜鸟哥！都说学Python web开发有三驾马车，其中Django, Flask应该是大家比较耳熟能详的两个著名的框架。Django大而全，很多同学觉得很重，太繁琐，而且异步高性能一直是它的短板；而flask非常小巧，容易上手，但是如果想做一个网站需要安装大量的第三方的库。现在又有第三个框架横空出世Fas...
python web框架fastapi模板渲染--Jinja2使用技巧总结
景天科技苑
02-29 3190
要了解jinja2，那么需要先理解模板的概念。模板在Python的web开发中⼴泛使⽤，它能够有效的将业务逻辑和页⾯逻辑分开，使代码可读性增强、并且更加容易理解和维护。 模板简单来说就是⼀个其中包涵占位变量表⽰动态的部分的⽂件，模板⽂件在经过动态赋值后，返回给⽤户。 jinja2是Flask作者开发的⼀个模板系统，起初是仿django模板的⼀个模板引擎，也可以为fastapi提供模板⽀持，由于其灵活，快速和安全等优点被⼴泛使⽤。
FastAPI性能优化指南：参数解析与惰性加载
03-17 1126
扫描pre=Trueorm_modeA) 使用标准json模块B) 采用orjson解析器C) 增加服务器内存：性能优化应遵循"测量-分析-优化"的循环法则。建议在实现80%基础功能后即开始建立性能基准，采用渐进式优化策略，优先解决Pareto法则中影响20%的核心性能问题。
FastAPI依赖注入：参数共享与逻辑复用
03-16 928
扫描fill:#333;color:#333;color:#333;fill:none;get_datadb_connA) 在每个路由重复定义参数B) 使用全局变量存储参数C) 通过依赖注入共享参数：优秀的依赖注入设计应遵循SOLID原则，特别是依赖倒置原则（DIP）。建议使用依赖图分析工具保持注入层次不超过5层，对高频依赖实施缓存策略，并定期进行依赖关系审计。
fastapi学习（三）：返回HTML页面
呆萌的代Ma
03-10 1万+
fastapi默认返回的是JSONResponse类型，如果需要返回HTML，可以在请求时指定返回的类型： 导包：from fastapi.responses import HTMLResponse 声明：@app.get("/hello", response_class=HTMLResponse) 即可返回HTML类型 示例代码 # -*- coding:utf-8 -*- from fastapi import FastAPI import uvicorn from fastapi.res
Python高性能web框架-FastApi教程：（16)ORM响应页面数据
程序员涛哥的博客
12-30 718
不过，这个页面有点丑，我们想做个漂亮的页面。引入一个比较喜欢的表格。
FastAPI 库（Python 的 Web 框架）基本使用指南（一）
墨鸦的博客
11-06 1万+
FastAPI 库（Python 的 Web 框架）基本使用指南（一）
3 fastAPI分页请求
wujianyouhun的专栏
02-07 917
在 FastAPI 中实现分页功能，可以结合数据库查询来返回数据的某一部分，而不是一次性加载所有数据。分页通常通过查询参数skip和limit来控制，skip用于跳过前面的记录，limit用于限制返回的记录数。下面是一个实现分页请求数据库中数据的示例，假设我们使用 SQLAlchemy 作为数据库 ORM 工具。
FastAPI学习（二）——FastAPI+Jinjia2模板渲染网页（跳转返回渲染页面）
热门推荐
weixin_43605788的博客
02-23 1万+
通过前面的学习，现在我们来看看如何渲染网页，别总是一串原始字母。 官方文档位置： https://fastapi.tiangolo.com/advanced/templates/ 首先，必须注意的是，FastAPI这个Python Web框架并没有网页模板，但是也正因为如此，它可以使用任何网页模板。 官方例子是jinjia2 于是，安装： pip install jinja2 aiofiles ...
关于“python中，fastapi访问/docs接口，页面空白或者页面缓冲慢”的问题
MITA1的博客
04-10 1608
项目中用fastapi或者其他框架搭建web服务后，运行服务器，打开http://127.0.0.1:8000/docs页面空白，但是在服务器端显示“"GET /docs HTTP/1.1" 200 OK”访问成功。浏览器端无法查看页面进行下一步的调试。
FastAPI完全指南：实现高效、安全的Web开发
Innocence_0的博客
05-26 1477
在快速发展的互联网时代，高效的Web开发变得尤为重要。Python作为一门广受欢迎的编程语言，其众多Web框架中，FastAPI凭借其出色的性能和易用性，成为了一个炙手可热的选择。FastAPI是一个用于构建API的现代、高性能的Web框架，它基于Python3.6+的类型提示，提供了快速、直观且易于学习的API开发体验。响应类型FastAPI允许你定义多种响应类型，包括JSON、HTML、纯文本等。return “文档定制FastAPI允许你自定义这些文档的一些方面，如标题、描述和版本号。
一文读懂FastAPI：Python 开发者的福音
m0_59596937的博客
12-14 4415
接下来，我们可以定义我们的接口。"}在上面的例子中，我们定义了一个GET请求的接口，路径为"/hello"。当访问这个接口时，会返回一个包含"message"字段的JSON响应。使用FastAPI可以快速、简单地开发API接口，并且利用自动生成的文档功能方便地查看接口文档。通过以上几个简单的步骤，我们可以快速上手FastAPI，并开始构建高性能的API应用。
python-web开发神器：FastAPI详细使用（简单易用）
秃了也弱了
11-04 778
官方文档的示例非常清晰明了，通过官方文档可以很容易的使用上手。
FastAPI Web框架教程 第1章 快速上手
此博客内容主要是小可日常工作中的一些问题解决的记录整理而成
04-01 3014
FastAPI 是一个。
fastapi学习思维导图
最新发布
06-25
在学习 FastAPI 时，一个清晰的学习路线和思维导图可以帮助快速掌握其核心概念和使用方法。以下是一个详细的 FastAPI 学习路线，涵盖了从基础到高级的内容，并结合了实践建议： ### 学习路线概述 #### **1. 基础知识准备** - **Python 编程基础**：FastAPI 是基于 Python 的框架，因此需要对 Python 有基本的了解，包括函数、类、模块等。 - **异步编程**：FastAPI 支持异步请求处理，理解 `async` 和 `await` 关键字是必要的 [^2]。 #### **2. 安装与环境搭建** - **安装 FastAPI 和 Uvicorn**：使用 pip 安装 FastAPI 和其推荐的 ASGI 服务器 Uvicorn： ```bash pip install fastapi uvicorn ``` - **运行第一个 FastAPI 应用**：创建一个简单的 API 并通过 Uvicorn 启动它 [^2]。 #### **3. 核心概念** - **路由（Routing）**：理解如何定义路径操作函数，以及如何使用 HTTP 方法（GET, POST 等）。 - **请求参数**：学习如何处理查询参数、路径参数、请求体等。 - **数据验证与模型**：使用 Pydantic 模型进行数据验证，确保输入数据的正确性 [^2]。 - **响应模型**：定义返回给客户端的数据结构，支持自动文档生成 [^2]。 #### **4. 中级主题** - **依赖注入系统**：FastAPI 提供了一个强大的依赖注入系统，可以用于管理认证、数据库连接等 [^2]。 - **中间件**：了解如何编写和使用中间件来处理全局逻辑，如日志记录、身份验证等。 - **后台任务**：执行非阻塞操作，例如发送电子邮件或处理文件上传后的任务 [^2]。 #### **5. 高级功能** - **安全性**：实现 JWT 认证、OAuth2 等安全机制，保护 API 接口 [^2]。 - **测试**：使用 pytest 或 unittest 对 FastAPI 应用进行单元测试和集成测试 [^2]。 - **部署**：将 FastAPI 应用部署到生产环境，选择合适的 ASGI 服务器（如 Uvicorn 或 Gunicorn），并配置反向代理（如 Nginx） [^2]。 #### **6. 实战项目** - **构建 RESTful API**：开发一个完整的 RESTful API，涵盖 CRUD 操作、分页、过滤等功能。 - **集成数据库**：使用 SQLAlchemy 或 Tortoise ORM 将 FastAPI 与数据库集成 [^2]。 - **微服务架构**：探索如何将 FastAPI 用于构建微服务，并与其他服务通信 [^2]。 ### 思维导图建议 为了更好地理解和记忆 FastAPI 的学习内容，建议绘制一个思维导图，包含以下几个主要分支： - **基础知识** - **安装与配置** - **核心功能** - **进阶功能** - **实战应用** 每个分支下可以进一步细分，例如“核心功能”可以包括路由、请求参数、数据验证等子节点。这种结构化的表示方式有助于理清思路，并方便后续复习。 ### 教程资源推荐 - **官方文档**：[FastAPI 官方文档](https://fastapi.tiangolo.com/) 是最权威的学习资源，提供了详细的指南和示例代码 [^2]。 - **在线课程**：可以参考一些高质量的在线课程，如 deeplearning.ai 的 “Deep Learning Specialization”，虽然该课程主要关注深度学习，但其中涉及的 Python 编程技巧也适用于 FastAPI 开发 [^1]。 - **社区和博客**：参与 FastAPI 社区讨论，阅读相关技术博客，获取最新的最佳实践和技术动态 [^3]。 ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值