Starlette如何进行参数校验

阿芳小哥_9600

阿芳小哥_9600

2026-11-22

754人浏览

原创

starlette 本身不内置强类型的参数校验框架,而是通过依赖注入系统(dependency injection)结合第三方库如 pydantic 来实现。具体做法是在路由或视图函数中定义一个依赖项,该依赖项接收请求对象并返回经过验证的数据模型实例。如果输入数据不符合模型定义,starlette 会自动抛出 http 422 unprocessable entity 错误,从而拦截非法请求。

Starlette如何进行参数校验

如何定义基于 Pydantic 的请求模型

要使用 Pydantic 进行校验,首先需要安装 pydantic 库,然后在代码中定义继承自 pydantic.BaseModel 的类。这个类描述了期望接收到的 JSON 结构、字段类型以及可选的约束条件。在 Starlette 的路由处理函数中,将这个模型类作为依赖项注入,Starlette 会自动解析请求体并将其转换为模型实例。

Starlette如何进行参数校验

from starlette.applications import Starlette
from starlette.routing import Route
from starlette.responses import JSONResponse
from pydantic import BaseModel, Field
from typing import Optional

class UserCreate(BaseModel):
    username: str = Field(..., min_length=3)
    email: str
    age: int = Field(..., ge=0, le=150)

async def create_user(request):
    # 这里直接获取已验证的数据
    user_data = await request.json()
    try:
        user = UserCreate(**user_data)
    except Exception as e:
        return JSONResponse({"error": str(e)}, status_code=422)
    
    return JSONResponse({"message": "User created", "data": user.dict()}, status_code=201)

app = Starlette(routes=[Route("/users", create_user, methods=["POST"])])

上述代码展示了最基础的校验流程。当客户端发送 POST 请求到 /users 时,应用尝试将 JSON 数据映射到 UserCreate 模型。如果 username 长度不足 3 个字符,或者 age 超出 0 到 150 的范围,Pydantic 会抛出 ValidationError。在实际生产环境中,通常建议配合中间件或异常处理器来统一捕获这些错误,而不是在每个视图中手动 try-except。

如何处理查询参数和路径参数的校验

除了请求体,URL 中的查询参数(Query Parameters)和路径参数(Path Parameters)同样需要校验。对于查询参数,可以直接在依赖项中使用 starlette.requests.Request 对象提取,然后传入 Pydantic 模型;对于路径参数,可以在路由定义中指定类型,并在依赖项中进行二次校验或使用 FastAPI 风格的自动注入。虽然原生 Starlette 没有像 FastAPI 那样强大的自动路径参数类型转换,但可以通过自定义依赖项轻松实现类似效果。

Starlette 1.5.1
Starlette 1.5.1

Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

下载

Starlette如何进行参数校验

from starlette.requests import Request
from pydantic import BaseModel

class QueryFilter(BaseModel):
    limit: int = 10
    offset: int = 0

class PathParams(BaseModel):
    user_id: int

async def get_user(request: Request):
    # 提取路径参数
    path_params = PathParams(user_id=int(request.path_params.get('user_id', 0)))
    
    # 提取查询参数
    query_params = request.query_params
    filter_data = {
        'limit': query_params.get('limit', 10),
        'offset': query_params.get('offset', 0)
    }
    filters = QueryFilter(**filter_data)
    
    return JSONResponse({
        "user_id": path_params.user_id,
        "filters": filters.dict()
    })

# 注意:原生 Starlette 路由不支持直接在路径中绑定类型校验
# 通常需要配合中间件或在依赖项中手动转换和校验
app.add_route("/users/{user_id}", get_user)

在处理查询参数时,request.query_params 返回的是一个类似字典的对象,所有值默认都是字符串。因此,在将其传递给 Pydantic 模型之前,可能需要根据模型定义的字段类型进行预处理,或者依赖 Pydantic 的类型转换能力。Pydantic 能够自动将字符串 "10" 转换为整数 10,但如果遇到无法转换的值(如字母),则会引发校验错误。对于路径参数,由于它们也是字符串形式,同样需要在依赖项中显式转换并校验,以确保 user_id 是有效的整数且符合业务逻辑。

