fastapi之中间件

已于 2025-04-12 22:46:31 修改
阅读量2.2k 收藏 33
点赞数 19
分类专栏： FastApi 文章标签： fastapi 中间件
于 2024-08-09 16:35:25 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liudadaxuexi/article/details/141062582
版权

文章目录

中间件

在 FastAPI 中，中间件是一个功能强大的组件，用于处理请求和响应之间的各种横切关注点（cross-cutting concerns）。中间件允许你在请求被处理前后执行代码，这非常适合实现如日志记录、安全控制、数据处理和跨域资源共享（CORS）等功能。

定义

中间件是介于接收请求和发送响应之间的一个软件层。在 FastAPI 应用中，所有的请求首先经过一系列的中间件，然后才到达实际的业务逻辑处理函数；响应也会在返回给客户之前经过这些中间件。因此，中间件是处理全局任务的理想选择。

使用

在 FastAPI 中添加中间件通常涉及几个步骤，其中涉及到选择合适的中间件组件并配置其参数。以下是一个如何设置 CORS 中间件的例子，这个中间件用于允许或限制跨域请求。

示例-配置 CORS 中间件

跨源资源共享（CORS）是一个安全特性，允许或限制网页上的资源可以被另一个域名的网页访问。在 API 开发中配置 CORS 是常见需求，尤其是当你的前端和后端部署在不同的域时。

from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
import uvicorn
import os

app = FastAPI()

# 配置 CORS 中间件
app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],
    allow_credentials=True,
    allow_methods=["GET", "POST", "PUT", "DELETE"],
    allow_headers=["X-Custom-Header", "Content-Type"],
)


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


@app.post("/submit")
async def submit_form(data: dict):
    return {"received_data": data}


if __name__ == "__main__":
    uvicorn.run(
        f"{os.path.basename(__file__).split('.')[0]}:app",
        host="127.0.0.1",
        port=8000,
        reload=True,
    )

解释说明

  1. 导入依赖
  • from fastapi import FastAPI: 导入 FastAPI，用于创建 API 应用。
  • from fastapi.middleware.cors import CORSMiddleware: 导入 CORS 中间件，用于配置跨域资源共享。
  1. 应用实例

app = FastAPI(): 创建一个 FastAPI 应用实例。

  1. 添加 CORS 中间件

app.add_middleware(CORSMiddleware, ...): 将 CORS 中间件添加到应用中。这一步是配置 CORS 支持的关键。

  1. CORS 中间件参数

allow_origins: 定义哪些来源域可以访问资源。在此示例中，https://example.com 和 https://www.anotherdomain.com 被允许访问。这可以是一个具体的域名列表或 ["*"]（允许所有域）。

  • allow_credentials: 允许前端在请求中携带认证信息（如 Cookies）。这是一个布尔值。
  • allow_methods: 指定允许的 HTTP 方法，如["GET", "POST", "PUT", "DELETE"]。
    allow_headers: 允许的 HTTP 请求头列表，这里允许 X-Custom-Header 和 Content-Type。
  1. API 端点

定义了两个端点 main()和 submit_form() 来演示如何在启用了 CORS 的应用中处理请求。

测试

allow_origins=[] # 不允许任何源

在这里插入图片描述

allow_origins=["*"] # 允许任何源

在这里插入图片描述

其他中间件

自定义日志记录中间件

自定义中间件可以用来实现例如日志记录等功能，这对于调试和监控应用状态非常有用。

from fastapi import FastAPI, Request, HTTPException
from starlette.middleware.base import BaseHTTPMiddleware
from fastapi.responses import JSONResponse, PlainTextResponse
import time
import uvicorn
import os


class LoggingMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        start_time = time.time()
        response = await call_next(request)
        process_time = time.time() - start_time

        # 记录请求和响应的详细信息
        log_message = (
            f"请求方法: {request.method}\n"
            f"请求路径: {request.url.path}\n"
            f"响应状态: {response.status_code}\n"
            f"处理时间: {process_time:.4f} 秒"
        )
        print(log_message)  # 在生产环境中，可以将这些信息写入日志文件

        return response


