中间件

    “中间件”是一个函数,它在每个请求被特定的路径操作处理之前,以及在每个响应返回之前工作.

    • 它接收你的应用程序的每一个请求.
    • 然后它可以对这个请求做一些事情或者执行任何需要的代码.
    • 然后它将请求传递给应用程序的其他部分 (通过某种路径操作).
    • 然后它获取应用程序生产的响应 (通过某种路径操作).
    • 它可以对该响应做些什么或者执行任何需要的代码.

    技术细节

    如果你使用了 yield 关键字依赖, 依赖中的退出代码将在执行中间件后执行.

    如果有任何后台任务(稍后记录), 它们将在执行中间件后运行.

    要创建中间件你可以在函数的顶部使用装饰器 @app.middleware("http").

    • request.
    • 一个函数 call_next 它将接收 request 作为参数.
      • 这个函数将 request 传递给相应的 路径操作.
      • 然后它将返回由相应的路径操作生成的 response.
    • 然后你可以在返回 response 前进一步修改它.

    Tip

    请记住可以 添加专有自定义请求头.

    但是如果你想让浏览器中的客户端看到你的自定义请求头, 你需要把它们加到 CORS 配置 (CORS (Cross-Origin Resource Sharing)) 的 参数中,在 文档中.

    技术细节

    你也可以使用 from starlette.requests import Request.

    在任何路径操作收到request前,可以添加要和请求一起运行的代码.

    也可以在响应生成但是返回之前添加代码.

    例如你可以添加自定义请求头 X-Process-Time 包含以秒为单位的接收请求和生成响应的时间:

    1. import time
    3. from fastapi import FastAPI, Request
    7. @app.middleware("http")
    8. async def add_process_time_header(request: Request, call_next):
    9.     start_time = time.time()
    10.     response = await call_next(request)
    11.     process_time = time.time() - start_time

    其他中间件

    你可以稍后在 Advanced User Guide: Advanced Middleware阅读更多关于中间件的教程.

    你将在下一节中学习如何使用中间件处理 CORS .