校验失败时如何返回标准化的错误响应

当 Pydantic 校验失败时,默认会抛出 pydantic.ValidationError。在 Starlette 应用中,如果不处理这个异常,会导致 500 Internal Server Error。为了提供友好的 API 体验,应该注册一个全局异常处理器,专门捕获 ValidationError 并将其转换为标准的 422 响应。这样可以确保所有校验错误都以一致的格式返回,便于前端或调用方解析。

from starlette.exceptions import HTTPException
from starlette.middleware.errors import ServerErrorMiddleware
from pydantic import ValidationError
import json

async def validation_exception_handler(request, exc):
    errors = []
    for error in exc.errors():
        loc = ".".join(str(x) for x in error["loc"])
        msg = error["msg"]
        errors.append({"field": loc, "message": msg})
    
    return JSONResponse(
        {"detail": errors},
        status_code=422
    )

# 注册异常处理器
app.add_middleware(ServerErrorMiddleware, handler=validation_exception_handler)
# 或者更推荐的方式是直接添加异常处理逻辑到路由层或使用 fastapi-like 的结构
# 在纯 Starlette 中,通常需要在每个路由处理函数的 try-except 块中处理,
# 或者使用中间件包装整个应用。

# 更简单的示例:在依赖项中处理
async def safe_create_user(request):
    try:
        user_data = await request.json()
        user = UserCreate(**user_data)
        return JSONResponse({"status": "ok"}, status_code=201)
    except ValidationError as e:
        return JSONResponse({"errors": e.errors()}, status_code=422)

通过这种方式,开发者可以完全控制校验失败的响应格式。例如,可以将 Pydantic 生成的嵌套错误列表展平,或者只保留关键的错误信息。这种标准化的错误响应不仅提高了 API 的可读性,也简化了客户端的错误处理逻辑。在实际项目中,建议将这一逻辑封装为通用的工具函数或中间件,以便在所有路由中复用。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

614

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

816

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

699

12

CVE-2026-114938高危漏洞修复
CVE-2026-114938高危漏洞修复

Java4Shell是OpenJDK Base64解码路径中的远程代码执行漏洞,编号CVE-2026-114938,2026年11月17日披露,官方已发布17.0.21.1、21.0.13.1等修复版本,建议优先升级 。本专题围绕Java4Shell(CVE-2026-114938)持续更新,从漏洞原理、受影响版本、受影响产品到修复与自查一站式汇总,适合Java开发、运维与安全人员快速定位风险。ARM64环境不受影响,x86-64环境请

2026.11.22

0

11

Navicat创建数据库教程
Navicat创建数据库教程

本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。

2026.11.20

20

7

Navicat入门教程大全
Navicat入门教程大全

本专题整理Navicat入门教程,从认识软件界面到开展数据库操作,介绍初次使用需要了解的知识和方法。内容兼顾连接配置、数据管理及日常使用中的疑问,方便用户按学习进度查阅,为后续实践和独立操作打好基础。

2026.11.20

20

17

Navicat数据库连接配置指南
Navicat数据库连接配置指南

从确认数据库信息到建立可用连接,本专题串联Navicat连接数据库的相关知识和操作方法。既有初次配置时需要了解的基础内容,也有连接后的检查思路,方便用户按实际需求查阅教程,逐步熟悉数据库连接的设置流程。

2026.11.20

0

10

PHP8.6数组与数据处理教程
PHP8.6数组与数据处理教程

本专题汇总PHP8.6数组与数据处理教程,涵盖CSV读取和导出、引用遍历删除、array_filter回调模式、配置键名冲突、pathinfo文件名校验、GMP大整数进制转换及UTF-8正则筛选,说明升级兼容变化、输入范围和失败处理方法。

2026.11.20

60

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程