【游戏开发】004》业务错误码设计

实际开发当中,开发容易遇到哪些问题

  • 设计稿中提示语言经常改动
  • 大部分小公司没有完整的设计稿
  • 大部分开发者英文水平欠佳,变量命名很糟糕,导致拖累开发进度
  • 不必要的错误码设计。如:非管理员行使管理员权限,此等为非法操作,不应该单独增加错误提示

我们为什么需要错误码

  • 错误码主要是为了业务需要而设计的

错误码面向哪些群体

  • 用户,用户需要知道具体的错误信息。如:提示登录密码错误
  • 前端开发者,开发者需要知道具体的业务错误信息。如:非管理员做管理员操作
  • 后端开发者,开发者需要知道具体的业务错误信息,给前端开发者提示

用户对错误码的要求

  • 不关心错误码代号
  • 反馈信息要准确、言辞要委婉
  • 支持多语言(可选项)
  • 不同业务操作时,同一错误码提示不同(可选项)
  • 结论:
    • 后端返回错误码及通用提示信息给前端排查问题,具体提示给用户的信息应由前端开发定义。

开发者对错误码的要求

  • 需要根据错误码执行指定操作
  • 需要明确的错误提示
  • 当某个业务操作失败时,能够迅速定位到业务异常处,并给出合理解释。(非代码异常)

我的错误码设计

重点说明

  • 一个正常的客户端应该对某一些操作请求加以限制,当这些操作不满足条件却被发起时,统一返回非法操作错误码,为配合前端开发,将会在开发阶段返回提示具体的错误信息。而不是为每个错误信息编码,以减轻工作量和维护成本。以下示例:
    • 非管理员身份发起管理员权限操作
    • 非好友关系发起解除好友关系操作
    • 发起指定请求缺少参数,参数类型错误
    • 请求非法不支持
    • 无权限访问
  • 服务端不应该过度验证。以下示例:
    • 用户设置密码,输入两次新密码,应由前端校验是否一样
    • 用户使用旧密码设置新密码,新旧密码一致,应由前端校验是否一样

返回结构

{
    "data": {},  # 数据段
    "code": "0",  # 错误码
    "msg": "成功" # 提示(面向前端开发者,上线可关闭,节约流量)
}

错误码设计(缓更)

OPERATION_SUCCESS   0   成功
OPERATION_INVALID   1000    操作非法
OPERATION_FREQUENT  1001    操作频繁
    
ERROR_UNKNOWN   1100    未知错误
ERROR_SERVER    1101    服务器异常
ERROR_SERVER_OTHER  1102    第三方服务器异常

AUTH_EXPIRE  2000  身份认证信息已失效

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,902评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,037评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,978评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,867评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,763评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,104评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,565评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,236评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,379评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,313评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,363评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,034评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,637评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,719评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,952评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,371评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,948评论 2 341

推荐阅读更多精彩内容

  • 专业考题类型管理运行工作负责人一般作业考题内容选项A选项B选项C选项D选项E选项F正确答案 变电单选GYSZ本规程...
    小白兔去钓鱼阅读 8,966评论 0 13
  • 点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 13,617评论 0 15
  • error code(错误代码)=2000是无效的像素格式。error code(错误代码)=2001是指定的驱动...
    Heikki_阅读 1,734评论 0 4
  • 辰腾辰飞阅读 54评论 0 0
  • 【0503今日话题】 一个姑娘,人挺漂亮,能力也不错。 但是工作时总没有责任心,也没啥胆量,并喜欢把这些表现的原因...
    单双眼星人阅读 89评论 0 0