该原则的核心用途是:在最终确定接口之前,检查拟议设计是否为某个条件引入了异常、错误值、重试路径、回退分支或文档化的调用方义务,并判断这些错误状态是否本可避免。
主要能力包括:
- 识别候选错误状态:命名条件、预期后置条件,以及每个调用方原本必须采取的动作。
- 评估替代方案:该条件是否已经满足操作意图的后置条件;重复操作是否可安全地产生相同结果;该条件是否属于正常领域结果而非操作失败;能否通过构造器、类型、状态转移或边界不变量阻止该条件。
- 选择最小且诚实的语义或不变量变更,消除调用方义务而不隐藏信息。
- 决定保留还是消除:当调用方需要区分结果以保护正确性、选择恢复方式或遵守外部合同时,保留显式错误;当条件可正常化、幂等化或不可达时,消除不必要的调用方分支。
- 在消费者可见边界验证所选公开行为;涉及跨模块或外部 API 的重大选择应交给架构角色,接口负担或不变量放置分析应交给代码库设计角色。
使用方式:在设计阶段按上述决策规则逐步检查;若原则改变了设计,需记录结果为“消除”或“保留”,并按指定格式报告,例如:Applied principle-eliminate-avoidable-error-states: <条件> changed <拟议处理> to <语义、不变量或显式错误结果>。若未改变决策,则不报告该原则。
适用场景:例如删除命令的合同是确保资源不存在,删除已不存在的资源无额外副作用,但拟议 API 返回 NotFound 并要求每个调用方忽略它——此时可将已不存在的情况定义为幂等成功,并移除调用方的重试或忽略分支。
限制与反例:不得将鉴权或授权失败、可能的数据丢失、合同违约、数据损坏或安全失败转为成功;必须保留需要业务或恢复选择的失败,如支付被拒、写入被拒、需要合并的冲突、依赖不可用;幂等性必须对操作承诺的结果和副作用成立,重复执行会扣费、发布、通知或改变额外状态的命令仍需重复保护或显式失败语义;内部适配器只能在其授权合同保留调用方所需全部区分时规范化外部结果,不得为简化本地代码而违背外部协议;通过构造阻止状态需要在所属边界有可强制执行的不变量,而非压制可达情况的断言。该原则不意味着捕获并忽略异常、丢弃诊断信息、无条件返回成功或用模糊回退替代有意义的失败。
分类:该原则属于编程与开发中的设计原则。