app = FastAPI()

# 添加中间件到应用中
app.add_middleware(LoggingMiddleware)


# 使用 PlainTextResponse 返回简单文本响应
@app.get("/", response_class=PlainTextResponse)
async def read_root():
    # 可以直接返回字符串，FastAPI 会自动封装为 PlainTextResponse
    return "Hello, World!"


# 使用 JSONResponse 创建一个更复杂的 JSON 响应
@app.post("/items/", response_class=JSONResponse)
async def create_item(item: dict):
    # 检查输入是否包含必要的字段
    if "name" not in item:
        raise HTTPException(status_code=400, detail="Missing 'name' field in the item")

    # 模拟创建项目并返回包含项目信息的响应
    response_data = {"item_name": item.get("name"), "item_id": 123}
    return JSONResponse(content=response_data, status_code=201)


if __name__ == "__main__":
    uvicorn.run(
        f"{os.path.basename(__file__).split('.')[0]}:app",
        host="127.0.0.1",
        port=8000,
        reload=True,
    )

解释说明

  1. 中间件类 LoggingMiddleware:
  • 继承自 BaseHTTPMiddleware，重写 dispatch 方法来拦截请求和发送的响应。
  • 使用 call_next(request) 异步调用接下来的请求处理，这将返回一个响应对象。
  • 计算处理请求所需的时间，并构建一个包含请求方法、路径、响应状态和处理时间的日志消息。
  • 使用 print 函数打印日志信息。在实际应用中，选择使用logging 模块或外部日志服务。
  1. 添加中间件:
  • 使用 app.add_middleware(LoggingMiddleware) 将自定义中间件添加到 FastAPI 应用中。
  1. 示例端点:
  • 定义两个简单的 API 端点，read_root和 create_item，用于演示日志中间件的效果。

测试

在这里插入图片描述
在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述
在这里插入图片描述

SessionMiddleware

使用 SessionMiddleware 来管理用户会话，这对于需要追踪用户状态或者保持登录状态的应用尤为重要。

from fastapi import FastAPI, Request
from fastapi.responses import HTMLResponse
from starlette.middleware.sessions import SessionMiddleware
import uvicorn
import os

app = FastAPI()

# 设置 SessionMiddleware，secret_key 应该是一个长随机字符串
app.add_middleware(
    SessionMiddleware, secret_key="!se1cret2-ke3y-sh4ould-b5e-ve8ry-se8cure!"
)


@app.get("/", response_class=HTMLResponse)
async def read_root(request: Request):
    # 访问会话中的数据
    count = request.session.get("count", 0)
    count += 1
    request.session["count"] = count  # 更新会话数据
    return f"<html><body><h1>Visit Count: {count}</h1></body></html>"


@app.get("/reset")
async def reset_count(request: Request):
    request.session.pop("count", None)  # 重置会话数据
    return {"status": "session reset"}


@app.get("/logout")
async def logout(request: Request):
    request.session.clear()  # 清空所有会话数据
    return {"status": "logged out"}


if __name__ == "__main__":
    uvicorn.run(
        f"{os.path.basename(__file__).split('.')[0]}:app",
        host="127.0.0.1",
        port=8000,
        reload=True,
    )

功能说明

  1. 设置会话中间件：
  • 使用 SessionMiddleware 来管理会话。secret_key 用于签名和/或加密会话 cookie，确保它的安全性。
  1. 首页 (/)：
  • 显示页面访问次数。每次访问都会增加计数，这个计数保存在会话中。
  • 使用 HTMLResponse 直接返回 HTML 格式的响应。
  1. 重置计数 (/reset)：
  • 提供一个端点来重置会话中的 count 数据。这可以用于演示会话数据的修改。
  1. 注销 (/logout)：
  • 清空会话中的所有数据，模拟用户注销功能。

测试

访问次数

在这里插入图片描述

重置次数

在这里插入图片描述
在这里插入图片描述

清空会话并注销

在这里插入图片描述

TrustedHostMiddleware

使用 TrustedHostMiddleware 可以提高应用的安全性，限制哪些主机名可以访问应用。

