当前位置:首页 > 文章列表 > 文章 > python教程 > FastAPI怎样通过中间件捕获所有未处理异常并格式化输出?

FastAPI怎样通过中间件捕获所有未处理异常并格式化输出?

2025-07-01 20:49:35 0浏览 收藏

积累知识,胜过积蓄金银!毕竟在文章开发的过程中,会遇到各种各样的问题,往往都是一些细节知识点还没有掌握好而导致的,因此基础知识点的积累是很重要的。下面本文《FastAPI怎样通过中间件捕获所有未处理异常并格式化输出?》,就带大家讲解一下知识点,若是你对本文感兴趣,或者是想搞懂其中某个知识点,就请你继续往下看吧~

FastAPI 中间件可统一处理未捕获异常并提升 API 稳定性。1. 创建自定义中间件函数 catch_exceptions_middleware,使用 try...except 捕获 HTTPException 和其他异常;2. 注册该中间件至 FastAPI 应用;3. 对 HTTPException 返回其 detail 和 status_code,对其他异常记录日志并返回 500 响应;4. 可扩展错误响应格式,如添加 timestamp 和 path 字段;5. 异步任务中需单独处理异常,如在任务内捕获或使用 asyncio.gather;6. 使用 TestClient 编写测试用例验证异常处理逻辑是否正确。通过这些步骤实现统一、详细的错误处理机制。

FastAPI怎样通过中间件捕获所有未处理异常并格式化输出?

FastAPI 中间件可以有效地捕获未处理的异常,并以统一的格式输出,从而提升 API 的稳定性和可维护性。这主要通过自定义中间件来实现,在中间件中捕获异常,然后返回一个格式化的错误响应。

FastAPI怎样通过中间件捕获所有未处理异常并格式化输出?

解决方案

FastAPI怎样通过中间件捕获所有未处理异常并格式化输出?
  1. 创建自定义中间件:定义一个中间件类或函数,用于捕获异常。
  2. 注册中间件:将自定义中间件添加到 FastAPI 应用中。
  3. 异常处理逻辑:在中间件中,使用 try...except 块捕获异常,并格式化输出。

如何处理不同类型的异常,并提供更详细的错误信息?

在中间件中,可以针对不同类型的异常进行处理。例如,可以区分 HTTPException 和其他类型的异常。对于 HTTPException,可以直接使用其 status_codedetail 属性。对于其他异常,可以记录异常信息,并返回一个通用的错误响应。

FastAPI怎样通过中间件捕获所有未处理异常并格式化输出?
from fastapi import FastAPI, Request, HTTPException
from fastapi.responses import JSONResponse
import logging

app = FastAPI()

# 配置日志
logging.basicConfig(level=logging.ERROR)
logger = logging.getLogger(__name__)

async def catch_exceptions_middleware(request: Request, call_next):
    try:
        return await call_next(request)
    except HTTPException as e:
        return JSONResponse({"error": e.detail}, status_code=e.status_code)
    except Exception as e:
        logger.exception(f"Unhandled exception: {e}") # 记录完整的异常信息
        return JSONResponse({"error": "Internal Server Error"}, status_code=500)

app.middleware("http")(catch_exceptions_middleware)

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 0:
        raise HTTPException(status_code=400, detail="Item ID cannot be zero")
    # 模拟一个其他类型的异常
    if item_id == 1:
        raise ValueError("Invalid item ID")
    return {"item_id": item_id}

这个例子中,catch_exceptions_middleware 中间件捕获了 HTTPException 和其他类型的异常。HTTPException 直接返回其错误信息,而其他异常则记录到日志中,并返回一个通用的 "Internal Server Error" 响应。通过日志记录,可以方便地调试和排查问题。

如何避免中间件影响性能?

异常处理本身会带来一定的性能开销。为了避免中间件影响性能,应该尽量减少 try...except 块中的代码量。只在必要的地方捕获异常,避免过度使用。另外,可以使用异步操作,避免阻塞主线程。

可以考虑使用更轻量级的异常处理方式,例如,只在生产环境中启用详细的错误日志记录,而在开发环境中直接抛出异常。

如何自定义错误响应的格式?

JSONResponse 可以自定义错误响应的格式。可以根据需要,添加额外的字段,例如 timestamprequest_id 等。

from datetime import datetime

async def catch_exceptions_middleware(request: Request, call_next):
    try:
        return await call_next(request)
    except HTTPException as e:
        return JSONResponse({
            "timestamp": datetime.utcnow().isoformat(),
            "path": request.url.path,
            "error": e.detail
        }, status_code=e.status_code)
    except Exception as e:
        logger.exception(f"Unhandled exception: {e}")
        return JSONResponse({
            "timestamp": datetime.utcnow().isoformat(),
            "path": request.url.path,
            "error": "Internal Server Error"
        }, status_code=500)

