Skip to content
bitzorcas
中EN

Concept

预期失败与非预期异常

业务失败保持为 Result 数据,只有真正的意外故障进入异常处理器。

Last updated

问题与使用场景

业务失败保持为 Result 数据,只有真正的意外故障进入异常处理器。

当你需要在类型化 Result 与异常之间选择,并保持 HTTP 失败稳定时,使用这张图。

这张图适合用于方案评审、故障定位、代码走查与新人导览。它刻意省略与当前问题无关的类和项目,因此应与源码入口和相关专题文档一起使用。

本页范围只覆盖图中命名的职责和关系;未出现的能力需要回到对应模块文档继续确认。

读图路径

  1. 第 1 步:先把结果分类为预期业务失败或非预期故障。
  2. 第 2 步:沿类型化错误经过端点映射进入 Problem Details。
  3. 第 3 步:沿非预期异常进入全局处理器与净化路径。

读图时不要跳过箭头方向、编号和分组标题;它们分别表达依赖或时间方向、执行次序与职责边界。如果图与源码不一致,以当前源码和已接受的架构决策为准,并立即更新生成目录。

图例与表达约定

视觉元素含义不能据此推断
珊瑚色焦点当前图要强调的决策点或主路径该元素一定更重要或拥有更多权限
蓝色边界外部系统、协议边缘或显式边界一定是独立部署服务
灰色连接依赖、调用、迁移或数据流,具体语义由箭头标签决定一定同步、同事务或严格一次
分组框职责、层或生命周期阶段组织团队或物理机器边界

本图类型为 错误流。先依据该类型理解布局,再用下文的源码事实校正直觉。

关键关系与设计含义

关系 1

源码事实:预期内的领域与应用失败返回带类型化 Error 的 Result 或 Result<T>。

架构含义:类型化的预期失败仍属于用例契约,因此可以完整映射并测试。

核对动作:错误码是否足够稳定,可以成为客户端契约?

关系 2

源码事实:端点把类型化错误映射为稳定的 Problem Details 状态码与错误码。

架构含义:稳定的 Problem Details 错误码让客户端依据文档语义分支,而不必解析消息文本。

核对动作:业务分支是否避免用异常驱动控制流?

关系 3

源码事实:UseExceptionHandler 捕获非预期故障,并返回净化后的服务端错误。

架构含义:全局异常路径负责收敛未知故障,并防止内部异常数据成为公开契约。

核对动作:生产错误详情是否可能泄露内部信息或密钥?

设计评审问题

在评审或实现相关变更时,逐项回答下面的问题。无法从代码、测试或 ADR 得到答案时,不应仅凭图示作出结论。

  • 错误码是否足够稳定,可以成为客户端契约?
  • 业务分支是否避免用异常驱动控制流?
  • 生产错误详情是否可能泄露内部信息或密钥?

如何使用答案

  1. 先确定能力或规则的唯一归属方。
  2. 再确认依赖、调用或事件方向没有反转所有权。
  3. 最后用自动化测试或可重复命令固定结论。

边界与易错点

边界 1

不要用异常表达校验、未找到、冲突或禁止访问等业务结果。

  • 不要推断:图中出现连接,不等于所有实现都同步调用、共享事务或共享数据所有权。
  • 评审要求:业务分支是否避免用异常驱动控制流?

边界 2

生产环境的 Problem Details 绝不能暴露异常内部信息或密钥。

  • 不要推断:图中出现连接,不等于所有实现都同步调用、共享事务或共享数据所有权。
  • 评审要求:生产错误详情是否可能泄露内部信息或密钥?

源码核对与再生成

本图的首要核对入口是 BitzOrcas.Domain/Results + BitzOrcas.Api/Results/ProblemDetailsMapper.cs。先检查该入口及其直接引用,再重新生成图表资产和说明页。

Terminal window
# 重新生成中英文 SVG、独立 HTML 与说明页
npm run diagrams
# 检查双语配对、引用、安全属性、可访问性与画布边界
npm run verify:diagrams
Terminal window
# 确认生成结果只包含预期图表与页面变化
git diff -- scripts/diagrams diagram-sources public/diagrams src/content/docs
# 验证站内链接、MDX 结构与专业深度门禁
npm run verify:docs
npm run audit:docs-depth

变更完成清单

  • 图中的职责、顺序、状态或关系与当前源码一致。
  • 新增元素确实有助于回答本页问题,没有把项目清单全部塞进图中。
  • 箭头有明确方向与关系语义,没有暗示不存在的同步或事务保证。
  • 中英文标题、标签、事实与边界保持语义对等。
  • 窄屏、全屏和缩放模式下均可读,没有文字重叠或越界。
  • 相关架构测试、集成测试或验证命令已经执行。
  • 若改变了长期约束,已经同步 ADR 或架构说明。

继续阅读

100%

滚轮或按钮缩放 · 放大后拖动画面 · 双击切换 100% / 200%