1.什么是错误码?
错误码是能够快速识别错误来源、具备特定意义、便于记忆和传阅的、标准化的一种设计.
2.错误码的作用
- 通过错误码快速判断错误来源和错误原因,快速排查问题.
- 应用程序之间通过错误码识别调用结果
- 前端根据错误码进行错误提示或者其他适配操作
- 根据错误码配置特定监控告警
3.错误码规范
- 容易记忆和传阅
- 有明确类型区分
- 可以明确区分来源
- 所有系统均采用统一标准
- 不允许错误码直接通过前端展示给用户
- 错误码与HTTP响应码区分开
- 宁愿长一点,也要实现易记忆、含义明确
四、设计方案
建议可以设计为：[系统标识]-[应用标志]-[功能域]-[错误类型]-[错误编码]
- 系统标志: 3-5位字符串,例如AppNmae
- 应用标志:3位数字,标志应用,例如001
- 功能域:3位数字,标志功能板块,例如001表示登陆
- 错误类型:1位字母,代表错误的类型,例如B-业务错误,P-参数错误,N-网络错误,D-数据库错误,F-文件IO错误,O-其他错误
- 错误编码:三位数字,代表特定的错误含义