在这个例子中,错误响应添加了 timestamppath 字段,提供了更详细的错误信息。datetime.utcnow().isoformat() 用于生成 UTC 时间戳,request.url.path 用于记录请求的路径。

如何处理异步任务中的异常?

如果在 FastAPI 中使用了异步任务(例如,使用 asyncio.create_task 创建的任务),需要确保这些任务中的异常也被正确处理。一种方法是在任务中使用 try...except 块,并将异常信息传递给主线程。另一种方法是使用 asyncio.gather 来运行多个任务,并捕获 asyncio.gather 抛出的异常。

import asyncio
from fastapi import BackgroundTasks

async def my_task(item_id: int):
    try:
        # 模拟一个可能抛出异常的任务
        await asyncio.sleep(1)
        if item_id == 2:
            raise ValueError("Task failed")
        print(f"Task completed for item {item_id}")
    except Exception as e:
        logger.exception(f"Task failed: {e}")

@app.post("/tasks")
async def create_task(item_id: int, background_tasks: BackgroundTasks):
    background_tasks.add_task(my_task, item_id)
    return {"message": "Task started"}

在这个例子中,my_task 函数模拟了一个可能抛出异常的异步任务。如果任务失败,异常信息会被记录到日志中。create_task 函数使用 BackgroundTasks 来启动任务,确保任务在后台运行。

如何测试中间件的异常处理?

可以使用 FastAPI 的测试客户端来测试中间件的异常处理。可以编写测试用例,模拟各种异常情况,并验证中间件是否返回了正确的错误响应。

from fastapi.testclient import TestClient

client = TestClient(app)

def test_read_item_invalid_id():
    response = client.get("/items/0")
    assert response.status_code == 400
    assert response.json() == {"error": "Item ID cannot be zero"}

def test_read_item_value_error():
    response = client.get("/items/1")
    assert response.status_code == 500
    assert "error" in response.json() # 仅仅检查error键是否存在,不检查具体内容

这些测试用例验证了 read_item 函数在不同异常情况下的行为。test_read_item_invalid_id 验证了 HTTPException 的处理,test_read_item_value_error 验证了其他类型异常的处理。

终于介绍完啦!小伙伴们,这篇关于《FastAPI怎样通过中间件捕获所有未处理异常并格式化输出?》的介绍应该让你收获多多了吧!欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识,快来关注吧!

用豆包AI解析Python中的CSV文件数据用豆包AI解析Python中的CSV文件数据
上一篇
用豆包AI解析Python中的CSV文件数据
豆包AI爆款逻辑!三步复刻百万播放量职场生存图
下一篇
豆包AI爆款逻辑!三步复刻百万播放量职场生存图
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    542次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    508次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    497次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    484次学习
查看更多
AI推荐
  • 讯飞AI大学堂免费AI认证证书:大模型工程师认证,提升您的职场竞争力
    免费AI认证证书
    科大讯飞AI大学堂推出免费大模型工程师认证,助力您掌握AI技能,提升职场竞争力。体系化学习,实战项目,权威认证,助您成为企业级大模型应用人才。
    16次使用
  • 茅茅虫AIGC检测:精准识别AI生成内容,保障学术诚信
    茅茅虫AIGC检测
    茅茅虫AIGC检测,湖南茅茅虫科技有限公司倾力打造,运用NLP技术精准识别AI生成文本,提供论文、专著等学术文本的AIGC检测服务。支持多种格式,生成可视化报告,保障您的学术诚信和内容质量。
    159次使用
  • 赛林匹克平台:科技赛事聚合,赋能AI、算力、量子计算创新
    赛林匹克平台(Challympics)
    探索赛林匹克平台Challympics,一个聚焦人工智能、算力算法、量子计算等前沿技术的赛事聚合平台。连接产学研用,助力科技创新与产业升级。
    195次使用
  • SEO  笔格AIPPT:AI智能PPT制作,免费生成,高效演示
    笔格AIPPT
    SEO 笔格AIPPT是135编辑器推出的AI智能PPT制作平台,依托DeepSeek大模型,实现智能大纲生成、一键PPT生成、AI文字优化、图像生成等功能。免费试用,提升PPT制作效率,适用于商务演示、教育培训等多种场景。
    177次使用
  • 稿定PPT:在线AI演示设计,高效PPT制作工具
    稿定PPT
    告别PPT制作难题!稿定PPT提供海量模板、AI智能生成、在线协作,助您轻松制作专业演示文稿。职场办公、教育学习、企业服务全覆盖,降本增效,释放创意!
    166次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码