网站编号：1705

所属分类： 博客日志

网站URL： https://lesofn.com/archives/errorcode-design

最后点入：2024-05-29 14:19:42 · 加入时间：2023-04-14 10:03:35

网站关键词(16个字符):
架构、 java、 美团、 研发、 后端、

网站描述词(128个字符):
在微服务化的今天，服务间的交互越来越复杂，统一异常处理规范作为框架的基础，一旦上线后很难再更改，如果设计不好，会导致后期的维护成本越来越来大。对于错误码的设计，不同的开发团队有不同的风格习惯。本文分享作者从实践中总结的经验及对应的思考，期望对读者有所启发。

关于lesofn.com说明：
lesofn.com由网友主动性提交被自动秒收录整理收录的，自动秒收录仅提供lesofn.com的基础信息并免费向大众网友展示，lesofn.com的是IP地址：43.140.202.133 [中国北京北京 腾讯云]，lesofn.com的百度权重为0、百度手机权重为0、百度收录为0条、360收录为0条、搜狗收录为0条、谷歌收录为0条、百度来访流量大约在-之间、百度手机端来访流量大约在-之间、lesofn.com的备案号是京ICP备2020044753号、备案人叫李少锋、被百度收录的关键词有0个、手机端关键词有0个、迄今为止已经创建3年6个月16天。

下载地址: txt下载、docx下载、pdf下载、rar下载、zip下载

本页地址: https://www.badfl.com/links/25d9c9a9465124cb5f1e.html

SEO信息	百度来访IP：- | 移动端来访IP：- | 出站链接：0 | 站内链接：0
IP网速：	IP地址：43.140.202.133 [中国北京北京 腾讯云] | 网速：977毫秒
ALEXA排名	世界排名：- | 预估IP：- | 预估PV：-
备案信息	京ICP备2020044753号 | 名称：李少锋 | 已创建：3年6个月16天

收录	百度	360	搜狗	谷歌
查询	0	0	0	0

电脑关键词	手机关键词	页面友好	首页位置	索引	近期收录
0	0	电脑端优秀	-	0	0

协议类型HTTP/1.1 200 OK 页面类型text/html 服务器类型nginx 是否压缩是 原网页大小82913 压缩后大小16075 压缩比80.61%

