错误码是用户定位及解决问题的重要手段之一,当应用发生异常时,用户根据错误码及文档中的错误码描述和解决方案就可以快速定位并解决问题。
- 遵循驼峰命名法;
- 错误码分为两级。例如,
InvalidParameter.BindError
,以.
号分隔。其中,第一级错误码为平台级,第二级错误码为资源级别,可根据场景自定义; - 第二级错误码只能使用英文字母或数字([a-zA-Z0-9]),应使用英文单词规范拼写、规范缩写、RFC 术语缩写等;
- 错误码应避免同一语义多种定义,例如:
InvalidParameter.ErrorBind
,InvalidParameter.BindError
。
| 错误码 | 错误描述 | 错误类型 | | ---- | ---- | | InternalError | 内部错误 | 1 | | InvalidParameter | 参数错误(包括参数类型、格式、值等错误) | 0 | | AuthFailure | 认证 / 授权错误 | 0 | | ResourceNotFound | 资源不存在 | 0 | | FailedOperation | 操作失败 | 2 |
错误类型:0 代表客户端,1 代表服务端,2 代表客户端 / 服务端。