github.com/binbinly/pkg@v0.0.11-0.20240321014439-f4fbf666eb0f/errno/README.md (about)

     1  ## 错误码设计
     2  
     3  > 参考 新浪开放平台 [Error code](http://open.weibo.com/wiki/Error_code) 的设计
     4  
     5  #### 错误返回值格式
     6  
     7  ```json
     8  {
     9    "code": 10002,
    10    "message": "Error occurred while binding the request body to the struct."
    11  }
    12  ```
    13  
    14  #### 错误代码说明
    15  
    16  | 1 | 00 | 02 |
    17  | :------ | :------ | :------ |
    18  | 服务级错误（1为系统级错误） | 服务模块代码 | 具体错误代码 |
    19  
    20  - 服务级别错误：1 为系统级错误；2 为普通错误，通常是由用户非法操作引起的
    21  - 服务模块为两位数：一个大型系统的服务模块通常不超过两位数，如果超过，说明这个系统该拆分了
    22  - 错误码为两位数：防止一个模块定制过多的错误码，后期不好维护
    23  - `code = 0` 说明是正确返回，`code > 0` 说明是错误返回
    24  - 错误通常包括系统级错误码和服务级错误码
    25  - 建议代码中按服务模块将错误分类
    26  - 错误码均为 >= 0 的数
    27  - 在本项目中 HTTP Code 固定为 http.StatusOK，错误码通过 code 来表示。