StandardException 规范:探讨企业级项目中如何通过错误码(Error Code)统一包装异常变量输出

星婷吖_8688

星婷吖_8688

2026-05-06

426人浏览

原创

StandardException 是团队约定的统一异常基类,承载错误码、消息和上下文数据;错误码须通过枚举集中管理,命名需模块化分层(如 USER_NOT_FOUND),异常构造强制绑定 ErrorCode,全局拦截器仅捕获其子类以实现结构化异常处理。

standardexception 规范:探讨企业级项目中如何通过错误码(error code)统一包装异常变量输出

企业级项目中,StandardException 不是一个 JDK 或 Spring 内置类,而是团队约定的统一异常基类——它承载错误码(ErrorCode)、可读消息、上下文数据等关键信息,让异常从“抛出即消失”变成“可识别、可追踪、可响应”的结构化信号。

错误码必须集中管理,不能硬编码

所有业务异常必须通过枚举类(如 ErrorCode)定义错误码,禁止在 throw 语句里直接拼字符串或数字。例如:

  • USER_NOT_FOUND("USER_001", "用户不存在")
  • ORDER_EXPIRED("ORDER_005", "订单已过期,请重新下单")

枚举字段应包含:code 字符串(便于前端 switch)、中文提示(开发/测试用)、英文描述(国际化基础)、HTTP 状态建议值(如 404 对应 USER_NOT_FOUND)。

StandardException 基类要强制绑定 ErrorCode

自定义异常必须继承一个统一基类(如 StandardException),且构造函数只接受 ErrorCode 枚举或其 code 字符串,不允许多余重载。示例结构:

  • 构造时自动填充 code、message、timestamp
  • 支持传入额外参数(如 userId、orderId),用于填充 message 占位符("用户 {0} 余额不足")
  • 提供 getDetails() 方法返回脱敏后的上下文 Map,供日志和监控使用

全局拦截器只认 StandardException 及其子类

Spring 的 @RestControllerAdvice 应仅捕获 StandardException,其他未预期异常(如 NullPointerException)走兜底逻辑,返回通用 500 错误并记录 ERROR 日志。这样做的好处是:

  • 前端永远收到标准 Result> 结构,含 code(业务码)、errorCode(字符串标识)、msg(用户提示)、traceId(链路追踪)
  • 运维可通过 errorCode 快速筛选告警,无需解析日志文本
  • 测试人员根据 errorCode 编写断言,接口契约更稳定

错误码体系需分层可扩展

错误码命名不是编号游戏,而是一套语义路由系统:

  • 前缀按模块划分:USER_、PAY_、NOTICE_,避免全局冲突
  • 后缀按场景细化:USER_LOCKED、USER_INVALID_TOKEN,拒绝模糊命名如 ERROR_001
  • 预留号段:如 USER_9000+ 专用于系统级异常(DB 连接失败、Redis 超时),与业务异常隔离
  • 配套文档:每个 ErrorCode 枚举项附带「影响范围」「建议操作」「是否需人工介入」说明,嵌入到 Swagger 或内部 Wiki
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3469

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2408

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1340

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1278

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1396

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2298

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3740

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17435

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习