starlette 定义自定义中间件的核心方式是实现一个符合 asgi 规范的 callable 对象,通常通过继承 starlette.middleware.base.basehttpmiddleware 类并重写 dispatch 方法来实现。这种方式允许你在请求到达最终应用之前或响应返回客户端之后执行逻辑,例如记录日志、修改头信息或处理异常。你需要实例化这个中间件类并将其添加到 starlette 应用的 middleware 栈中,这样每次请求都会经过该中间件的 dispatch 方法,你可以选择调用 await call_next(request) 将请求传递给下一个中间件或应用,并获取返回的 response 对象进行修改或直接返回。

如何拦截并修改请求头信息
要拦截并修改请求头,可以在 dispatch 方法中直接操作传入的 request 对象,因为 Request 实例是可变的。你可以在调用 call_next 之前向 request.headers 添加新的键值对或修改现有值,这些更改会传递给下游应用。这种方法适用于需要在后端逻辑中注入额外上下文信息的场景,比如添加追踪 ID 或认证令牌。

from starlette.applications import Starlette
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import JSONResponse
class HeaderModifierMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
# 修改请求头
request.headers['x-custom-header'] = 'modified-value'
# 继续处理请求
response = await call_next(request)
return response
app = Starlette()
app.add_middleware(HeaderModifierMiddleware)
上述代码创建了一个名为 HeaderModifierMiddleware 的中间件,它在请求进入应用前添加了 x-custom-header 头。当应用启动并接收到请求时,下游组件可以通过 request.headers.get('x-custom-header') 访问到这个修改后的值。这种修改是即时的,且不会影响原始 HTTP 请求报文,仅影响应用内部的视图。
如何捕获异常并返回统一错误格式
在 dispatch 方法中使用 try...except 块包裹 call_next 调用可以捕获下游应用抛出的任何异常。一旦捕获到异常,你可以构造一个标准的错误响应(如 JSON 格式的错误信息)并返回,而不是让异常传播导致服务器崩溃或默认的错误页面。这对于构建健壮的 API 服务非常有用,确保所有错误都以一致的格式返回给客户端。
Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

import traceback
from starlette.applications import Starlette
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import JSONResponse
class ErrorHandlerMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
try:
response = await call_next(request)
return response
except Exception as exc:
# 记录异常堆栈
print(traceback.format_exc())
# 返回统一的 JSON 错误响应
return JSONResponse(
status_code=500,
content={"error": "Internal Server Error", "detail": str(exc)}
)
app = Starlette()
app.add_middleware(ErrorHandlerMiddleware)
这段代码展示了如何在中间件中全局捕获异常。当应用内部发生未处理的异常时,ErrorHandlerMiddleware 会捕获它,打印堆栈跟踪以便调试,然后返回一个状态码为 500 的 JSON 响应。这比默认的 HTML 错误页面更适合 API 消费者解析。注意,这里我们返回的是一个新的 JSONResponse 对象,从而中断了正常的响应流程。
基于特定路径条件跳过中间件处理
虽然 BaseHTTPMiddleware 默认处理所有请求,但你可以在 dispatch 方法内部根据 request.url.path 或其他属性来决定是否执行特定逻辑或提前返回。例如,对于静态资源或健康检查端点,你可能希望跳过复杂的日志记录或身份验证逻辑以提升性能。通过在方法开头添加条件判断,可以实现细粒度的控制,避免不必要的开销。
from starlette.applications import Starlette
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import Response
class SelectiveMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
# 如果路径是 /health,直接返回 200 OK,不经过后续逻辑
if request.url.path == '/health':
return Response(status_code=200)
# 其他路径正常处理
response = await call_next(request)
return response
app = Starlette()
app.add_middleware(SelectiveMiddleware)
在这个例子中,SelectiveMiddleware 检查请求路径。如果是 /health,它立即返回一个简单的 200 响应,不调用 call_next,这意味着后续的中间件和应用程序都不会被触发。这对于优化高频调用的端点非常有效。对于其他路径,它照常传递请求并返回结果。这种模式允许开发者在不改变应用结构的情况下,灵活地控制中间件的行为范围。










