本篇文章主要探讨关于统一错误码的设计,并提供笔者的实现
欢迎大家讨论,指正。
该错误码的设计在仓库:
github:https://github.com/valarchie/AgileBoot-Back-End
gitee:https://gitee.com/valarchie/AgileBoot-Back-End
统一的错误码管理的优点
- 统一的错误码描述,如果没有统一的错误码的话,错误描述散落在项目内的不同地方,同一个错误码却产生不同的错误描述,会导致歧义。
- 错误码的层级,在与客户端的交互过程中,我们可能需要根据错误的层级,来做不同的显示。例如系统内部的错误,我们产生红色的警告框。业务上操作类型的错误(例如用户名不能超过64位),我们
则以正常的黄色提示框来提醒用户。 - i18n的处理。统一的错误码管理,才使得国际化更好实现。我们可以给每一种错误码定义唯一的key,来找到对应不同语言的错误描述。
- 集中的错误码管理便于形成文档供调用者参考。例如我们提供接口给其他团队调用,可以提供给他们详细的错误码列表。
无错误码设计的缺陷
Ruoyi项目
- 错误描述散落在项目的各个地方,一旦有改变错误描述的需求,要满项目去寻找关联的错误描述,然后逐一修改。这种情形很容易造成疏漏。
- 如果需要翻译的话,这种随意的字符串形式也很难去做国际化翻译。</