Starlette如何实现中间件Middleware

风宇同学_5008

风宇同学_5008

2026-11-18

647人浏览

原创

starlette 通过依赖注入和装饰器模式实现中间件,核心机制是将每个中间件类包装成 asgi 应用,并在请求到达最终路由前依次执行。开发者只需继承 starlette.middleware.base.basehttpmiddleware 或实现标准 asgi 接口,即可在 starlette 实例中通过 add_middleware 方法注册。这些中间件按注册顺序组成调用链,请求从外向内传递,响应从内向外返回。

Starlette如何实现中间件Middleware

如何自定义一个基于 BaseHTTPMiddleware 的中间件

使用 BaseHTTPMiddleware 可以简化中间件编写,它自动处理 HTTP 请求与响应的转换。你只需要重写 dispatch 方法,在其中定义请求进入和离开时的逻辑。该基类会自动将 scope、receive 和 send 转换为标准的 Request 和 Response 对象,使代码更易于阅读和维护。

Starlette如何实现中间件Middleware

from starlette.applications import Starlette
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import Response, PlainTextResponse

class CustomHeaderMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        # 请求进入时:添加自定义头
        request.state.start_time = time.time()
        response = await call_next(request)
        # 响应离开时:添加处理时间头
        process_time = time.time() - request.state.start_time
        response.headers["X-Process-Time"] = str(process_time)
        return response

app = Starlette()
app.add_middleware(CustomHeaderMiddleware)

上述代码展示了如何创建一个记录处理时间的中间件。当请求到达时,我们记录当前时间并存储到 request.state 中。接着调用 call_next 将请求传递给下一个中间件或路由。最后,计算耗时并将其添加到响应头中返回。这种方式避免了手动处理低级别的 ASGI 协议细节。

如何实现符合 ASGI 标准的全功能中间件

如果需要更细粒度的控制或处理非 HTTP 协议(如 WebSocket),可以直接实现 ASGI 接口。这种中间件接收 scope、receive 和 send 三个参数,并返回一个可调用对象。它允许你在任何阶段修改数据流,但需要手动处理异常和生命周期管理。

Starlette 1.5.1
Starlette 1.5.1

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

下载

Starlette如何实现中间件Middleware

import asyncio
from starlette.types import Scope, Receive, Send

class SimpleASGIMiddleware:
    def __init__(self, app):
        self.app = app

    async def __call__(self, scope: Scope, receive: Receive, send: Send):
        if scope['type'] != 'http':
            await self.app(scope, receive, send)
            return

        # 预处理:例如验证 API Key
        headers = dict(scope.get('headers', []))
        api_key = headers.get(b'x-api-key')
        if not api_key:
            await send({
                'type': 'http.response.start',
                'status': 401,
                'headers': [[b'content-type', b'text/plain']],
            })
            await send({
                'type': 'http.response.body',
                'body': b'Unauthorized',
            })
            return

        # 传递给下一个应用
        await self.app(scope, receive, send)

app = Starlette()
app.add_middleware(SimpleASGIMiddleware)

这个示例展示了一个直接操作 ASGI 协议的中间件。它检查请求头中的 X-API-Key,如果缺失则直接发送 401 响应并终止流程。否则,它将控制权交给内部应用。这种写法虽然繁琐,但提供了最大的灵活性,适用于需要深度集成或处理复杂生命周期的场景。

中间件在处理 WebSocket 连接时如何处理关闭信号

在 WebSocket 场景中,中间件需要监听 websocket.disconnect 事件以清理资源。如果使用 BaseHTTPMiddleware,它仅适用于 HTTP 请求,无法处理 WebSocket。因此,对于 WebSocket 中间件,必须实现完整的 ASGI 接口,并在 __call__ 方法中捕获断开连接的事件,以便执行日志记录或资源释放操作。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

starlette

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

100

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

热门下载

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

精品课程

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