设计规约
5 设计规约
Functions & methods in programming languages
1 | […] NAME (TYPE NAME, TYPE NAME) { |
参数类型是否匹配,在静态类型检查阶段完成
1 | public static TYPE NAME() { |
返回值类型是否匹配,也在静态类型检查阶段完成
“方法”是程序的“积木”,可以被独立开发、测试、复用
使用“方法”的客户端,无需了解方法内部具体如何工作—“抽象”

Specification: Programming for communication
Documenting in programming


变量的数据类型定义
final关键字定义了设计决策:“不可改变”
- 代码中蕴含的“设计决策”:给编译器读
- 注释形式的“设计决策”:给自己和别人读
Specification and Contract (of a method)
规约是合作的关键。没规约,没法写程序;即使写出来,也不知道对错。
规约是程序与客户端之间达成的一致,Spec给“供需双方”都确定了责任,在调用的时候双方都要遵守。
- 规约可以隔离“变化”,无需通知客户端。
- 规约也可以提高代码效率。
- 规约:扮演“防火墙”角色。
规约内容包含:
- 输入/输出的数据类型
- 功能和正确性
- 性能
只讲“能做什么”,不讲 “怎么实现”
Behavioral equivalence
To determine behavioral equivalence , the question is whether we could substitute one implementation for the other.(站在客户端视角看行为等价性)
根据规约判断是否行为等价。
Specification structure: pre-condition and post-condition
前置条件:对客户端的约束,在使用方法时必须满足的条件
后置条件:对开发者的约束,方法结束时必须满足的条件
契约:如果前置条件满足了,后置条件必须满足
- Parameters are described by @param clauses and results are described by @return and @throws clauses.
- Put the preconditions into @param where possible, and postconditions into @return and @throws.

除非在后置条件里声明过,否则方法内部不应该改变输入参数
应尽量遵循此规则,尽量不设计 mutating 的 spec,否则就容易引发 bugs。

Designing specifications
Classifying specifications
对规约进行比较:
- 规约的确定性
- 规约的陈述性
- 规约的强度
用于判断“哪个规约更好”
规约的强度S2>=S1,需满足:
- 前置条件更弱
- 后置条件更强
就可以用S2替代S1
越强的规约,意味着 implementer 的自由度和责任越重,而client的责任越轻。
Diagramming specification
使用点表示实现方法,则每个规约就是包含满足其条件的所有实现的区域。
程序员可以在规约的范围内自由选择实现方式,客户端无需了解具体使用了哪个实现。
更强的规约,表达为更小的区域。
Designing good specifications
一个好的“方法”设计,并不是你的代码写的多么好,而是你对该方法的spec设计得如何。
(1) The specification should be coherent
coherent——内聚的
Spec描述的功能应单一、简单、易理解。
(2) The specification should be strong enough
太弱的spec,client不放心、不敢用 (因为没有给出足够的承诺)。
开发者应尽可能考虑各种特殊情况,在post-condition给出处理措施。
(3) The specification should also be weak enough
太强的spec,在很多特殊情况下难以达到,给开发者增加了实现的难度。
(4) The specification should use abstract types
在规约里使用抽象类型,可以给方法的实现体与客户端更大的自由度。
In Java, this often means using an interface type, like Map or Reader, instead of specific implementation types like HashMap or FileReader.
(5) Precondition?
是否应该使用前置条件?在方法正式执行之前,是否要检查前置条件已被满足?
不写Precondition,就要在代码内部check;若代价太大,在规约里加入precondition,把责任交给client
是否使用前置条件取决于
- check的代价;
- 方法的使用范围
- 如果只在类的内部使用该方法(private),那么可以不使用前置条件,在使用该方法的各个位置进行check——责任交给内部client;
- 如果在其他地方使用该方法(public),那么必须要使用前置条件,若client端不满足则方法抛出异常。