如何在Python中自定义业务异常类并传递错误码

夜雪姑娘_5592

夜雪姑娘_5592

2026-10-03

500人浏览

原创

自定义异常应继承exception而非baseexception,因后者包含systemexit、keyboardinterrupt等系统级异常,继承baseexception会导致无法被except exception:捕获,并意外中断程序退出流程。

如何在python中自定义业务异常类并传递错误码

为什么要继承 Exception 而不是 BaseException

直接继承 BaseException 会导致你的异常无法被常规 except Exception: 捕获,可能意外中断程序——比如 sys.exit() 和 KeyboardInterrupt 就是 BaseException 的子类,Python 明确建议业务异常只继承 Exception。

自定义异常的核心目标是:让调用方能区分错误类型、提取结构化信息(如错误码),同时不破坏 Python 异常处理的默认行为。

__init__ 中必须显式接收并存储 error_code

不要依赖类属性或全局字典映射错误码,那会让实例失去独立性。每个异常实例应自带可读的错误码和消息。

常见错误是只存 message,后续靠字符串解析反推错误码,既脆弱又低效。

  • 在 __init__ 中强制要求 error_code 参数(可设默认值,但不推荐)
  • 把 error_code 绑定到实例属性,例如 self.error_code = error_code
  • 重写 __str__ 或 __repr__,让打印时自然带出错误码,便于日志排查
class BizError(Exception):
    def __init__(self, error_code: str, message: str):
        super().__init__(message)
        self.error_code = error_code

    def __str__(self):
        return f"[{self.error_code}] {super().__str__()}"

如何配合 HTTP 响应或日志统一处理 error_code

业务异常抛出后,通常需要转换为 API 返回的 JSON 结构(如 {"code": "USER_NOT_FOUND", "msg": "用户不存在"}),而不是裸奔异常信息。

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载

关键点在于:不要在每个 except 块里重复构造响应体,而是集中拦截处理。

  • FastAPI 中可用 @app.exception_handler(BizError) 统一返回 JSON
  • Django 可在中间件中捕获 BizError 并转为 JsonResponse
  • 日志记录时,优先输出 exc.error_code 而非 type(exc).__name__,方便 ELK 聚类分析

避免用字符串拼接错误码,用枚举或常量类管理

硬编码 "ORDER_TIMEOUT" 散落在各处,容易拼错、难搜索、无法 IDE 跳转。上线后改一个错误码要 grep 全局,风险高。

更稳妥的做法是定义一个错误码中心:

  • 用 Enum 枚举所有错误码,附带默认消息(可选)
  • 或用普通类 + 类变量,保持简单(适合小项目)
  • 异常构造时传入枚举成员,而非原始字符串,增强类型提示和校验
from enum import Enum

class ErrorCode(Enum):
    USER_NOT_FOUND = "USER_NOT_FOUND"
    INSUFFICIENT_BALANCE = "INSUFFICIENT_BALANCE"

raise BizError(ErrorCode.USER_NOT_FOUND.value, "用户未登录或已注销")

真正难的是错误码的生命周期管理:谁定义、谁审核、是否向客户端暴露、是否兼容旧版本。这些不在代码层面,但一旦疏忽,前端就只能靠 message 字符串做判断——那自定义异常就白做了。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4024

7

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

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

2023.07.31

1629

3

python教程
python教程

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

2023.08.03

23197

23

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

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

2023.08.04

2847

5

python eval
python eval

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

2023.08.04

2887

5

scratch和python区别
scratch和python区别

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

2023.08.11

1123

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2243

5

热门下载

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

精品课程

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