契约划清责任
方法契约用前置条件、后置条件和惩罚区分调用者责任与实现者责任。前置条件被破坏通常是调用者错误,后置条件被破坏则是方法内部错误。发散:契约越清楚,缺陷定位越少靠争论。
主题对照
比较前置条件、后置条件、不变式在划分调用方与实现方责任上的作用,以及检查开销和与测试的分工。
方法契约用前置条件、后置条件和惩罚区分调用者责任与实现者责任。前置条件被破坏通常是调用者错误,后置条件被破坏则是方法内部错误。发散:契约越清楚,缺陷定位越少靠争论。
前置条件应只包含调用者能完全控制的事项;文件是否被外部进程删除这类环境变化,不该算调用者违规。发散:把不可控风险写进异常处理,把可控约束写进前置条件。
类不变式描述对象在公有方法调用前后必须满足的静态一致性,比如组非空、水量非负、同组水量一致。发散:不变式像对象的健康检查,能把分散字段约束集中表达出来。
公有方法的前置条件检查应在生产环境也保持开启,因为它防止外部误用继续污染系统状态;后置条件和不变式检查更适合用断言在开发期启用。发散:不同检查的运行成本和责任边界不同。
后置条件常需要保存旧状态并比较新旧状态,代码量可能超过业务逻辑本身。发散:高风险代码值得严密后置检查,普通代码更常用测试和关键不变式来获得足够信心。
单元测试从类外部验证后置条件和惩罚,让生产代码保持简洁,同时用可重复输入建立可靠性信心。发散:测试不是断言的替代品,而是把契约执行从运行时监控转成开发期验证。
数据验证不严导致的问题比黑客攻击更常见。争论校验放在控制器层、服务层还是持久层,本身问错了方向:只做格式校验会漏业务校验,多层都做会重复执行,甚至让用户“挤牙膏”式反复提交。更好的做法是把校验绑定到数据对象本身,即 Java Bean Validation:无业务含义的格式校验预置在类定义里自动运行;有业务含义、需查数据库的校验做成自定义约束注解,由调用方显式声明何时触发。
命令查询分离把修改状态的命令与读取信息的查询区分开:调用查询本身不改变对象,因此同一输入和对象状态下可重复取得相同结果,也不会因查询改变后续操作。若两次查询之间有命令或外部写入,结果仍可能变化。这是控制副作用的设计约定,不能只凭“方法有返回值”判断其职责是否混淆。
契约式设计用前置条件、后置条件和不变式明确双方责任。接口不只是函数签名,还应说明调用者必须保证什么、被调用者承诺什么,模糊地带越少,缺陷越早暴露。
前置描述合法调用,后置描述完成后的保证,不变式约束对外稳定状态。写出后置条件本身不能证明程序终止;契约须满足真实客户用途,不能靠任意收窄输入来回避责任。
断言适合表达“不可能发生”的内部假设。它不是用户输入校验,也不应带副作用;好的断言像路标,告诉维护者算法依赖哪些前提。
共同命名、异常处理和架构规范,使协作者减少重复猜测,在明确边界内工作。规范与标准都是契约,但规范不是越多越好,应能解释实际解决的问题。团队共识也不能取代对外协议、业务事实或安全约束;规则的价值在于帮助可靠协作。
继承的危险之一是子类重定义操作后与超类不一致,契约断言能约束这种风险。规则是:类的不变式和后置条件适用于所有子类,子类可以加强、不能减弱;前置条件正相反,可以减弱、不能加强。原因在于动态绑定:调用方按超类的契约调用,如果子类要求更苛刻的前置条件,原本合法的调用就会在子类上失败。发散:这正是里氏替换原则可检验的形式。参见[[契约分清责任]]、[[泛化需可替换]]。
按要求生成时,Specification 描述输出必须满足什么,生成器自己决定怎样达到。客户端因此可理解、测试接口而无需读完整算法;若同一规格也支持验证,还可检查产物。原书举战机需求及文字绕图排列作类比,不是具体实现保证。生成也可能是重新配置已有对象。参见[[规格统一验证查询与按需生成]]。
原书假设化学品仓库案例:危险品要求装甲或通风等 Container Feature,Chemical 对应的 Container Specification 能检验容器是否满足要求。先定义 isSafelyPacked 和 Packer 服务的完成条件,再把最优装箱算法藏在服务实现里;无完整解应抛异常。图9.16中的货物、桶、容器及约束是教学模型,既有容器可能已放部分货物,不能仅按特性忽略容量与混装限制。参见[[生成器接口以规格描述结果]]。
结构图:
classDiagram
class Chemical
class ContainerSpecification
class Container
class ContainerFeature
class Drum
Container "1" --> "*" Drum : 装入
Drum "1" --> "1" Chemical : 包含
Chemical "1" --> "1" ContainerSpecification : 约束
ContainerSpecification "1" --> "0..1" ContainerFeature : 要求特性
Container "1" --> "*" ContainerFeature : 提供特性
ContainerSpecification ..> Container : 检验容器
原书假设的 PrototypePacker 顺序寻找第一个能容纳桶的容器,可先打通应用到服务的反馈链路;它遵守已声明的安全约束,却可能先把沙子放进专用容器,导致后续危险品无处可放,也不优化收益。代码还注明抛异常时容器可能已改变,回滚须由上层处理。它是教学原型,不能当生产求解器或原子操作。
原书假设装箱服务案例中,应用团队和优化算法团队若互等完整实现,集成与用户反馈都会推迟。先以同一 Packer 接口和安全断言提供可运行的简单原型,两队便能并行:应用团队接通外部系统,专家试用后给算法团队反馈,双方及早发现契约变更。成熟实现随后替换原型;这一可替换性取决于接口和断言被持续维护,不保证复杂实现上线“毫无集成问题”。参见[[可运行原型须声明算法与回滚局限]]。
业务对象难免要改变状态,可把“改动”与“取值/计算”放在不同操作中:命令保持简单,只负责可观察的状态变化且不返回领域数据;查询和计算不改变可观察状态。这样调用者更容易判断一次调用会不会影响后续行为,复杂规则也能单独测试。这是原书在实体对象上的设计建议,不表示现实系统可以完全不用命令;若一个合适的值对象能承担计算,还可进一步减少修改。参见[[无副作用函数便于安全组合]]。
名称能提示操作意图,却未必说清会改变什么。断言把状态契约写明:前置条件说明保证成立所需的输入/状态;后置条件说明操作完成后的保证;类或聚合不变量说明每次操作结束都应保持的完整性规则。它们描述状态而非内部执行步骤,且上层操作的保证应涵盖下层委托产生的效果。若语言不直接支持,可用测试建立前置条件、执行操作并检查后置条件,同时在适当的文档或图中保留契约。参见[[接口名称表达领域意图]]。
在原书颜料商店教学例子中,p1.mixIn(p2) 增加 p1 体积却不减少 p2,与“把一桶倒入另一桶”的直觉冲突。把这个后置条件写出来后,团队才发现应用还要列出参加混合的原始颜料;直接把 p2 清零虽符合物理直觉,却破坏该展示需求。契约别扭可能提示模型把“库存原料”和“混合结果”混作一个概念;先核业务用途,再考虑拆概念,而非仅把现有怪规则写进文档或机械修正数据。
原书的联贷本金付款教学案例中,初版 Loan.distributePrincipalPayment(amount) 一边按各出借人份额计算付款分配,一边减少贷款中的份额。名称不足以暴露两个后果,也让试算无法安全重用。
图10.17把它拆为 calculatePrincipalPaymentShares(amount)(只计算分配)与 applyPrincipalPaymentShares(distribution)(实际改状态)。客户先得到分配,再明确执行变更;这一步改善副作用可见性,但仍未解决计算逻辑都堆在 Loan 中的问题。
按契约设计(Meyer):契约就像双方的合法契约,双方都有履行义务。组件的契约以接口中每个操作的先决条件和后置条件的形式出现。 - 先决条件:操作执行前必须满足的条件。为真时保证后置条件为真;为假时操作结果得不到保证,实际上没有指定; - 后置条件:先决条件为真时,操作调用之后组件职责范围内数据(瞬态和持久)的状态。 客户(调用方)和提供者(实现方)各有义务和利益。
核心价值:明确调用者在调用前的职责——列入先决条件的东西,提供者不需要检查,只需假设为真。这避免了对传入数据检查过多或过少;而在软件中,过多检查和过少检查同样有害——导致程序膨胀、过于复杂难以维护,检查错误的代码本身还可能引入更多出错机会。
无效先决条件怎么办:先决条件不会阻止操作执行,由该操作的开发人员决定是否以及如何处理,通常涉及运行期环境提供或显式编写的异常处理。
表达方式:正式的 OCL 或自然语言。正式语言的优点是可以生成强制约束的代码(更可能基于物理架构生成)。例:为线路添加参与者选项的先决条件“指定的游客选项数量不能是零”。
扣款入口把输入整数直接传给修改余额的策略,没有金额正值或余额充分性校验。FreeDeduction先做freeMoney-amount再返回true,因此负金额会反增余额,超额扣款会使余额为负;固定策略也没有分别检查两类余额。
源码推导:余额100分、金额-10分,变为110分;余额5分、金额10分,变为-5分。客户端随后打印成功,代码没有持久化或真实账务验证。原书承认忽略余额不足与异常;这些反例只证明快乐路径不具备输入/余额约束,未运行。
点击箭头逐层展开,点击卡片标题查看详情。路径上下文仅用于连接层级,不计入主题卡片数。
来源书籍
领域建模类
书籍类型:经典原理
清单覆盖 7/7
405 张卡片
来源书籍
领域建模类
书籍类型:经典原理
清单覆盖 7/7
132 张卡片
来源书籍
代码可读性与重构类
书籍类型:经典原理
清单覆盖 7/7
109 张卡片
来源书籍
系统架构类
书籍类型:经典原理
清单覆盖 6/6
237 张卡片
来源书籍
系统架构类
书籍类型:未标注
清单覆盖 5/7
194 张卡片
来源书籍
软件架构方法论类
书籍类型:经典原理
类别清单尚未核对
127 张卡片
来源书籍
代码可读性与重构类
书籍类型:经典原理
类别清单尚未核对
163 张卡片
来源书籍
软件设计与复杂性管理类
书籍类型:经典原理
清单覆盖 5/6
297 张卡片
来源书籍
书籍类型:经典原理
252 张卡片
主题索引
比较单元测试、变异、模糊测试、静态分析与故障注入各自能证明什么。
主题索引
比较抽象、逻辑、结构化、批判、维度、分类、分治、简单、解耦、契约、模型、工具化、量化、数据与产品等思维模型如何指导软件设计、问题分析与团队协作。
主题索引
比较务实程序员在责任与质量、DRY 与正交、曳光弹与原型、工具习惯、偏执编程、解耦、需求澄清与团队协作上的做法与判断。
与 2 张主题卡片存在结构化链接;来自相同书籍;属于相同分类
与 1 张主题卡片存在结构化链接;共享 2 个其他主题;来自相同书籍;属于相同分类
与 1 张主题卡片存在结构化链接;共享 1 个其他主题;来自相同书籍;属于相同分类
与 1 张主题卡片存在结构化链接;共享 1 个其他主题;来自相同书籍;属于相同分类
与 1 张主题卡片存在结构化链接;共享 1 个其他主题;来自相同书籍;属于相同分类
与 1 张主题卡片存在结构化链接;共享 1 个其他主题;来自相同书籍;属于相同分类