是否有FastAPI方式可以全局访问当前的请求数据?

时间:2019-07-25 14:34:52

标签: fastapi

在FastAPI框架内:

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

免责声明:我不认为全局访问请求数据是一种好习惯,但是我有一个用例,可以很好地做到这一点。

4 个答案:

答案 0 :(得分:6)

here提供的解决方案定义了一个上下文管理器,您可以全局访问该上下文管理器。对于每个请求,您都将提取相关信息(如标头)并将其传递给上下文管理器。

由于fastapi是使用Starlette构建的,因此可以使用库starlette-context。它正在创建一个context对象,您可以使用该对象而无需将其作为参数传递。主要警告是您仍然需要将请求对象传递到所有路线。

编辑:在starlette-context==0.3.0中添加了新的中间件。 Starlette团队开始劝阻(here)使用BaseHTTPMiddleware,尤其是StreamingResponse / FileResponse端点。您可能想使用RawContextMiddleware,它也不需要请求对象,但是它是实验性的,因为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")

答案 1 :(得分:0)

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

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

它的胆量是一个将数据推送到队列的通告程序类:

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

答案 2 :(得分:0)

您可以在request.state上获得/设置任意属性

有关详细说明和实现,请参阅以下问题:

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

答案 3 :(得分:-2)

您可以使用星号Request

例如:

from starlette.requests import Request
from fastapi import FastApi

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