是否有一种 FastAPI 方法可以全局访问当前请求数据？

Question

在 FastAPI 框架内：

虽然请求数据当然可以作为参数传递，但我想知道函数是否可以在不传递参数的情况下访问有关当前请求的信息。

免责声明：我认为全局访问请求数据不是一个好的做法，但我有一个用例，如果能够做到这一点会非常好。

Answer 1

我通常会使用生产者-消费者样式的消息队列来执行此操作。我有一个 example repo 展示了我如何使用全局队列将数据从 post 请求推送到 WebSocket，然后将其广播给客户端。

虽然这可能不是您的确切用例，但您应该能够对其进行调整以适应。

它的核心是一个将数据推送到队列的通知程序 class：

async def push(self, msg: str):
    await self.channel.default_exchange.publish(
        Message(msg.encode("ascii")),
        routing_key=self.queue_name,
    )

而在消费者方面，我有一个 _notify 函数，它从队列接收消息并通过 WebSocket 发送消息：

async def _notify(self, message: IncomingMessage):
    living_connections = []
    while len(self.connections) > 0:
        websocket = self.connections.pop()
        await websocket.send_text(f"{message.body}")
        living_connections.append(websocket)
    self.connections = living_connections

Answer 2

您可以 get/set 来自 Starlette request.state 的任意属性。

https://www.starlette.io/requests/#other-state

详细解释和实现请参考以下问题：

https://github.com/tiangolo/fastapi/issues/633

Answer 3

你可以用小星星Request

例如：

from starlette.requests import Request
from fastapi import FastApi

app = FastApi()
@app.get('/')
def get(request:Request):
    requests_header = request.headers
    return "Hi"

Answer 4

提供的解决方案 here 定义了一个上下文管理器，您可以全局访问它。对于每个请求，您都在提取相关信息（如 headers）并将其传递给上下文管理器。

因为 fastapi 是用 Starlette, you can use the library starlette-context 构建的。它正在创建一个 context object ，您可以在不将其作为参数传递的情况下使用。主要警告是您仍然需要向所有路由传递请求 object。

编辑：在 starlette-context==0.3.0 中添加了新的中间件。 Starlette 团队开始劝阻 (here) 使用他们的 BaseHTTPMiddleware，特别是 StreamingResponse/FileResponse 端点。您可能想使用 RawContextMiddleware，它也不需要请求 object，但它是实验性的，因为 Starlette 中没有用于编写没有接口的自定义中间件的文档。但它似乎有效。

此库中的示例代码用于说明：

import uvicorn
from fastapi import FastAPI
from starlette.requests import Request
from starlette.responses import JSONResponse
from starlette.middleware import Middleware

from starlette_context import context, plugins
from starlette_context.middleware import ContextMiddleware

middleware = [
    Middleware(
        ContextMiddleware,
        plugins=(
            plugins.RequestIdPlugin(),
            plugins.CorrelationIdPlugin()
        )
    )
]

app = FastAPI(debug=True, middleware=middleware)


@app.route('/')
async def index(request: Request):  # This argument is still needed here
    return JSONResponse(context.data)  # Your context data


uvicorn.run(app, host="0.0.0.0")

是否有一种 FastAPI 方法可以全局访问当前请求数据？

Is there a FastAPI way to access current Request data globally?

fastapi