Starlette如何定义自定义中间件

大磊小哥_2928

大磊小哥_2928

2026-11-19

674人浏览

原创

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

Starlette如何定义自定义中间件

如何拦截并修改请求头信息

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

Starlette如何定义自定义中间件

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
Starlette 1.5.1

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

下载

Starlette如何定义自定义中间件

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,这意味着后续的中间件和应用程序都不会被触发。这对于优化高频调用的端点非常有效。对于其他路径,它照常传递请求并返回结果。这种模式允许开发者在不改变应用结构的情况下,灵活地控制中间件的行为范围。

相关文章

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

20

15

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

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

2026.11.17

20

15

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

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

2026.11.17

20

15

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

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

2026.11.17

20

10

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

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

2026.11.17

20

11

热门下载

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

精品课程

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