你可以向 FastAPI 应用添加中间件.
"中间件"是一个函数,它在每个请求被特定的路径操作处理之前,以及在每个响应返回之前工作.
技术细节
如果你使用了 yield 关键字依赖, 依赖中的退出代码将在执行中间件后执行.
如果有任何后台任务(稍后记录), 它们将在执行中间件后运行.
要创建中间件你可以在函数的顶部使用装饰器 @app.middleware("http").
中间件参数接收如下参数:
import time
from fastapi import FastAPI, Request
app = FastAPI()
@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
start_time = time.time()
response = await call_next(request)
process_time = time.time() - start_time
response.headers["X-Process-Time"] = str(process_time)
return response
Tip
请记住可以 用'X-' 前缀添加专有自定义请求头.
但是如果你想让浏览器中的客户端看到你的自定义请求头, 你需要把它们加到 CORS 配置 (CORS (Cross-Origin Resource Sharing)) 的 expose_headers 参数中,在 Starlette's CORS docs文档中.
技术细节
你也可以使用 from starlette.requests import Request.
FastAPI 为了开发者方便提供了该对象. 但其实它直接来自于 Starlette.
在任何路径操作收到request前,可以添加要和请求一起运行的代码.
也可以在响应生成但是返回之前添加代码.
例如你可以添加自定义请求头 X-Process-Time 包含以秒为单位的接收请求和生成响应的时间:
import time
from fastapi import FastAPI, Request
app = FastAPI()
@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
start_time = time.time()
response = await call_next(request)
process_time = time.time() - start_time
response.headers["X-Process-Time"] = str(process_time)
return response
你可以稍后在 Advanced User Guide: Advanced Middleware阅读更多关于中间件的教程.
你将在下一节中学习如何使用中间件处理 CORS .