python系列：FASTAPI系列 19返回异常处理 & FASTAPI系列 20-异常处理器exception_handler

已于 2024-06-04 13:04:57 修改
阅读量1.3k 收藏 19
点赞数 28
CC 4.0 BY-SA版权
分类专栏： # python 文章标签： python fastapi 开发语言
于 2024-06-03 19:54:44 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_54626591/article/details/139423102
python 专栏收录该内容
332 篇文章 ¥99.90 ¥299.90
订阅专栏

FASTAPI系列 19返回异常处理 & FASTAPI系列 20-异常处理器exception_handler



一、 FASTAPI系列 19返回异常处理

前言

某些情况下，需要向客户端返回错误提示。这里所谓的客户端包括前端浏览器、其他应用程序、物联网设备等。需要向客户端返回错误提示的场景主要如下：

  • 遇到这些情况时，通常要返回 4XX（400 至 499）HTTP 状态码。

  • 4XX 状态码与表示请求成功的 2XX（200 至 299） HTTP 状态码类似。只不过，4XX 状态码表示客户端发生的错误。

一、使用 HTTPException

向客户端返回 HTTP 错误响应，可以使用 HTTPException。

from fastapi import FastAPI, HTTPException

app = FastAPI()

person= {
了解本专栏 订阅专栏 解锁全文
Python面试宝典：Python中与FastApi相关的面试笔试题（1000加面试笔试题助你轻松捕获大厂Offer）
今晚打老虎的专栏
05-28 585
python中与FastApi相关的知识和面试笔试题
FastApi-异常处理(6)
Python进阶专栏《爬虫实战进阶》，《Pyppeteer从入门到精通》原创作者
01-21 648
本文是该专栏的第6篇，后面会持续分享FastApi以及项目实战的各种干货知识。通常情况下，当请求参数不符合规范时，我们需要对请求异常进行处理，返回相应的状态码和提示。这样方便用户快速知道哪里的参数出错，能及时找出解决方法。而本文，笔者将针对FastApi的异常情况以及出现异常的解决方法，进行详细介绍。（附带完整代码）
FastAPI 异常处理：处理 HTTP 错误、自定义全局异常和覆盖请求校验异常
敲代码别忘了喝上一杯凉白开。
01-14 1603
异常处理是构建健壮 FastAPI 应用的关键要素。本文深入探讨了如何处理常见的 HTTP 错误、如何自定义全局异常处理器以及如何覆盖默认的请求验证异常处理。通过具体示例，您将学会如何使用 `HTTPException` 处理 API 错误，如何创建自定义异常及其处理器，以及如何在 FastAPI 中覆盖 `RequestValidationError` 和 `HTTPException`。掌握这些技巧，能帮助您提升 API 的稳定性与用户体验。
FastAPI系列教程11：Exception异常处理体系详解
GeekABC
10-26 6207
为了在FastAPI应用中友好地向endpoint用户传递异常信息，FastAPI使用HTTPException类、exception_handler装饰器以及middlerware中间件对用户代码中的Exception进行包装呈现。
Python框架篇(4):FastApi-错误处理
weixin_68789096的博客
01-03 1858
新建包app/errors，并新增文件""" 自定义参数验证异常错误"""# 这里response.ResponseFail是上篇文章中的内容在包""" 统一注册自定义错误处理器"""# 注册参数验证错误,并覆盖模式RequestValidationError新建包app/errors，并新增文件"""自定义处理HTTPException"""# 处理404错误content=jsonable_encoder(response.ResponseFail("接口路由不存在~")),
FastAPI 异常处理
2501_90353350的博客
05-27 861
添加自定义处理器，要使用Starlette 的异常工具。假设要触发的自定义异常叫作 UnicornException。且需要 FastAPI 实现全局处理该异常。"""自定义异常类-用户不存在异常"""detail = "用户不存在""""自定义异常处理器 - 用户不存在:return:""""000","111"# 用户不存在创建项目目录结构commons包下的exceptions.py"""全局的请求参数校验异常:return:"""
fastApi笔记13-异常处理
梦忆安凉的博客
03-07 1137
fastApi 异常处理
四、Python框架篇: FastApi-错误处理
donkeyboy001的博客
10-23 1156
"""自定义处理HTTPException"""# 处理404错误content=jsonable_encoder(HttpResponse.ResponseFail("接口路由不存在~")),# 处理405错误content=jsonable_encoder(HttpResponse.ResponseFail("请求方式错误，请查看文档确认~")),else:"""自定义全局系统错误"""
FO: Will watch for changes in these directories: ['E:\\python\\Python313\\fastapi\\ORM系统'] INFO: Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit) INFO: Started reloader process [8364] using StatReload INFO: Started server process [12812] INFO: Waiting for application startup. INFO: Application startup complete. INFO: 127.0.0.1:63944 - "GET /docs HTTP/1.1" 200 OK INFO: 127.0.0.1:63944 - "GET /openapi.json HTTP/1.1" 200 OK INFO: 127.0.0.1:63944 - "GET /student/ HTTP/1.1" 500 Internal Server Error ERROR: Exception in ASGI application Traceback (most recent call last): File "E:\python\Python313\fastapi\.venv\Lib\site-packages\uvicorn\protocols\http\h11_impl.py", line 403, in run_asgi result = await app( # type: ignore[func-returns-value] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ self.scope, self.receive, self.send ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ) ^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\uvicorn\middleware\proxy_headers.py", line 60, in __call__ return await self.app(scope, receive, send) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\fastapi\applications.py", line 1054, in __call__ await super().__call__(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\applications.py", line 112, in __call__ await self.middleware_stack(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\middleware\errors.py", line 187, in __call__ raise exc File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\middleware\errors.py", line 165, in __call__ await self.app(scope, receive, _send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\middleware\exceptions.py", line 62, in __call__ await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\_exception_handler.py", line 53, in wrapped_app raise exc File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\_exception_handler.py", line 42, in wrapped_app await app(scope, receive, sender) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 714, in __call__ await self.middleware_stack(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 734, in app await route.handle(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 288, in handle await self.app(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 76, in app await wrap_app_handling_exceptions(app, request)(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\_exception_handler.py", line 53, in wrapped_app raise exc File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\_exception_handler.py", line 42, in wrapped_app await app(scope, receive, sender) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 73, in app response = await f(request) ^^^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\fastapi\routing.py", line 301, in app raw_response = await run_endpoint_function( ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ...<3 lines>... ) ^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\fastapi\routing.py", line 212, in run_endpoint_function return await dependant.call(**values) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\ORM系统\api\students.py", line 26, in get_all_students stu1 = await Students.filter(sno__gt=2003) ~~~~~~~~~~~~~~~^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\models.py", line 1323, in filter return cls._meta.manager.get_queryset().filter(*args, **kwargs) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\manager.py", line 19, in get_queryset return QuerySet(self._model) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\queryset.py", line 337, in __init__ super().__init__(model) ~~~~~~~~~~~~~~~~^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\queryset.py", line 99, in __init__ self.capabilities: Capabilities = model._meta.db.capabilities ^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\models.py", line 280, in db raise ConfigurationError( f"default_connection for the model {self._model} cannot be None" ) tortoise.exceptions.ConfigurationError: default_connection for the model <class 'ORM系统.models.Students'> cannot be None
06-30
我们正在解决FastAPI应用在访问学生接口时出现的500内部服务器错误，具体错误信息是“TortoiseORM500Internal ServerError:default_connection forthe modelcannot beNone”。这个错误通常意味着Tortoise ORM在尝试...
PS F:\Programmer\python\new_my_AI> cd backend PS F:\Programmer\python\new_my_AI\backend> ls 目录: F:\Programmer\python\new_my_AI\backend Mode LastWriteTime Length Name ---- ------------- ------ ---- d----- 2025/11/5 17:53 models d----- 2025/11/6 9:59 routers d----- 2025/11/5 18:36 schemas -a---- 2025/11/5 17:59 325 .env -a---- 2025/11/5 17:58 888 config.py -a---- 2025/11/5 17:54 1035 database.py -a---- 2025/11/5 17:39 540 dependencies.py -a---- 2025/10/19 19:45 1838 install_deps.bat -a---- 2025/11/5 17:57 4108 jwt_handler.py -a---- 2025/11/5 17:16 1280 logger_setup.py -a---- 2025/11/5 17:45 1023 main.py -a---- 2025/10/19 18:58 283 requirements.txt PS F:\Programmer\python\new_my_AI\backend> cd models PS F:\Programmer\python\new_my_AI\backend\models> ls 目录: F:\Programmer\python\new_my_AI\backend\models Mode LastWriteTime Length Name ---- ------------- ------ ---- -a---- 2025/11/5 17:53 1978 chat.py -a---- 2025/11/5 17:51 733 department.py -a---- 2025/11/5 17:52 2417 post.py -a---- 2025/11/5 17:53 398 search.py -a---- 2025/11/5 17:51 1378 user.py -a---- 2025/11/5 17:50 544 __init__.py PS F:\Programmer\python\new_my_AI\backend\models> cd .. PS F:\Programmer\python\new_my_AI\backend> cd routers PS F:\Programmer\python\new_my_AI\backend\routers> ls 目录: F:\Programmer\python\new_my_AI\backend\routers Mode LastWriteTime Length Name ---- ------------- ------ ---- -a---- 2025/11/5 17:20 2979 api_chat.py -a---- 2025/11/5 17:43 1447 auth.py -a---- 2025/11/5 17:45 1677 chat_rooms.py -a---- 2025/11/5 17:44 2349 comments.py -a---- 2025/11/5 17:44 1097 departments.py -a---- 2025/11/5 17:47 751 posts.py -a---- 2025/11/5 17:45 1602 search.py -a---- 2025/11/6 9:59 0 __init__.py PS F:\Programmer\python\new_my_AI\backend\routers> cd .. PS F:\Programmer\python\new_my_AI\backend> cd schemas PS F:\Programmer\python\new_my_AI\backend\schemas> ls 目录: F:\Programmer\python\new_my_AI\backend\schemas Mode LastWriteTime Length Name ---- ------------- ------ ---- -a---- 2025/11/5 18:03 435 auth.py -a---- 2025/11/5 18:02 951 chat.py -a---- 2025/11/5 18:01 587 comment.py -a---- 2025/11/5 18:36 3777 common.py -a---- 2025/11/5 17:42 481 post.py -a---- 2025/11/5 17:41 100 user.py PS F:\Programmer\python\new_my_AI\backend\schemas> 这是我现在的项目结构 # backend/database.py from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession, async_sessionmaker from sqlmodel import SQLModel from contextlib import asynccontextmanager from config import settings import asyncio # 从 models 包导入所有表模型 from models import * # 创建引擎 engine = create_async_engine( settings.DATABASE_URL, echo=settings.DEBUG, pool_pre_ping=True ) AsyncSessionLocal = async_sessionmaker( bind=engine, class_=AsyncSession, expire_on_commit=False ) @asynccontextmanager async def get_db(): async with AsyncSessionLocal() as session: try: yield session await session.commit() except Exception: await session.rollback() raise async def create_tables(): async with engine.begin() as conn: await conn.run_sync(SQLModel.metadata.create_all) print("✅ 所有数据库表已创建完成！") async def close_db(): await engine.dispose() # backend/dependencies.py from fastapi import Depends, HTTPException from sqlalchemy import select from database import User, get_db from jwt_handler import get_current_user_id async def get_current_active_user(user_id: str = Depends(get_current_user_id)): async with get_db() as db: result = await db.execute(select(User).where(User.id == int(user_id))) user = result.scalar_one_or_none() if not user: raise HTTPException(status_code=404, detail="用户不存在") return user # backend/jwt_handler.py from datetime import datetime, timedelta, timezone from pathlib import Path from typing import Optional import os from dotenv import load_dotenv from fastapi import Cookie, Depends, HTTPException from jose import jwt, JWTError from passlib.hash import pbkdf2_sha256 from pydantic import BaseModel from config import settings # 使用统一配置 from logger_setup import app_logger as logger # ==================== 模型定义 ==================== class TokenData(BaseModel): user_id: Optional[str] = None # ==================== 密码工具 ==================== def get_password_hash(password: str) -> str: """ 使用 PBKDF2-SHA256 对密码进行哈希。 默认 rounds=29000，安全性高，适合用户密码存储。 """ return pbkdf2_sha256.hash(password) def verify_password(plain_password: str, hashed_password: str) -> bool: """ 校验明文密码是否匹配哈希值。 Passlib 会自动识别 salt 和 rounds。 """ return pbkdf2_sha256.verify(plain_password, hashed_password) # ==================== JWT 工具函数 ==================== def create_access_token(data: dict, expires_delta: Optional[timedelta] = None) -> str: """ 创建 JWT 访问令牌 :param data: 要编码的数据，建议包含 {"sub": "user_id"} :param expires_delta: 可选的过期时间偏移量 :return: 编码后的 JWT 字符串 """ to_encode = data.copy() expire = datetime.now(timezone.utc) + ( expires_delta if expires_delta else timedelta(minutes=settings.ACCESS_TOKEN_EXPIRE_MINUTES) ) to_encode.update({"exp": expire}) encoded_jwt = jwt.encode(to_encode, settings.SECRET_KEY, algorithm=settings.ALGORITHM) logger.info(f"✅ JWT 已生成，有效期至: {expire}") return encoded_jwt def decode_access_token(token: str) -> Optional[dict]: """ 【同步】解码 JWT 并返回 payload（可用于中间件、日志等非 await 上下文） :param token: JWT 字符串 :return: 解码后的 payload 或 None（无效/过期） """ try: payload = jwt.decode(token, settings.SECRET_KEY, algorithms=[settings.ALGORITHM]) logger.debug(f"🔍 JWT 成功解码: {payload}") return payload except JWTError as e: logger.warning(f"❌ JWT 解码失败 (JWTError): {e}") return None except Exception as e: logger.error(f"❌ 意外错误解码 JWT: {e}") return None # ==================== FastAPI 依赖项 ==================== async def get_current_user_id(access_token: str = Cookie(None)) -> str: """ FastAPI 依赖：从 HttpOnly Cookie 提取用户 ID 若未登录或 token 无效，抛出 401 错误 :return: 用户 ID（字符串） """ if not access_token: logger.warning("🚫 请求缺少 access_token") raise HTTPException(status_code=401, detail="未登录") payload = decode_access_token(access_token) if not payload: logger.warning("⚠️ 无法解析 JWT payload") raise HTTPException(status_code=401, detail="凭证无效") user_id: str = payload.get("sub") if not user_id: logger.warning("⚠️ JWT 中缺少 'sub' 字段") raise HTTPException(status_code=401, detail="凭证不完整") logger.info(f"👤 当前用户已认证: user_id={user_id}") return user_id async def get_current_active_user(user_id: str = Depends(get_current_user_id)): """ 扩展依赖：根据 user_id 查询数据库中的活跃用户对象 （可在此处添加封禁检查、角色权限判断等） """ from database import get_user_by_id user = await get_user_by_id(int(user_id)) if not user: logger.warning(f"❌ 用户不存在: user_id={user_id}") raise HTTPException(status_code=404, detail="用户不存在") if user.role == "banned": raise HTTPException(status_code=403, detail="该账户已被封禁") return user # backend/logger_setup.py import logging import os from logging.handlers import RotatingFileHandler, TimedRotatingFileHandler from pathlib import Path from config import BASE_DIR LOG_DIR = BASE_DIR.parent / "logs" LOG_DIR.mkdir(exist_ok=True) def setup_logger(): logger = logging.getLogger("chat_app") logger.setLevel(logging.INFO) # 防止重复添加 handler if logger.handlers: return logger # 格式 formatter = logging.Formatter( '%(asctime)s | %(levelname)s | %(name)s | %(funcName)s() | %(message)s', datefmt='%Y-%m-%d %H:%M:%S' ) # 1. 按时间切割的日志文件（每天一个） file_handler = TimedRotatingFileHandler( LOG_DIR / "app.log", when="midnight", interval=1, backupCount=7, # 保留最近7天 encoding='utf-8' ) file_handler.setFormatter(formatter) file_handler.setLevel(logging.INFO) # 2. 控制台输出 console_handler = logging.StreamHandler() console_handler.setFormatter(formatter) console_handler.setLevel(logging.INFO) # 添加到 logger logger.addHandler(file_handler) logger.addHandler(console_handler) return logger app_logger = setup_logger() # backend/main.py from fastapi import FastAPI from fastapi.staticfiles import StaticFiles from config import FRONTEND_DIR from logger_setup import app_logger as logger from routers import auth, posts, comments, departments, search, chat_rooms app = FastAPI(title="AI社交平台", version="1.0") @app.middleware("http") async def log_requests(request, call_next): logger.info(f"➡️ {request.method} {request.url.path} | IP: {request.client.host}") response = await call_next(request) logger.info(f"⬅️ Status: {response.status_code}") return response app.mount("/static", StaticFiles(directory=str(FRONTEND_DIR / "static")), name="static") app.include_router(auth.router) app.include_router(posts.router) app.include_router(comments.router) app.include_router(departments.router) app.include_router(search.router) app.include_router(chat_rooms.router) if __name__ == "__main__": import uvicorn uvicorn.run("main:app", host="127.0.0.1", port=8000, reload=True) 整理一下，把缺失的部分补全
最新发布
11-07
你已经搭建了一个结构清晰、模块化良好的 FastAPI 项目，整体架构非常合理。但根据你的目录和代码来看，**确实存在一些缺失或不一致的部分**，比如： - `database.py` 中 `from models import *` 无法导入具体模型...
fastapi入门五处理异常
舌尖上的蛋炒饭的博客
12-07 781
fastapi入门五处理异常 """ @File : fastapiOne.py @Desciption： """ import uvicorn from fastapi import FastAPI, HTTPException, Query app = FastAPI() people_id_str = {"1": "2"} people_id_int = [1, 2, 3, 4, 5] @app.post("/fastapi/{people_idone}") async def po
python异常总结
03-05
python异常总结，包括常见的AssertionError、KeyError、TypeError、ValueError等Python异常
FASTAPI系列 20-异常处理器exception_handler
lzq599220的博客
04-11 1424
通常我们可以通过 raise 抛出一个 HTTPException 异常，请求参数不合法会抛出RequestValidationError 异常，这是最常见的2种异常。FastAPI 调用的就是 RequestValidationError 类，因此，如果在 response_model 中使用 Pydantic 模型，且数据有错误时，在日志中就会看到这个错误。但客户端或用户看不到这个错误。反之，客户端接收到的是 HTTP 状态码为 500 的「内部服务器错误」。
FastAPI 学习之路（十九）处理错误/异常
mr~li的博客
08-29 2378
异常处理
fastapi 实践（二）异常捕获
cliffordl的专栏
03-12 1070
创建自定义异常类，并在全局或局部异常处理器中处理它们。status_code=500 # 或其他适当的HTTP状态码。
FastAPI从入门到实战（12）——错误处理
欢迎自九陌而来的你做客九陌斋！
12-03 2880
错误提示是非常重要的，比如权限控制、资源控制等场景，需要服务器返回给用户错误提示，包括状态码和提示等内容，所以本文就主要记录FastAPI里的错误处理相关的内容
FASTAPI系列 19返回异常处理
lzq599220的博客
04-09 1142
某些情况下，需要向客户端返回错误提示。这里所谓的客户端包括前端浏览器、其他应用程序、物联网设备等。遇到这些情况时，通常要返回 4XX（400 至 499）HTTP 状态码。4XX 状态码与表示请求成功的 2XX（200 至 299） HTTP 状态码类似。只不过，4XX 状态码表示客户端发生的错误。本文介绍了在FastAPI应用中如何通过使用HTTPException来实现对客户端的异常返回处理，以应对特定的错误场景。
FastAPI学习-23.异常处理器 exception_handler
qq_27371025的博客
10-07 847
通常我们可以通过 raise 抛出一个 `HTTPException` 异常，请求参数不合法会抛出`RequestValidationError` 异常，这是最常见的2种异常。
python fastapi add_exception_handler
06-25
在 FastAPI 应用中添加自定义异常处理器可以通过 `@app.exception_handler()` 装饰器实现，这一机制允许开发者捕获特定的异常并返回定制化的响应。例如，可以为 `HTTPException` 添加一个全局处理器，以统一处理所有...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

坦笑&&life

你的鼓励将是我创作的最大动力

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

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

打赏作者

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

抵扣说明：

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

余额充值