Python开发RESTful API时怎样设计异常捕获?

酷枫吖_5942

酷枫吖_5942

2026-11-19

438人浏览

原创

HTTP状态码与异常类须一一对应,如UserNotFoundError→404、InvalidInputError→422;业务逻辑只抛异常,由全局处理器统一转为标准JSON响应并记录日志。

python开发restful api时怎样设计异常捕获?

HTTP状态码和异常类要一一对应

RESTful API 的异常响应不是随便抛个 Exception 就完事的。客户端依赖状态码做流程判断,比如 404 触发重试逻辑,422 提示表单校验失败。Python Web 框架(如 Flask、FastAPI)默认把未捕获异常转成 500,这会掩盖真实语义。

实操建议:

  • 定义明确的异常类,继承自 HTTPException(Flask)或 HTTPException/RequestValidationError(FastAPI),每个类绑定唯一状态码,例如 UserNotFoundError → 404,InvalidInputError → 422
  • 避免用 try/except Exception: 兜底——它会吞掉你本该暴露的类型信息,也拦不住系统级错误(如内存溢出)
  • 在中间件或全局异常处理器里统一格式化响应体,确保所有异常都返回 {"detail": "xxx"} 这类标准结构,而不是混合 str、dict 或空体

不要在业务逻辑里直接 return 错误响应

常见错误是写成这样:if not user: return jsonify({"error": "not found"}), 404。这会让异常流散落在各处,难以统一日志、监控或添加审计头(如 X-Request-ID)。

实操建议:

  • 业务函数只负责抛异常,不构造 HTTP 响应。比如 DAO 层查不到用户就 raise UserNotFoundError("user 123 not found"),路由函数里只写 get_user(123),让上层处理
  • 框架级异常处理器(如 Flask 的 @app.errorhandler(UserNotFoundError))才负责转成 JSON + 状态码
  • 这样能保证所有 404 都走同一套日志模板,也方便后续加 Sentry 上报或自动重试策略

验证失败要用框架原生机制,别手写 if 判断

手动写 if not data.get("email") or "@" not in data["email"]: 再 raise 异常,既重复造轮子,又难统一错误字段名(比如前端期待 email 字段报错,你返回了 data)。

Python健壮编程
Python健壮编程

编写可靠Python代码,避免可变默认值、导入陷阱与运行时意外

下载

实操建议:

  • 用 Pydantic 模型(FastAPI 默认)或 Flask-RESTx 的 reqparse 做请求体/查询参数校验,它们天然生成符合 OpenAPI 规范的 422 响应,字段名、错误信息位置都对齐
  • 自定义校验逻辑写在 Pydantic 的 @field_validator 里,而不是视图函数里,这样能复用且被文档自动收录
  • 注意 Pydantic v2 的 ValidationError 和 FastAPI 的 RequestValidationError 是两回事——前者用于模型内部校验,后者是 FastAPI 包装后的顶层异常,全局处理器要同时注册两者

数据库异常必须转换,不能裸露给客户端

像 psycopg2.IntegrityError 或 sqlalchemy.exc.NoResultFound 这类异常,包含数据库驱动细节(如 “duplicate key value violates unique constraint”),直接返回等于泄露服务架构,还可能被用于 SQL 注入探测。

实操建议:

  • 在 DAO 层或 ORM session commit 后立刻捕获 DB 异常,转成语义清晰的业务异常:比如 IntegrityError → DuplicateResourceError(409),NoResultFound → ResourceNotFoundError(404)
  • 别忽略 DBAPIError 的子类差异——IntegrityError 和 OperationalError 处理方式不同,前者是客户端可修复的(改数据重试),后者可能是连接池枯竭,该触发熔断
  • 日志里记录原始 DB 异常(含 SQL、参数),但响应体里只返回泛化消息,例如 “资源已存在” 而非 “违反唯一约束 idx_user_email”

最易被忽略的是异常上下文的传递:比如一个用户创建流程涉及发邮件、写数据库、调第三方 API,某步失败时,要保留原始异常链(用 raise NewError(...) from original_exc),否则排查时根本分不清是网络超时还是序列化失败。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python restful api

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1951

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5564

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1889

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

33997

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3987

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3987

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1283

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

636

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3103

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程