from fastapi import FastAPI
from starlette.middleware.trustedhost import TrustedHostMiddleware

app = FastAPI()

# 添加 TrustedHostMiddleware
app.add_middleware(
    TrustedHostMiddleware,
    allowed_hosts=["example.com", "www.example.com", "*.example.com"]
)

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

功能说明

  1. 添加 TrustedHostMiddleware 中间件：
  • allowed_hosts 参数定义了可以接受请求的主机名列表。在这个例子中，允许从 example.com、www.example.com，以及任何以 example.com 结尾的子域名接受请求。
  • 可以根据需要调整这个列表来包括你的部署环境中的实际主机名。
  1. API 端点：
  • 定义了一个简单的 GET 请求处理函数 read_root，它返回一个简单的欢迎消息。

测试

在这里插入图片描述
在这里插入图片描述

与CORSMiddleware的区别

TrustedHostMiddleware
  1. 目的：
  • TrustedHostMiddleware 用于确保接收到的请求来自预定义的一组受信任的主机名。它的主要作用是防止 HTTP Host 头攻击，这种攻击可能会误导应用生成错误的链接、重定向、或被认为是不安全的请求来源。
  1. 工作原理：
  • 当一个请求被接收时，TrustedHostMiddleware 检查 HTTP 请求的 Host 头部是否在允许的主机名列表中。如果不在这个列表中，请求将被拒绝，并返回一个错误响应（通常是 400 Bad Request）。
  1. 使用场景：

适用于所有服务器端应用，特别是在面对公共互联网时，这有助于确保请求确实来自你预期的域。

CORSMiddleware
  1. 目的：
  • CORSMiddleware 旨在支持跨源资源共享 (CORS)，允许或限制网页上的资源可以被不同源（域、协议或端口）的网页访问。CORS 主要用于前端 JavaScript 代码，使其能够请求并从不同源加载资源。
  1. 工作原理：
  • CORS 策略要求在发送实际请求前，浏览器首先发送一个预检请求（使用 OPTIONS 方法），从服务器查询哪些源、哪些 HTTP 方法和头部是被允许的。如果服务器的响应表明这个跨源请求是被允许的，浏览器才会发送实际的请求。
  1. 使用场景：
  • 主要用于控制哪些外部源可以访问你的资源，通常用于 API 服务，尤其是当 API 被不同的前端应用调用时。这有助于增加资源访问的灵活性，同时确保安全控制。
对比总结
  • 安全目标不同
    • TrustedHostMiddleware 防止服务器被伪造的或不安全的 Host 头欺骗。
    • CORSMiddleware 允许服务器明确声明哪些跨域请求是合法的，主要防止未授权的跨站读取和互动。
  • 适用环境不同
    • TrustedHostMiddleware 主要用于服务器端安全防护，保护应用不受恶意请求影响。
    • CORSMiddleware 主要解决浏览器同源策略的限制，允许合法的跨源访问。
