Starlette如何处理请求参数类型校验

梦雪姑娘_4494

梦雪姑娘_4494

2026-11-19

806人浏览

原创

starlette 本身不直接处理请求参数的类型校验,而是依赖 pydantic 库通过自定义的 request 类来实现。具体做法是创建一个继承自 starlette.requests.request 的类,并在其中定义一个名为 _data 的异步属性,该属性使用 pydantic.typeadapter 对解析后的 json 数据进行验证和转换。这样在路由函数中接收 request 对象时,访问其 .data 属性即可自动获得经过类型校验且符合预期类型的 python 对象,若数据不符合 schema 则会抛出 validationerror。

Starlette如何处理请求参数类型校验

如何配置自定义 Request 类以启用自动校验

要启用这种机制,需要定义一个包含 _data 属性的子类,并将其作为参数传递给 Route 或 APIRouter。核心在于 _data 必须是一个返回协程的异步属性,它负责读取请求体、解析 JSON 并调用 TypeAdapter.validate_python 进行校验。当路由匹配到该请求时,Starlette 会实例化这个自定义 Request 类,开发者随后可以通过 request.data 获取已校验的数据。

Starlette如何处理请求参数类型校验

import json
from starlette.requests import Request
from pydantic import TypeAdapter, ValidationError

class ValidatedRequest(Request):
    @property
    async def _data(self):
        body = await self.body()
        if not body:
            return None
        try:
            data = json.loads(body)
        except json.JSONDecodeError:
            raise ValidationError("Invalid JSON")
        # 假设我们期望一个包含 'name' (str) 和 'age' (int) 的对象
        adapter = TypeAdapter(dict)
        # 这里可以替换为具体的 Pydantic model 或更严格的 adapter
        # 为了演示通用性,这里仅做基础结构校验示例
        # 实际使用中通常传入特定的 BaseModel 子类
        validated_data = adapter.validate_python(data)
        return validated_data

# 在路由中使用
from starlette.routing import Route
from starlette.responses import JSONResponse

async def hello(request: ValidatedRequest):
    data = request.data
    name = data.get('name')
    age = data.get('age')
    return JSONResponse({"message": f"Hello {name}, you are {age}"})

routes = [
    Route('/hello', endpoint=hello, methods=['POST']),
]

校验失败时系统如何处理异常

当请求体中的数据无法通过 TypeAdapter 的校验规则时,Pydantic 会抛出 ValidationError。由于 _data 是在异步属性中执行的,这个异常会在访问 request.data 时传播出来。Starlette 默认没有全局捕获这个特定异常的中间件,因此如果不在路由层或中间件中处理,它将导致 500 Internal Server Error。通常的做法是编写一个自定义中间件或使用 Starlette 的 exception_handler 来捕获 ValidationError,并将其转换为格式化的 422 Unprocessable Entity 响应,以便前端能够理解具体的字段错误信息。

Starlette 1.5.1
Starlette 1.5.1

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

下载

Starlette如何处理请求参数类型校验

from starlette.middleware.base import BaseHTTPMiddleware
from starlette.responses import JSONResponse
from pydantic import ValidationError

class ValidationExceptionMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request, call_next):
        try:
            response = await call_next(request)
        except ValidationError as e:
            # 提取错误信息
            errors = e.errors()
            return JSONResponse(
                status_code=422,
                content={"detail": errors}
            )
        return response

# 将中间件添加到应用中
app.add_middleware(ValidationExceptionMiddleware)

TypeAdapter 与 BaseModel 在校验行为上的区别

在使用 TypeAdapter 时,它可以直接针对任意 Python 类型(如 dict, list, 甚至原生类型)进行校验,而不需要预先定义一个完整的 Pydantic Model 类。这使得它在处理动态结构或非标准输入时非常灵活。相比之下,BaseModel 要求定义一个明确的类结构,所有字段都必须有对应的类型注解。如果使用 BaseModel,校验会更严格地遵循字段定义,包括默认值处理和必填项检查。例如,对于同一个 JSON 输入,TypeAdapter(dict) 可能只校验键值对的基本类型,而 BaseModel 的子类可能会因为缺少必填字段或类型不匹配而直接拒绝整个对象。选择哪种方式取决于是否需要预定义的强类型结构以及是否希望利用 Pydantic 的字段元数据功能。

相关文章

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

594

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

796

23

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

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

2026.06.16

679

12

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

2026.11.17

0

15

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.17

0

15

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

2026.11.17

0

15

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

2026.11.17

0

10

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

2026.11.17

0

11

热门下载

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

精品课程

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