0

0

Python接口异常处理规范_错误码设计解析【技巧】

冷炫風刃

冷炫風刃

发布时间:2025-12-25 21:41:29

|

813人浏览过

|

来源于php中文网

原创

错误码需全局唯一、语义明确,统一用常量类管理;异常须分层捕获并映射到对应错误码;返回结构固定为code/msg/data,msg须静态化、国际化友好;自定义异常应继承BaseBusinessError并带code属性。

python接口异常处理规范_错误码设计解析【技巧】

错误码必须全局唯一且语义明确

Python接口返回的错误码不是随便编的数字,400500这类HTTP状态码不能替代业务错误码。业务错误码要能直接对应到具体问题类型,比如用户未登录是1001,参数缺失是1002,库存不足是2003。避免用0-1这种泛化值表示所有失败——前端无法据此做差异化处理。

建议用常量类统一管理:

class ErrorCode:
    USER_NOT_LOGIN = 1001
    PARAM_MISSING = 1002
    INSUFFICIENT_STOCK = 2003
    ORDER_NOT_FOUND = 3001

不要把错误码硬编码return里,也不要分散在多个模块中定义。

异常捕获要分层:HTTP层不吞业务异常

FastAPI/Flask等框架里,常见错误是把所有异常都用try...except Exception:包住,然后统一返回{"code": 500, "msg": "服务器错误"}。这会让调试变困难,也掩盖了本该由客户端处理的业务异常(如重复提交、余额不足)。

立即学习Python免费学习笔记(深入)”;

正确做法是分三级捕获:

  • 捕获已知业务异常(如InsufficientStockError),映射到对应ErrorCode.INSUFFICIENT_STOCK
  • 捕获ValidationError等框架级异常,转为ErrorCode.PARAM_MISSING
  • 只对真正未预期的Exception兜底,记录日志并返回500 + 通用提示

关键点:raise InsufficientStockError()return {"code": 2003, ...}更利于测试和链路追踪。

巧文书
巧文书

巧文书是一款AI写标书、AI写方案的产品。通过自研的先进AI大模型,精准解析招标文件,智能生成投标内容。

下载

错误信息字段要分离code/msg/data

返回结构必须稳定,不能因为调试需要就临时加debug_info字段,也不能把错误详情全塞进msg里。标准格式应为:

{
  "code": 1002,
  "msg": "缺少必要参数:user_id",
  "data": null
}

msg面向前端用户或调用方,需中文、简洁、无技术术语;data可选,用于携带补救信息(如重试时间、跳转链接);真正的堆或上下文必须进日志,不返给客户端。

特别注意:msg不能拼接变量(如f"用户{uid}不存在"),否则无法被前端国际化或埋点统计——应固定文案,靠data传动态值。

自定义异常类必须继承Exception且带code属性

写一个BaseBusinessError作为基类,强制子类提供codemessage

class BaseBusinessError(Exception):
    def __init__(self, code: int, message: str):
        self.code = code
        self.message = message
        super().__init__(message)

class ParamMissingError(BaseBusinessError):
    def __init__(self, field: str):
        super().__init__(ErrorCode.PARAM_MISSING, f"缺少必要参数:{field}")

这样中间件才能统一识别并序列化。别用ValueErrorRuntimeError代替——它们没有code属性,后续扩展会卡死。

还有个易忽略点:异常类名要体现领域,比如PaymentTimeoutErrorTimeoutError更安全,后者容易和标准库冲突。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

707

2023.06.15

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

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

625

2023.07.20

python能做什么
python能做什么

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

734

2023.07.25

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

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

616

2023.07.31

python教程
python教程

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

1234

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

573

2023.08.04

scratch和python区别
scratch和python区别

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

695

2023.08.11

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号