fastapi自定义中间件
ithongchou的博客
06-28 674
接收来自客户端的Request请求；# 将Request请求传回原路由。
五、Python框架篇: FastApi-中间件
donkeyboy001的博客
10-28 311
fast-api 中间件的设计
fastapi教程（五）：中间件
dangfulin的博客
07-29 2531
限流中间件：限制每个IP在特定时间窗口内的请求次数。响应时间模拟中间件：、为每个请求添加随机延迟。用于测试前端应用对不同响应时间的处理能力。可以模拟真实世界的网络延迟，帮助发现潜在的超时问题。请求ID中间件：为每个请求分配一个唯一的ID。方便跟踪和调试请求，特别是在分布式系统中。响应内容修改中间件：修改JSON响应中的特定内容。可以用于统一处理某些响应，如敏感信息脱敏。日志中间件：记录每个请求和响应的详细信息，对于调试和监控非常有用。错误处理中间件：全局捕获异常并自定义错误响应。
cors：提供跨源资源共享的Node.js中间件
最新发布
gitblog_00183的博客
03-26 752
cors：提供跨源资源共享的Node.js中间件 cors 项目地址: https://gitcode.com/gh_mirrors/cors10/cors 项目介绍 co...
FastAPI系列教程10：自定义FastAPI middleware中间件
GeekABC
10-24 7621
​​在一些情况下，我们需要对整个FastAPI应用的全部或部分路由执行一些通用的功能，例如身份验证、日志记录、错误处理等，我们可以通过自定义FastAPI middleware中间件来完成。
19.FastAPI中间件
chenhaiy的博客
02-01 3832
19.FastAPI中间件 在FastAPI中，可以通过中间件在每个请求被特定的路径操作处理之前，以及在每个响应返回之前进行处理。FastAPI中间件是一个函数，其作用为： 接收应用程序的每一个请求 可以对请求做一些事情或者执行任何需要的代码 将请求传递给应用程序的其他部分 (通过某种路径操作) 获取应用程序生产的响应 (通过某种路径操作) 对该响应进行处理或者执行任何需要的代码 返回响应 19.1定义中间件 可以使用装饰器 @app.midd
FastAPI系列教程09：常用FastAPI middleware中间件的详细使用
GeekABC
10-25 7569
在FastAPI中已经内置了Starlette大量的middleware中间件，这些中间件可以初步用于OAuth2、CORS、Gzip等功能的实现。
FastAPI学习最后一天：自定义token验证中间件
热门推荐
百锦再的博客
11-23 1万+
在这个例子中，我们在请求处理前打印了请求的URL路径，在请求处理后打印了响应的状态码。的解析和验证逻辑，但这通常不是推荐的做法，因为FastAPI的路由依赖注入系统已经提供了更简洁的方式来处理Token验证。方法中实现类似的逻辑来解析和验证Token，但这通常是不必要的，因为FastAPI的依赖注入系统已经提供了这种功能。下面是一个简单的中间件示例，它的作用是在每个请求被处理之前记录请求信息，并在请求处理之后记录响应信息。在您的中间件示例中，您手动从请求头中提取和验证了Token，因此。
FastAPI 中间件详解：实现高性能 Web 应用的完整指南和实际案例
m0_74824170的博客
12-10 606
FastAPI 的中间件系统是其强大功能的一部分，通过合理使用中间件，我们可以构建功能丰富、性能优异的 Web 应用。无论是身份验证、请求限流、CORS 控制还是日志记录，中间件都能提供有效的解决方案。希望通过本文的深入探讨，你能更好地理解和应用 FastAPI 中间件，为你的项目增光添彩。如果你有任何问题或建议，欢迎随时与我交流。
Fastapi自定义中间件动态处理多数据库连接
gewenjun13671的博客
07-21 2403
fastapi自定义中间件实现多数据库动态连接
【FastAPI】中间件
xiaodoudouer的博客
12-25 1139
FastAPI的中间件提供了一种强大的机制，允许开发者在请求被处理之前以及响应返回给客户端之前对它们进行拦截和操作。这为实现诸如日志记录、身份验证、性能监控、错误处理等功能提供了极大的灵活性。除了上述提到的功能之外，中间件还可以用于执行其他任何你想要在每次请求或响应时运行的任务。例如，你可以编写一个中间件来解析并标准化查询字符串参数，或者根据某些条件修改请求体中的内容7。总之，FastAPI中的中间件是一个非常强大且灵活的工具，
fastapi_No.14_中间件
Ethan's Blog
10-21 1094
讲述fastapi中中间件的处理流程，如何定义中间件，中间件如何使用
FastAPI 学习之路（三十）中间件
mr~li的博客
08-31 1428
fastapi 中间件的使用
Python框架篇(5):FastApi-中间件使用
weixin_68789096的博客
01-04 1581
"中间件"是一个函数,它在每个请求被特定的_路径操作_处理之前,以及在每个响应返回之前工作.它接收你的应用程序的每一个请求然后它可以对这个请求做一些事情或者执行任何需要的代码.然后它将请求传递给应用程序的其他部分 (通过某种_路径操作_).然后它获取应用程序生产的响应(通过某种_路径操作_).它可以对该响应做些什么或者执行任何需要的代码.然后它返回这个响应。
python：Fastapi - Middleware(中间件)
一名小测试
03-22 4287
简单唠一些 最近有些忙，时间不怎富裕，学习总结也落下了，今天总结了一些，咱们继续书接上文。 继上篇文章主要唠了安全性的一部分知识(后续再补一些知识)，今天主要聊下中间件。 FastAPI中的 “中间件” 是一个函数,它在每个请求被特定的路径操作处理之前，以及在每个响应返回之前工作。 中间件 中间件（英语：Middleware），又译中间件、中介层，是一类提供系统软件和应用软件之间连接、便于软件各部件之间的沟 通的软件，应用软件可以借助中间件在不同的技术架构之间共享信息与资源。 而在Fastapi
Fastapi 中间件 middleware
风吹半夏
11-12 4267
问题描述 在项目中遇到一个问题，在进行单点登录时，需要通过fastapi的middleware对存于redis的token进行刷新，但是取出request.json()后，request请求被消耗掉了，导致异步程序卡死在了await call_next(request)，最后参考了https://github.com/tiangolo/fastapi/issues/409上的解答，最终完美解决。 具体内容 要想取到request中的内容，并且call_next函数正常运行，set_body是重点，重点，重点
fastapi(十九)-中间件
vanexph的博客
03-24 3779
你可以添加中间件到你的fastapi应用程序中 “中间件”是一种函数，该函数可在每个请求由任何特定路径操作处理之前与每个请求一起使用。以及返回之前的每个响应。 它从你的应用程序中接收每个请求 然后，它可以对该请求执行某些操作或运行任何所需的代码。 然后，它传递要由应用程序其余部分处理的请求（通过某些路径操作）。 然后，它将获取应用程序生成的响应（通过某些路径操作） 它可以对响应做出响应或运行任何...
开源模型应用落地-FastAPI-助力模型交互-进阶篇-中间件（四）
没有卑微的工作，只有卑微的心态，与其抱怨，不如埋头实干
07-19 6593
学习FastAPI中高级中间件的相关内容
介绍一下 fastapi的中间件
06-11
好的，FastAPI是一款基于Python的现代Web框架，它提供了一些中间件来增强它的功能。中间件可以在请求处理前或处理后执行一些操作，例如记录日志、添加请求头、鉴权等。下面我来介绍一下FastAPI的中间件。 1. CORSMiddleware 这个中间件是用来处理跨域请求的。FastAPI自带了这个中间件，可以用来设置允许的跨域请求。使用方法如下： ```python from fastapi.middleware.cors import CORSMiddleware app = FastAPI() origins = [ "http://localhost", "http://localhost:8080", ] app.add_middleware( CORSMiddleware, allow_origins=origins, allow_credentials=True, allow_methods=["*"], allow_headers=["*"], ) ``` 2. HTTPSRedirectMiddleware 这个中间件是用来将HTTP请求重定向到HTTPS请求的。它可以强制所有HTTP请求都使用HTTPS。使用方法如下： ```python from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware app = FastAPI() app.add_middleware(HTTPSRedirectMiddleware) ``` 3. RequestIDMiddleware 这个中间件为每个请求添加一个唯一的ID，方便跟踪和调试。使用方法如下： ```python from fastapi.middleware.request_id import RequestIDMiddleware app = FastAPI() app.add_middleware(RequestIDMiddleware) ``` 4. AuthenticationMiddleware 这个中间件是用来进行用户认证的。它可以在每个请求处理前，对请求进行鉴权，确保用户有访问权限。使用方法如下： ```python from fastapi.middleware.authentication import AuthenticationMiddleware from myapp.auth import get_current_user app = FastAPI() app.add_middleware(AuthenticationMiddleware, backend=get_current_user) ``` 5. GZipMiddleware 这个中间件是用来启用Gzip压缩的。它可以将响应体进行压缩，减少数据传输量。使用方法如下： ```python from fastapi.middleware.gzip import GZipMiddleware app = FastAPI() app.add_middleware(GZipMiddleware, minimum_size=1000) ``` 以上是FastAPI中常用的一些中间件，它们可以让开发者更方便地实现一些常用的功能。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

trust Tomorrow

感谢支持！

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值