linux-china
commented
3 years ago 项目的设计文档没有赶上，给大家造成一些理解的困惑。 这里我解释一下RSocket Broker中的错误码设计规范，虽然说是错误码，但是未必都是错误，有时会作为日志文件中的关键字，如将USER-100400作为登录失败提示，这样你通过grep等工具可以快速统计相关的错误，这个相信大家都明白。
所有的错误码都保存在一个Messages.properties文件中，样例代码如下：
### Listen
RST-100001 = Succeed to start RSocket Responder on {0}
RST-100500 = Error from listen server: {0}
### RSocket request
RST-200004 = RSocket REQUEST_RESPONSE: {0}
RST-200005 = RSocket REQUEST_FNF: {0}properties文件为KV结构，value就是错误提示，可以接受外部的变量。
这里主要说明一下Key的设计。 主要包括3个部分：
- 应用或者项目名： 你看到的
RST这样的，表示应用或者项目名称，如果你使用过JIRA，每一个项目都会有对应的简写KEY，如Hibernate就是HHH，Spring framework对应的就是SPR，这样的缩写也能让开发记住错误来自什么系统。如果有同学了解Oracle数据库的话，其中的错误码也包括特定意义的前缀，如ORA-,NNF-等。在RSocket Broker设计中，我有些偷懒啦，如可以定义RSB，RST等，但是考虑到RSocket还是非常简洁的，所以我就使用RST这个缩写啦。 - 三位组件编码： 如
RST-100XXX，表示RST项目中的100组件，至于这个组件是什么，由开发者自行定义。 如RST-100表示RSocket中的监听模块。 当然这里不强求组件编码一定是数字，你用字母也可以，如RST-LOGIN500，只是如果是数字的化，最好是三位，这样方便后续数据处理。 - 三位具体的错误编码： 在一个组件中，然后再定义具体的错误编码，这里最好复用HTTP等知名的Status Code，如200， 400， 404，500这些，别人看到就非常容易理解，如
USER-100404大家可能都明白这个就是会员系统下100子模块下的某一资源没有找到的错误。
整体下来和 https://github.com/kevinten10/vrml/blob/master/vrml-error/WIKI.md 设计思想差不多，唯一的区别就是接入组件这个概念，这个也是和软件系统中的子模块对应的。
另外一些稍微说明一下：
- 为何要保存在messages.properties文件中，这个主要是考虑国际化，一些错误提示可能要求是不同的语言的，如英文、中文，这样最终用户能看明白一些错误提示。 你只需要添加messages_zh-cn.properties就可以啦。
- 为何不将错误码调整为Java interface或者class的常量？ 主要是目前IDE工具已经支持基于properties文件的代码提示和重命名等，截屏效果如下，当然重命名Key、查找引用等这些都是没有问题的。
如果有什么不够合理的地方，欢迎大家提出宝贵意见。
kevinten10
I want to discuss with you about the specification of Error Code Design
Current Error Code Design
I saw the class
RsocketErrorCode, which is used to represent the error code in the project.Through tracking, it is found that the format starts with
RST-.Followed by a 6-digit error code, I saw the shape:
According to my understanding, the number at the beginning should correspond to a certain category, but I did not find a detailed corresponding documentation.
Vrml's Error Code Design
Our ideas coincide. For the specification of Error Code Design, please refer to https://github.com/kevinten10/vrml/blob/master/vrml-error/WIKI.md
In the end, we should have several categories:
And through centralized management and notes, people can read and understand clearly.
At the same time, by using centralized management, we can avoid the magic numbers scattered everywhere. The concept is the same as #103 . Even generate documents automatically.
How to do it
I will provide a prototype implementaion of the Error Code Design based on the
vrml-errormodule.Hope we can discuss this and have determined whether there is a better way.