错 误 码 设 计 思 考 木 小 风 的 博 客 首 页 小 记 文 章 归 档 关 于 我 1 测 试 文 章 2 H e l l o H a l o 木 小 风 的 博 客 行 动 起 来 ， 活 在 当 下 累 计 撰 写 2 0 篇 文 章 累 计 创 建 1 9 个 标 签 累 计 收 到 9 条 评 论 栏 目 搜 索 目 录 C O N T E N T 首 页 / 架 构 / 正 文 架 构 J a v a 错 误 码 设 计 思 考 木 小 风 2 0 2 2 0 3 2 4 / 1 评 论 / 0 点 赞 / 1 1 7 0 4 阅 读 / 6 4 8 7 字 0 3 / 2 4 在 微 服 务 化 的 今 天 ， 服 务 间 的 交 互 越 来 越 复 杂 ， 统 一 异 常 处 理 规 范 作 为 框 架 的 基 础 ， 一 旦 上 线 后 很 难 再 更 改 ， 如 果 设 计 不 好 ， 会 导 致 后 期 的 维 护 成 本 越 来 越 来 大 。 对 于 错 误 码 的 设 计 ， 不 同 的 开 发 团 队 有 不 同 的 风 格 习 惯 。 本 文 分 享 作 者 从 实 践 中 总 结 的 经 验 及 对 应 的 思 考 ， 期 望 对 读 者 有 所 启 发 。 本 文 中 涉 及 的 源 码 ： h t t p s : / / g i t h u b . c o m / s o f n / a p p e n g i n e / t r e e / m a s t e r / c o m m o n e r r o r 什 么 是 错 误 码 引 自 阿 里 巴 巴 《 J a v a 开 发 手 册 》 异 常 日 志 错 误 码 错 误 码 的 制 定 原 则 ： 快 速 溯 源 、 简 单 易 记 、 沟 通 标 准 化 。 说 明 ： 错 误 码 想 得 过 于 完 美 和 复 杂 ， 就 像 康 熙 字 典 中 的 生 僻 字 一 样 ， 用 词 似 乎 精 准 ， 但 是 字 典 不 容 易 随 身 携 带 并 且 简 单 易 懂 。 正 例 ： 错 误 码 回 答 的 问 题 是 谁 的 错 ？ 错 在 哪 ？ 1 ） 错 误 码 必 须 能 够 快 速 知 晓 错 误 来 源 ， 可 快 速 判 断 是 谁 的 问 题 。 2 ） 错 误 码 易 于 记 忆 和 比 对 （ 代 码 中 容 易 e q u a l s ） 。 3 ） 错 误 码 能 够 脱 离 文 档 和 系 统 平 台 达 到 线 下 轻 量 化 地 自 由 沟 通 的 目 的 。 那 么 用 J a v a 异 常 能 表 示 出 来 吗 ？ 答 案 显 然 是 否 定 的 必 须 能 够 快 速 知 晓 错 误 来 源 ： 异 常 类 因 为 复 用 性 不 能 很 快 的 定 位 ， 异 常 类 和 代 码 行 数 也 不 是 一 个 稳 定 的 值 必 须 易 于 记 忆 和 对 比 ： 异 常 类 不 具 有 可 比 性 ， 且 不 利 于 前 后 端 交 互 能 够 脱 离 代 码 沟 通 ： 异 常 类 只 能 存 在 于 J a v a 代 码 中 错 误 码 设 计 错 误 码 的 设 计 是 比 较 简 单 的 ， 一 般 只 需 要 定 义 一 个 数 字 和 描 述 信 息 即 可 。 不 过 想 设 计 一 套 完 善 错 误 码 系 统 还 有 很 多 需 要 考 虑 的 场 景 。 1 、 错 误 码 的 分 层 大 部 分 项 目 错 误 码 设 计 分 为 3 级 能 满 足 业 务 场 景 ， 即 项 目 、 模 块 、 错 误 编 码 。 比 如 错 误 码 是 6 位 ， 前 两 位 是 项 目 码 、 中 间 两 位 是 模 块 码 ， 最 后 两 位 是 异 常 编 号 。 以 下 是 错 误 码 1 0 2 0 3 的 对 应 说 明 ： 2 、 错 误 的 表 示 方 法 ： 枚 举 o r 类 推 荐 使 用 枚 举 ， 因 为 枚 举 具 有 不 可 变 性 ， 且 所 有 值 都 在 一 个 文 件 里 描 述 。 3 、 多 模 块 错 误 码 定 义 及 接 口 定 义 最 原 始 的 错 误 定 义 方 法 是 项 目 中 所 有 的 错 误 码 都 定 义 在 一 个 类 里 ， 但 是 这 样 会 随 着 业 务 的 发 展 错 误 码 越 来 越 多 ， 最 终 导 致 难 以 维 护 ， 推 荐 的 做 法 是 按 照 项 目 + 模 块 粒 度 定 义 成 多 个 错 误 码 枚 举 类 。 有 两 个 问 题 需 要 考 虑 ： （ 1 ） 项 目 编 码 、 模 块 编 码 的 维 护 ： 推 荐 另 建 一 个 枚 举 类 统 一 维 护 （ 2 ） 异 常 类 的 统 一 引 用 ： 定 义 接 口 ， 枚 举 类 实 现 接 口 示 例 ： / / 异 常 接 口 定 义 p u b l i c i n t e r f a c e E r r o r C o d e / / 模 块 定 义 p u b l i c e n u m U s e r P r o j e c t C o d e s / / 登 录 模 块 异 常 码 定 义 p u b l i c e n u m L o g i n E r r o r C o d e s i m p l e m e n t s E r r o r C o d e } 4 、 防 重 设 计 错 误 码 本 质 上 就 是 一 个 数 字 ， 且 每 一 个 都 需 要 由 R D 编 码 定 义 ， 在 错 误 码 多 的 项 目 很 容 易 重 复 。 最 佳 实 践 是 在 枚 举 的 构 造 方 法 里 调 用 H e l p e r 类 ， H e l p e r 类 统 一 维 护 所 有 的 异 常 码 ， 如 有 重 复 则 枚 举 初 始 化 失 败 。 5 、 错 误 扩 展 信 息 只 有 错 误 码 是 不 够 的 ， 还 需 要 反 馈 给 调 用 方 详 细 的 错 误 信 息 已 方 便 修 正 。 固 定 的 错 误 信 息 字 符 串 在 某 些 场 景 写 也 是 不 够 的 ， 这 里 推 荐 使 用 s l f 4 j 打 日 志 时 使 用 的 动 态 参 数 ， 这 种 方 式 相 比 于 S t r i n g . f o r m a t 格 式 的 好 处 是 不 需 要 关 心 参 数 的 类 型 以 及 记 忆 % s 、 % d 等 的 区 别 ， 且 打 印 日 志 时 经 常 使 用 ， 降 低 了 团 队 成 员 的 学 习 成 本 。 示 例 ： / / 错 误 码 定 义 P A R A M _ E R R O R ( 1 7 , 参 数 非 法 , 期 望 得 到 : , 实 际 得 到 : ) / / 错 误 码 使 用 E r r o r C o d e s . P A R A M _ E R R O R . f o r m a t ( a r g 1 , a r g 2 ) ; 实 现 方 式 ： o r g . s l f 4 j . h e l p e r s . M e s s a g e F o r m a t t e r . a r r a y F o r m a t ( t h i s . m e s s a g e , a r g s ) . g e t M e s s a g e ( ) 错 误 码 和 异 常 在 日 常 业 务 开 发 中 ， 对 于 异 常 使 用 最 多 的 还 是 抛 出 J a v a 异 常 （ E x c e p t i o n ） ， 异 常 又 分 为 受 检 查 异 常 （ E x c e p t i o n ） 和 不 受 检 查 异 常 （ R u n t i m e E x c e p t i o n ） ： 受 检 查 的 异 常 ： 这 种 在 编 译 时 被 强 制 检 查 的 异 常 称 为 受 检 查 的 异 常 。 即 在 方 法 的 声 明 中 声 明 的 异 常 。 不 受 检 查 的 异 常 ： 在 方 法 的 声 明 中 没 有 声 明 ， 但 在 方 法 的 运 行 过 程 中 发 生 的 各 种 异 常 被 称 为 不 被 检 查 的 异 常 。 这 种 异 常 是 错 误 ， 会 被 自 动 捕 获 。 1 、 异 常 绑 定 错 误 码 定 义 两 个 父 类 ， 分 别 用 于 首 检 查 异 常 和 非 受 检 查 异 常 。 可 支 持 传 入 错 误 码 ， 同 时 需 要 支 持 原 始 的 异 常 传 参 ， 这 种 场 景 会 赋 予 一 个 默 认 的 错 误 码 ， 比 如 ： 5 0 0 服 务 器 内 部 异 常 / / 父 类 定 义 p u b l i c a b s t r a c t c l a s s B a s e E x c e p t i o n e x t e n d s E x c e p t i o n p r o t e c t e d B a s e E x c e p t i o n ( S t r i n g m e s s a g e , T h r o w a b l e c a u s e ) p r o t e c t e d B a s e E x c e p t i o n ( T h r o w a b l e c a u s e ) p r o t e c t e d B a s e E x c e p t i o n ( E r r o r I n f o e r r o r I n f o ) p r o t e c t e d B a s e E x c e p t i o n ( E r r o r C o d e e r r o r C o d e ) p r o t e c t e d B a s e E x c e p t i o n ( E r r o r C o d e e r r o r C o d e , O b j e c t . . . a r g s ) } 2 、 部 分 异 常 使 用 异 常 能 适 用 于 大 部 分 场 景 ， 不 过 对 于 多 条 目 的 场 景 不 是 很 适 合 ， 比 如 需 要 批 量 保 存 1 0 条 记 录 ， 某 些 成 功 、 某 些 失 败 ， 这 种 场 景 就 不 适 合 直 接 抛 出 异 常 。 在 N o d e . j s 和 G o 语 言 中 异 常 处 理 采 用 多 返 回 值 方 式 处 理 ， 第 一 个 值 是 异 常 ， 如 果 为 n u l l 则 表 示 无 异 常 。 在 J a v a 里 建 议 采 用 v a v r 库 中 的 E i t h e r 来 实 现 ， 通 常 使 用 左 值 表 示 异 常 ， 而 右 值 表 示 正 常 调 用 后 的 返 回 结 果 ， 即 : E i t h e r 注 意 不 推 荐 P a i r 、 T u p l e 来 实 现 ， 因 为 E i t h e r 只 能 设 置 一 个 左 值 或 右 值 ， 而 P a i r 、 T u p l e 无 此 限 制 。 错 误 码 和 统 一 返 回 值 在 前 后 端 的 交 互 中 ， 后 端 一 般 使 用 J S O N 方 式 返 回 结 果 ， 整 合 前 面 说 的 错 误 码 ， 可 定 义 以 下 格 式 ： 在 S p r i n g M V C 中 实 现 方 式 是 自 定 义 R e s p o n s e B o d y A d v i c e 和 异 常 拦 截 ， 具 体 实 现 方 式 直 接 查 看 ： 源 码 实 现 了 以 上 步 骤 之 后 就 可 以 在 S p r i n g M V C 框 架 中 愉 快 的 使 用 了 ， 会 自 动 处 理 异 常 及 封 装 成 统 一 返 回 格 式 @ G e t M a p p i n g ( / o r d e r ) p u b l i c O r d e r g e t O r d e r ( L o n g o r d e r I d ) 总 结 本 文 总 结 了 设 计 错 误 码 需 要 考 虑 的 各 种 因 素 ， 并 给 出 了 参 考 示 例 ， 基 本 能 满 足 一 般 中 大 型 项 目 。 规 范 有 了 最 重 要 的 还 是 落 地 ， 让 团 队 成 员 遵 守 规 范 才 能 让 项 目 健 康 的 迭 代 。 源 码 地 址 ： h t t p s : / / g i t h u b . c o m / s o f n / a p p e n g i n e / t r e e / m a s t e r / c o m m o n e r r o r 本 文 链 接 ： 错 误 码 设 计 思 考 作 者 简 介 ： 木 小 丰 ， 美 团 J a v a 技 术 专 家 ， 专 注 分 享 软 件 研 发 实 践 、 架 构 思 考 。 欢 迎 关 注 公 共 号 ： J a v a 研 发 更 多 精 彩 文 章 ： J a v a 线 程 池 进 阶 从 M V C 到 D D D 的 架 构 演 进 平 台 化 建 设 思 路 浅 谈 构 建 可 回 滚 的 应 用 及 上 线 c h e c k l i s t 实 践 M a v e n 依 赖 冲 突 问 题 排 查 经 验 0 J a v a 架 构 软 件 工 程 版 权 归 属 ： 木 小 风 本 文 链 接 ： h t t p s : / / l e s o f n . c o m / a r c h i v e s / e r r o r c o d e d e s i g n 许 可 协 议 ： 本 文 使 用 《 署 名 非 商 业 性 使 用 相 同 方 式 共 享 4 . 0 国 际 ( C C B Y N C S A 4 . 0 ) 》 协 议 授 权 $ 微 信 扫 一 扫 上 一 篇 下 一 篇 评 论 区 木 小 风 的 博 客 行 动 起 来 ， 活 在 当 下 $ 1 4 3 2 2 5 访 问 量 1 6 分 类 数 2 0 文 章 数 9 评 论 数 告 诉 我 – > 文 章 目 录 相 关 文 章 稳 定 性 建 设 实 践 从 M V C 到 D D D 的 架 构 演 进 平 台 化 建 设 思 路 浅 谈 使 用 G r o o v y 构 建 D S L 2 0 2 4 © 木 小 风 的 博 客 已 运 行   0 0 天 0 0 时 0 0 分 0 0 秒 京 I C P 备 2 0 2 0 0 4 4 7 5 3 号   R S S 站 点 地 图

做上本站友情链接,在您站上点击一次,即可自动秒收录并自动排在本站第一位！
<a href="https://www.badfl.com/" target="_blank">自动秒收录</a>