错误码定义规范
错误码使用原则
- 原则上,系统里面所有的报错或提示信息,都禁止直接在代码里面写成固定的提示语,必须使用错误码的形式。
- 错误码的命名,必须遵循错误码命名规范。
- 错误码要配置在APP或BO内。
错误码命名规范
- BO名称/APP名称+“.”+错误码名称。
- 错误码名称采用大驼峰的方式,通常采用简洁的英文单词,不要使用汉语拼音。
- 状态码不能返回4xx,否则页面会跳转到登录页。
- 错误码的中英文错误信息都要定义。
- 错误参数信息不能使用 \ ,应该使用{0}。
错误码定义范例
所有的错误码,都需要在AstroZero上查看。
APP |
错误码名称 |
英文错误信息 |
状态码 |
中文错误信息 |
---|---|---|---|---|
AlarmBO |
Alarm.ServiceUnAvailable |
The request has failed due to a temporary failure of the server. |
500 |
服务不可用。 |
Alarm.InvalidOperator |
The input operator is invalid. |
500 |
非法操作符类型。 |
|
Alarm.illegalParameter |
The input parameter is illegal. |
500 |
非法参数类型。 |