当前位置:首页 > 文章列表 > 文章 > python教程 > 自定义异常类与业务错误码设置

自定义异常类与业务错误码设置

2026-04-10 12:21:41 0浏览 收藏
本文深入探讨了如何科学设计业务自定义异常类,强调必须继承Exception而非BaseException以确保可捕获性,通过__init__安全注入错误码(code)、消息(message)和上下文详情(details),并重写__str__直观展示错误码而不破坏args[0]的message一致性——这是日志解析、监控告警和APM工具正常工作的关键;同时提出用工厂方法+集中式错误码注册表(如ErrorCode类)替代海量异常子类,兼顾可维护性、跨服务一致性与开发体验,让错误处理既健壮又简洁。

Python项目中如何自定义异常类_继承Exception基类并添加业务错误码

为什么要继承 Exception 而不是 BaseException

直接继承 BaseException 会导致自定义异常无法被常规 except Exception: 捕获,因为 SystemExitKeyboardInterrupt 等系统级异常也继承自它。业务异常必须走 Exception 这条链,否则上线后可能“捕不到错却报错消失”,排查时一头雾水。

常见错误现象:except Exception: 块完全不触发,日志里只看到未处理的 MyBusinessError 报错退出。

  • 所有业务异常类都应显式继承 Exception(或其子类如 ValueError
  • 避免用 class MyError: 这种无继承写法——Python 3 中默认不继承任何类,等价于 object,不是异常类型
  • 不要重写 __init__ 时不调用 super().__init__(message),否则 str(exc) 返回空字符串

如何在自定义异常中安全携带错误码和上下文数据

错误码不能只靠类名区分(比如 UserNotFoundOrderNotFound 都是 404),得作为实例属性可读、可序列化。推荐用只读属性 + 初始化参数控制,避免运行时被意外修改。

使用场景:API 返回 JSON 时需透出 codemessage;日志采集需统一提取 error_code 字段。

class BizError(Exception):
    def __init__(self, code: int, message: str, details: dict = None):
        super().__init__(message)
        self.code = code
        self.details = details or {}
<h1>使用</h1><p>raise BizError(code=1001, message="库存不足", details={"sku_id": "S123", "available": 0})
</p>
  • codeint 类型,方便前端 switch 判断,也兼容 Prometheus 等监控系统打点
  • 不要把 details 设为可变默认参数 {} —— 多次 raise 会共享同一字典对象
  • 若需区分错误等级(如警告/错误/严重),可额外加 level 属性,但别混用 logging 级别名(如 "ERROR"),改用枚举或整数

__str____repr__ 怎么写才不影响调试和日志输出

默认 str(exc) 只返回 message,但运维查日志时往往需要一眼看到 code。重写 __str__ 加上错误码是合理做法;而 __repr__ 应保持“可重建对象”的风格,方便开发调试。

容易踩的坑:重写 __str__ 后导致 Sentry 或其他 APM 工具提取 message 失败——它们通常依赖 exc.args[0],而非 str(exc)

  • 始终保留 messageargs[0],即 super().__init__(message) 不可省
  • __str__ 可返回 f"[{self.code}] {self.args[0]}",既清晰又不破坏原有行为
  • __repr__ 建议返回 f"{self.__class__.__name__}({self.code!r}, {self.args[0]!r})",复制粘贴到 REPL 能直接执行

如何避免异常类爆炸——用工厂函数或注册表管理业务错误码

项目大了以后,几十个异常类散落在各模块,既难查找又易重复定义(比如两个模块都写了 UserLockedError(2003))。与其让每个错误码对应一个类,不如用单个基类 + 类方法生成实例,再配合模块级错误码注册表。

性能影响极小,但能显著降低维护成本,尤其适合微服务间错误码对齐场景。

# errors.py
class ErrorCode:
    USER_NOT_FOUND = 1001
    INSUFFICIENT_BALANCE = 1002
<p>class BizError(Exception):
_registry = {}</p><pre class="brush:php;toolbar:false"><code>def __init__(self, code: int, message: str, details: dict = None):
    super().__init__(message)
    self.code = code
    self.details = details or {}

@classmethod
def new(cls, code: int, message: str, **kwargs):
    return cls(code, message, kwargs)</code>

使用

raise BizError.new(ErrorCode.USER_NOT_FOUND, "用户不存在")

  • 错误码常量统一收口在 ErrorCode 类或 errors.py,禁止硬编码数字
  • 不建议用 @unique 枚举类包装错误码——增加 import 依赖,且 IDE 对 Enum 成员的跳转支持不如普通属性
  • 如果团队用 OpenAPI,错误码注释可直接从 ErrorCode 类生成,避免文档和代码脱节

业务异常类本身不复杂,但一旦跨服务、跨语言、进日志系统、对接监控平台,错误码的类型、可读性、不可变性就会变成关键细节。最常被忽略的是 args[0] 的一致性——它决定了 80% 的日志解析和告警规则是否生效。

好了,本文到此结束,带大家了解了《自定义异常类与业务错误码设置》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多文章知识!

文心一言怎么用?详细教程分享文心一言怎么用?详细教程分享
上一篇
文心一言怎么用?详细教程分享
Golang并发下载器与协程池设计解析
下一篇
Golang并发下载器与协程池设计解析
查看更多
最新文章
资料下载
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    4267次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    4616次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    4500次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    6200次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    4877次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码