HIT软件构造-Java规约设计

1.规约

以下用/**  */的部分就是一个函数的规约,就是记录函数的参数,功能,注意事项等,不写规约自己和别人都不容易知道函数是干嘛的

/**
     * 分别计算一组点中一个点到下一个点时,还需转过的角度值(BearingsToPoint)
     * <p>
     * Given a sequence of points, calculate the Bearing adjustments needed to get from each point
     * to the next.
     * <p>
     * Assumes that the Lab_1.turtle starts at the first point given, facing up (i.e. 0 degrees).
     * For each subsequent point, assumes that the Lab_1.turtle is still facing in the direction it was
     * facing when it moved to the previous point.
     * You should use calculateBearingToPoint() to implement this function.
     *
     * @param xCoords list of x-coordinates (must be same length as yCoords)
     * @param yCoords list of y-coordinates (must be same length as xCoords)
     * @return list of Bearing adjustments between points, of size 0 if (# of points) == 0,
     * otherwise of size (# of points) - 1
     */
    public static List<Double> calculateBearings(List<Integer> xCoords,List<Integer> yCoords);

2.行为等价性(从客户端层面)

有些函数从开发者层面来看明显是不等价的,但是在客户端层面,添加了某些约束条件后,它们可能是等价的

比如上面两个函数,findFirst找到第一个出现val的索引,findLast找到最后一个出现val的索引,但是如果两个函数都符合规约:值val只会在数组中出现一次,那么这两个函数在客户端看来就是等价的,等价于下面的函数

3.前置条件和后置条件

前置条件：对客户端的约束，在使用方法时必须满足的条件

后置条件：对开发者的约束，方法结束时必须满足的条件

契约:前置条件满足,后置条件必须满足,前置条件不满足,后置条件可以直接不用管

很重要的一点: 除非在后置条件里声明过，否则方法内部不应该改变输入参数

很明显下面四条都不遵守前置条件requires,所以函数返回时也不必遵守后置条件effect

4.规约的强弱比较

规约的强度S2>=S1的条件是S2的前置条件更弱且后置条件更强就可以说S2的规约强度大于S1,就可以用S2替代S1,一个有着更强规约的方法通常被认为是更好的方法,写规约也尽量写的更强。

spec变强：更放松的前置条件+更严格的后置条件。

前置条件更弱,说明方法能应用的条件更多,后置条件更强,说明方法更有针对性。

这个例子,前置条件变弱而后置条件不变,所以规约增强了

5. Diagramming specifications

规约强的方法,越不自由,实现方式就越少,反之规约弱的越自由,实现方式越多

比如找第一个元素的实现方式就能实现第一个规约,却实现不了第二个规约,所以也可以说第一个规约范围大,而第二个规约范围小,可以用图示表示,例如:

规约越强的圈的范围越小,规约越弱的圈的范围越大,ExactlyOnce应该是最大圈,包括了OneOrMore,AnyIndex

有任何问题和建议可以评论哦,非常感谢~