FastAPI中间件

前言

中间件是一个函数,它的每个请求被特定的路径操作处理之前运行,同时也会在每个响应返回之前运行。

  • 它会接收每一个发送到你的应用程序的请求
  • 然后它可以对这个请求进行操作,或者运行一些必要的代码。
  • 接着它将请求传递给应用程序的其余部分(由某个路径操作处理)。
  • 然后它会接收由应用程序(由某个路径操作生成的)响应。
  • 它可以对这个响应进行操作,或者运行一些必要的代码。
  • 最后返回响应。

总的来看,中间件的执行可以划分为以下几个阶段:

  • 1.请求阶段:中间件按添加顺序依次处理请求。

  • 2.路由处理:请求到达对应路径操作函数。

  • 3.响应阶段:中间件按相反顺序处理响应。

    请求 ->[中间件1 -> 中间件2 -> 路由处理 -> 中间件2 -> 中间件1] -> 响应

中间件是包裹在应用程序周围的层,可以拦截所有传入的请求和传出的响应。中间件按添加的顺序执行(请求从外到内,响应从内到外)

其适应场景如下:

  • 全局认证(如 JWT 验证)
  • 请求日志记录
  • 添加自定义响应头
  • 异常处理
  • 限流或缓存

内置中间件

FastAPI 内置了一下常用中间件,例如:CORS 中间件

python 复制代码
import uvicorn
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware

app = FastAPI()

app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],  # 允许的源
    allow_methods=["*"],  # 允许的 HTTP 方法
    allow_headers=["*"]  # 允许的请求头
)


@app.get("/")
async def index():
    return {"Hello World"}


if __name__ == '__main__':
    uvicorn.run(app="main:app", port=8000)

HTTPS 重定向中间件

复制代码
from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware

app.add_middleware(HTTPSRedirectMiddleware)  # 强制所有请求使用 HTTPS

创建中间件

除了内置的,我们还可以自定义中间件。要创建中间件,你需要在函数上方使用装饰器 @app.middleware("http")

中间件函数接收以下参数:

  • 请求(request)。
  • 一个函数 call_next,它会将请求作为参数。
  • 这个函数会将请求传递给对应的路径操作。
  • 然后它返回由对应的路径操作生成的响应。
  • 你可以在返回之前进一步修改响应
python 复制代码
import uvicorn
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.perf_counter()
    response = await call_next(request)
    process_time = time.perf_counter() - start_time
    response.headers["X-Process-Time"] = str(process_time)
    return response


@app.get("/")
async def index():
    return {"message": "Hello World"}


if __name__ == '__main__':
    uvicorn.run(app="main:app", port=8000)

上述代码案例在响应请求头中增加了参数 X-Process-Time,处理请求并生成响应所花费的时间(单位:秒)

自定一个认证中间件

中间件可以用于通过检查认证头部来保护路由

阻止未授权请求

python 复制代码
import uvicorn
from fastapi import FastAPI
from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
from starlette.requests import Request
from starlette.responses import Response

app = FastAPI()


class AuthMiddleware(BaseHTTPMiddleware):

    async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -> Response:
        api_key = request.headers.get("X-API-KEY")
        if api_key != "secret-key":
            return Response("Unauthorized", status_code=401)
        response = await call_next(request)
        return response


app.add_middleware(AuthMiddleware)


@app.get("/secret-data")
async def index():
    return {"message": "You accessed protected data!"}


if __name__ == '__main__':
    uvicorn.run(app="main:app", port=8000)
  • 中间件会检查请求头部的 X-API-KEY
  • 如果缺失或不正确,会返回 401 Unauthorized


注意事项

  1. 避免在中间件中执行耗时操作(如同步阻塞)
  2. 中间件的异常会直接返回给客户端,不会被 FastAPI 的异常处理器捕获(除非手动处理)
  3. 中间件无法直接使用 FastAPI 的依赖注入。
相关推荐
冷崖2 小时前
消息队列-前言
中间件
dangfulin9 小时前
fastapi+sqlalchemy实现一对一、一对多、多对多关系数据操作
fastapi
玄同76512 小时前
LangChain v1.0 中间件深度解析:从 Callback 到 Middleware 的演进
人工智能·语言模型·自然语言处理·中间件·langchain·agent·智能体
龙腾AI白云13 小时前
【基于Transformer的人工智能模型搭建与fine-tuning】
scikit-learn·fastapi
小邓吖1 天前
自己做了一个工具网站
前端·分布式·后端·中间件·架构·golang
Prince-Peng1 天前
技术架构系列 - 详解Redis
数据结构·数据库·redis·分布式·缓存·中间件·架构
叼奶嘴的超人1 天前
手动创建Docker版Fastapi CI/CD镜像文件
ci/cd·docker·fastapi
regret~1 天前
【笔记】Ant Design+FastAPI 项目 Linux 服务器内网部署完整笔记
服务器·笔记·fastapi
regret~1 天前
【笔记】Ant Design(含Umi Max)+FastAPI 内网部署&接口代理 核心笔记
笔记·fastapi
全栈测试笔记2 天前
FastAPI系列(12):响应模型参数
开发语言·python·fastapi