服务端错误码规则设计

  1. 错误码暂定都是5位数字,并配有相应的英文解释
  2. 错误码为 0 表示成功,其他都表示错误
  3. 错误码按模块按功能场景分级分段,前三位错误码表示模块,第四位表示模块下的功能。举例,商城系统里有交易模块和商品模块,则可以这样划分:401开头的表示交易模块,402开头的表示商品模块,4011开头的表示交易模块里的下单场景需要用到的错误码,4021表示商品模块下的添加商品场景里需要用到的错误码。如果某个场景功能下需要的比较多的错误码,则可以使用其他未被使用的码段,即该场景功能可以拥有多个码段,然后通过添加注释等方式让人理解即可。
  4. 数字 1 开头的错误码表示系统级别的错误,比如缺少某种字符集,连不上数据库之类的,系统级的错误码不需要分模块,可以按照自增方式进行添加
  5. 数字 4 开头的错误码表示API参数校验失败,比如 交易模块下单场景中,订单金额参数不能为空 可以用 40111 错误码来表示
  6. 数字 5 开头的错误码表示后台业务校验失败,比如 交易模块下单场景中,该用户没有下单权限可以用 50111 错误码来表示
  7. 数字 4 开头的错误码与数字 5 开头的错误码对应的模块分类需要保持一致,即 4011 表示交易模块下单场景的API错误,5011 表示交易模块下单场景的业务错误
  8. 错误码按需分配,逐步增加,灵活扩展

你可能感兴趣的:(设计,错误码,设计,错误码)