FastAPI中端点与中间件之间的数据传递：使用request.state

admin 百科 2025-12-13 13

本文详细阐述了在fastapi应用中，如何利用`request.state`机制在http中间件和api端点之间传递请求特有的数据。通过将自定义数据（如api积分）存储在`request.state`对象上，开发者可以实现中间件在处理请求前或后访问并利用这些信息，从而构建灵活的业务逻辑，例如统一的api积分扣减或日志记录。

在构建复杂的Web服务时，经常需要在API端点中定义一些与当前请求相关的特定数据，并希望在全局的HTTP中间件中访问这些数据，以执行统一的逻辑，例如API积分扣减、权限检查或日志记录。FastAPI（基于Starlette）提供了一个优雅的解决方案，即通过request.state对象来实现端点与中间件之间的数据共享。

理解request.state

request.state是Starlette Request对象的一个属性，它是一个可变的字典状对象，允许开发者在单个请求的生命周期内存储任意的键值对数据。这意味着，任何在请求处理链中能够访问到request对象的组件（包括中间件、依赖注入函数和API端点）都可以写入或读取request.state中的数据。

实现数据传递的步骤

以下是如何利用request.state将API端点定义的积分数据传递给HTTP中间件的详细步骤。

1. 定义HTTP中间件

首先，我们需要定义一个HTTP中间件。在这个中间件中，我们将执行以下操作：

FastAPI中端点与中间件之间的数据传递：使用request.state-第2张图片-佛山资讯网

在请求被处理之前，初始化request.state中用于存储API积分的属性（例如api_credits），以确保其始终存在，并提供一个默认值（如None）。
调用call_next(request)，将请求传递给后续的路由处理或下一个中间件。
在请求处理完毕并生成响应后，从request.state.api_credits中读取由端点设置的值，并执行相应的业务逻辑（例如打印或扣减积分）。

from fastapi import FastAPI, Request
from starlette.responses import JSONResponse

app = FastAPI()

@app.middleware("http")
async def api_credit_middleware(request: Request, call_next):
    """
    HTTP中间件，用于在请求处理前后访问和处理API积分。
    """
    # 1. 在请求被处理前，初始化request.state.api_credits
    # 这样做可以确保即使端点没有设置，该属性也存在，避免AttributeError
    request.state.api_credits = None 

    # 2. 将请求传递给下一个处理者（例如API端点）
    response = await call_next(request)

    # 3. 在请求处理完毕后，从request.state中读取API积分
    if request.state.api_credits is not None:
        credits_to_deduct = request.state.api_credits
        print(f"中间件：正在处理端点 '{request.url.path}'，需扣除 {credits_to_deduct} API积分。")
        # 这里可以添加实际的积分扣减逻辑，例如更新用户数据库
        # 注意：实际扣减逻辑可能涉及异步操作和数据库事务
    else:
        print(f"中间件：端点 '{request.url.path}' 未设置API积分。")

    return response

登录后复制