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

如何定义基于 Pydantic 的请求模型
要使用 Pydantic 进行校验,首先需要安装 pydantic 库,然后在代码中定义继承自 pydantic.BaseModel 的类。这个类描述了期望接收到的 JSON 结构、字段类型以及可选的约束条件。在 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 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

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 的可读性,也简化了客户端的错误处理逻辑。在实际项目中,建议将这一逻辑封装为通用的工具函数或中间件,以便在所有路由中复用。

















