starlette 的依赖注入通过 depends 类实现,核心做法是将依赖函数作为参数标记在路由处理函数中,框架会自动按声明顺序实例化并传入。开发者只需定义返回值的普通函数或类,并在路由签名中使用 depends(依赖函数),即可让 starlette 自动管理生命周期和传递数据。

如何定义和使用基础依赖函数
基础依赖函数的定义与普通 Python 函数无异,区别在于调用方使用 Depends 包装。当路由被触发时,Starlette 会先执行 Depends 中的函数,将其返回值注入到路由参数中。如果依赖函数本身也有依赖,它会递归解析直到所有依赖满足。

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route
from starlette.datastructures import State
def get_db():
# 模拟数据库连接
return {"connection": "active"}
async def homepage(request):
db = request.path_params.get("db") # 这里演示错误用法,实际应直接接收参数
# 正确方式:直接在函数签名中声明
pass
async def read_item(request, db: dict = Depends(get_db)):
# db 由 get_db 自动注入
return JSONResponse({"status": "ok", "db_connected": bool(db)})
routes = [
Route("/items/{item_id}", read_item),
]
app = Starlette(routes=routes)运行上述代码后,访问 /items/123 将返回 {"status": "ok", "db_connected": true}。注意 get_db 不需要是异步函数,除非它内部有异步操作。若 get_db 需要异步 IO,则需定义为 async def,Starlette 会自动处理协程调度。
Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。
如何处理依赖项中的状态与清理
对于需要资源清理(如关闭数据库连接)的场景,Starlette 支持依赖项返回生成器或使用 contextlib.asynccontextmanager。当依赖项是一个生成器时,yield 之前的代码在请求处理前执行,yield 之后的代码在请求处理完成后执行。这种模式常用于建立和销毁昂贵资源。

from contextlib import asynccontextmanager
from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route
@asynccontextmanager
async def get_session():
session = {"id": 1, "user": "admin"}
try:
yield session
finally:
print("Cleaning up session...") # 请求结束后执行
session.clear()
async def profile(request, session: dict = Depends(get_session)):
return JSONResponse(session)
routes = [
Route("/profile", profile),
]
app = Starlette(routes=routes)当请求 /profile 时,控制台会打印 Cleaning up session...,且返回 {"id": 1, "user": "admin"}。这种机制确保了即使请求过程中发生异常,清理逻辑也能可靠执行。依赖项的生命周期严格绑定于单个请求,请求结束即销毁。
当依赖项抛出异常时会发生什么
如果依赖项在执行过程中抛出异常,Starlette 会立即中断当前请求的处理流程,并将异常转换为相应的 HTTP 响应。例如,若依赖项验证失败抛出 HTTPException(status_code=401),客户端将收到 401 状态码,而主路由函数根本不会被调用。这使得依赖项非常适合用于前置校验,如身份认证、权限检查或输入验证。

















