目录
前言
异常处理标识依次分为【重要】、【建议】、【参考】,整理开发异常的目的在于为小伙伴处理代码异常提供一些建议。
1.异常日志
1.1 错误码
1.【重要】错误码的制定原则:快速溯源、沟通标准化。
说明:错误码想得过于完美和复杂,就像康熙字典的生僻字一样,用词似乎精准,但是字典 不容易随身携带且简单易懂。
正例:错误码回答的问题是谁的错?错在哪?
- 1)错误码必须能够快速知晓错误来源,可快速判断是谁的问题。
- 2)错误码必须能够进行清晰地比对(代码中容易 equals)。
- 3)错误码有利于团队快速对错误原因达到一致认知。
2.【重要】错误码不体现版本号和错误等级信息。
说明:错误码以不断追加的方式进行兼容。错误等级由日志和错误码本身的释义来决定。
3.【重要】全部正常,但不得不填充错误码时返回五个零:00000。
4.【重要】错误码为字符串类型,共 5 位,分成两个部分:错误产生来源+四位数字编号。
说明:错误产生来源分为 A/B/C,A 表示错误来源于用户,比如参数错误,用户安装版本过低,用户支付超时等问题; B 表示错误来源于当前系统,往往是业务逻辑出错,或程序健壮性差等问题;C 表示错误来源于第三方服务,比如 CDN 服务出错,消息投递超时等问题;四位数字编号从 0001 到 9999,大类之间的步长间距预留 100,错误码列表如下:
错误码 | 中文描述 | 说明 |
00000 | 一切 ok | 正确执行后的返回 |
A0001 | 用户端错误 | 一级宏观错误码 |
A0100 | 用户注册错误 | 二级宏观错误码 |
A0101 | 用户未同意隐私协议 | |
A0102 | 注册国家或地区受限 | |
A0110 | 用户名校验失败 | |
A0111 | 用户名已存在 | |
A0112 | 用户名包含敏感词 | |
A0113 | 用户名包含特殊字符 | |
A0120 | 密码校验失败 | |
A0121 | 密码长度不够 | |
A0122 | 密码强度不够 | |
A0130 | 校验码输入错误 | |
A0131 | 短信校验码输入错误 | |
A0132 | 邮件校验码输入错误 | |
A0133 | 语音校验码输入错误 | |
A0140 | 用户证件异常 | |
A0141 | 用户证件类型未选择 | |
A0142 | 大陆身份证编号校验非法 | |
A0143 | 护照编号校验非法 | |
A0144 | 军官证编号校验非法 | |
A0150 | 用户基本信息校验失败 | |
A0151 | 手机格式校验失败 | |
A0152 | 地址格式校验失败 | |
A0153 | 邮箱格式校验失败 | |
A0200 | 用户登录异常 | 二级宏观错误码 |
A0201 | 用户账户不存在 | |
A0202 | 用户账户被冻结 | |
A0203 | 用户账户已作废 | |
A0210 | 用户密码错误 | |
A0211 | 用户输入密码错误次数超限 | |
A0220 | 用户身份校验失败 | |
A0221 | 用户指纹识别失败 | |
A0222 | 用户面容识别失败 | |
A0223 | 用户未获得第三方登录授权 | |
A0230 | 用户登录已过期 | |
A0240 | 用户验证码错误 | |
A0241 | 用户验证码尝试次数超限 | |
A0300 | 访问权限异常 | 二级宏观错误码 |
A0301 | 访问未授权 | |
A0302 | 正在授权中 | |
A0303 | 用户授权申请被拒绝 | |
A0310 | 因访问对象隐私设置被拦截 | |