关键词 网站老王搜索引擎入口

一、概述

在FastAPI中，BaseHTTPMiddleware 类是Starlette框架提供的一个抽象基类，它允许开发者基于HTTP请求/响应接口编写ASGI中间件。
这个类对于希望实现自定义中间件逻辑的开发者来说是非常重要的工具。
通过继承 BaseHTTPMiddleware 并实现特定的方法，可以创建出符合应用需求的中间件。

二、BaseHTTPMiddleware 的核心方法

BaseHTTPMiddleware 类的核心在于它的 dispatch 方法。
当你继承 BaseHTTPMiddleware 创建一个新的中间件类时，必须重写 dispatch 方法来定义中间件的行为。

该方法接收两个参数：
request 和 call_next。
request 参数表示来自客户端的请求对象；
而 call_next 是一个异步函数，它接受请求并返回响应。
你可以在这个方法中执行任何你想要的预处理逻辑，在调用 call_next(request) 将请求传递给下一个中间件或路由处理程序之后，还可以对响应进行后处理。

三、初始化方法

如果需要为中间件类提供配置选项，比如设置某些默认行为或者传递额外参数给中间件实例，那么应当重写 init 方法。
确保第一个参数是 app，并且任何剩余参数都是可选的关键字参数。
例如，如果你想要添加身份验证逻辑到你的中间件中，可以通过构造函数传递必要的认证信息。
此外，应该在初始化过程中设置 self.app = app 以保持与父应用程序的链接。

四、示例代码

下面是一个简单的例子，展示了如何使用 BaseHTTPMiddleware 来创建一个记录请求处理时间的中间件：

import time
from fastapi import FastAPI, Request
from starlette.middleware.base import BaseHTTPMiddlewareclass ProcessTimeMiddleware(BaseHTTPMiddleware):async def dispatch(self, request: Request, call_next):start_time = time.time()response = await call_next(request)process_time = time.time() - start_timeresponse.headers['X-Process-Time'] = str(process_time)return responseapp = FastAPI()
app.add_middleware(ProcessTimeMiddleware)

这段代码首先导入了必要的模块，并定义了一个名为 ProcessTimeMiddleware 的新类，该类继承自 BaseHTTPMiddleware。然后我们实现了 dispatch 方法，在其中计算了每个请求的处理时间，并将结果作为响应头的一部分返回给客户端。最后，我们将这个中间件添加到了 FastAPI 应用实例 app 中。

五、注意事项

值得注意的是，虽然 BaseHTTPMiddleware 提供了一种简便的方式来构建中间件，但它也有一些局限性。例如，它可能会阻止对 contextlib.ContextVar 的更改向上传播，这意味着如果你在端点中设置了某个上下文变量并在中间件中尝试读取它，可能不会得到预期的结果1。因此，在选择使用 BaseHTTPMiddleware 还是直接按照 ASGI 规范实现更复杂的中间件时，应根据具体的应用场景做出权衡。

综上所述，BaseHTTPMiddleware 为开发者提供了一个强大的工具，用于快速有效地实现自定义中间件逻辑，从而增强 FastAPI 应用的功能和灵活性。