[软件构造]03-设计规约与断言

本文主要包含以下方面:

1.规约的概念与内容

2.规约的特点

3.规约的评价度量

4.规约下的函数行为等价性和变值约束

5.断言的概念和作用

6.断言与规约的联系

一、什么是设计规约

软件设计规约(Specification)是对软件的组织或其组成部分的内部结构的描述,满足系统需求规约所指定的全部功能及性能要求。软件设计规约通常有概要设计规约和详细设计规约,分别为相应设计过程的输出文档。软件概要设计是面向软件开发者的文档,主要作为软件项目管理人员、系统分析人员与设计人员之间交流的媒体。概要设计规约指明软件的组织结构,其主要内容包括:

        系统环境:硬件、软件接口与人机界面;外部定义的数据库;与设计有关的限定条件等。

        设计描述:数据流和主要数据结构;软件模块的结构;模块之间的接口。

        模块描述:处理过程外部行为;界面定义;数据结构;必要的注释等。

        文件结构和全局数据:文件的逻辑结构、记录描述以及访问方式;交叉引用信息。

        软件测试方面、软件版权的有关说明。

规约以注释形式撰写时,包括前置条件,对客户端的约束,在使用方法时必须满足的条件(对应requir es),和后置条件,对开发者的约束,方法结束时必须满足的条件(对应effects)。这就达成了一个契约:前置条件达成了,则后置条件必须满足;前置条件没达成,则方法可做任何事。当前置条件违反时,客户端存在bug,尽管程序员无义务提醒,但可以通过快速失败使bug更容易找到。

在撰写规约时,内容应包括输入输出数据类型、功能和正确性、性能,只讲能做什么,不讲如何实现。静态类型声明是一种规约,可据此进行静态类型检查。方法前的注释也是一种规约,但需人工判定是否完备。在注释中参数是@param,前置条件是@requires,后置条件是@effcts,结果是@return,异常是@throws。规约不得谈及方法局部变量或类私有域。下面是一个例子:

static boolean chat(Person A,Person B)
    要求:A,B是两个不同的人
    效果:判断A,B两个人是否讲过话,返回判断结果

二、规约的特点

1)内聚的(Coherent):规约描述的功能应该单一易理解。

2)信息丰富的(Informative):不能让用户对规约产生歧义。

3)约束足够强:规约应给出足够的承诺(后置条件),让用户放心使用。

4)约束足够弱:规约也应推卸适量的责任(前置条件),让程序员开发容易。

5)采用抽象型:在规约里使用抽象类型,给用户和实现体以更大的自由度。

例如下面的规约就体现出了抽象性,因为List<L>不记客户端类型,客户端可以做出广泛的类型的数组操作:

static ArrayList<T> united(T A)
    效果:返回一个新数组,它是图中与A相邻的点的集合(不包括A)
         即对于任意B∈Graph都有A->B这条边。

6)平衡前置条件和后置条件:是否使用前置条件取决于检查输入的难度和方法的适用范围,如果只在类的内部使用该方法[private]就可以使用前置条件,在使用该方法的各个位置进行检查[例如checkRep],如果在其他地方使用该方法[public]则可以不使用前置条件,在方法内部对错输入抛出异常。

三、规约的度量

规约具有确定性(描述输出是否确定)、陈述性(只是描述了输出,还是描述了怎么计算输出)、强度(描述规约优劣)。一个规约,前置条件越弱,后置条件越强,则这个规约强度越强,可以替代比它弱的规约。对于强度,有下面两个规约:

/* Spec 1
 * 
 * requires: int a>0 && int b>0
 * effects: calculate and return sqrt(a*b)
*/
/* Spec 2
 * 
 * requires: int a>0
 * effects: return sqrt(a*|b|) and indicate whether b<0 
*/
 

很显然,第2个规约与第1个规约相比对用户要求少了,对用户承诺多了,所以强度更强。

四·、行为等价性

即使两个函数最终功能等价但行为不同,可能在用户看来就不等价,所以要站在客户端的角度分析等价性。其实,只要两个方法符合同一规约,它们就是等价的。

五、规约限定变异(mutate)

除非后置条件声明过,方法内部不能改变输入参数,所以尽量不要设计mutate。可变类型复杂化规约,因为程序中可能有很多变量指向同一可变对象(变量别名现象),而且无法强迫类的实现体和客户端不保存可变变量别名。所以返回值应不可变。

六、断言

断言能够快速失败、避免扩散。断言在开发阶段的代码嵌入,检验某些假设是否成立。若成立,表示程序运行正常,否则表明存在错误。出现AssertionError则某些功能被违反了。断言是对代码中程序员所做假设的文档化,也不会影响运行时性能(实际使用时断言被禁用)。

//常用断言
assert aFunctionReturnBoolean;
assertEquals(value,Function());
assertTrue OP;
assertFalse OP;

在测试中断言对象包括:内部不变量、表示不变量、控制流不变量、前置条件和后置条件。扩展的说还有空指针、一个函数下的不变量、聚合体初始化效果和添加效果、复杂方法的返回值等等。

实际使用断言时,避免直接断言一个可执行语句,这是因为断言可能被禁用,执行语句直接被跳过,断言结果出错。断言维护正确性,错误异常处理维护健壮性。如果参数来自外部不受自己控制使用异常处理,如果参数来自自己写的其它代码,可是使用断言。

七、断言与设计规约的联系

断言与设计规约产生的联系是测试优先编程的重要一环。

一方面,为了写好断言我们必须充分理解设计规约,认识到方法的不变量、该变量都是什么,从而对这些不变和改变进行正确的断言,这样我们才能写好测试用例,为后续编程奠定基础。

另一方面,断言有效检测了方法在编写好后是否真的符合设计规约。一旦不符合预期结果就会产生AssertFailed,从而快速地找到错误根源进行修正。

热门文章

暂无图片
编程学习 ·

exe4j详细使用教程(附下载安装链接)

一、exe4j介绍 ​ exe4j是一个帮助你集成Java应用程序到Windows操作环境的java可执行文件生成工具&#xff0c;无论这些应用是用于服务器&#xff0c;还是图形用户界面&#xff08;GUI&#xff09;或命令行的应用程序。如果你想在任务管理器中及Windows XP分组的用户友好任务栏…
暂无图片
编程学习 ·

AUTOSAR从入门到精通100讲(126)-浅谈车载充电系统通信方案

01 引言 本文深入研究车载充电系统策略,设计出一套基于电动汽车电池管理系统与车载充电机的CAN通信协议,可供电动汽车设计人员参考借鉴。 02 电动汽车充电系统通讯网络 电动汽车整车控制系统中采用的是CAN总线通信方式,由一个整车内部高速CAN网络、内部低速CAN网络和一个充电…
暂无图片
编程学习 ·

CMake(九):生成器表达式

当运行CMake时&#xff0c;开发人员倾向于认为它是一个简单的步骤&#xff0c;需要读取项目的CMakeLists.txt文件&#xff0c;并生成相关的特定于生成器的项目文件集(例如Visual Studio解决方案和项目文件&#xff0c;Xcode项目&#xff0c;Unix Makefiles或Ninja输入文件)。然…
暂无图片
编程学习 ·

47.第十章 网络协议和管理配置 -- 网络配置(八)

4.3.3 route 命令 路由表管理命令 路由表主要构成: Destination: 目标网络ID,表示可以到达的目标网络ID,0.0.0.0/0 表示所有未知网络,又称为默认路由,优先级最低Genmask:目标网络对应的netmaskIface: 到达对应网络,应该从当前主机哪个网卡发送出来Gateway: 到达非直连的网络,…
暂无图片
编程学习 ·

元宇宙技术基础

请看图&#xff1a; 1、通过AR、VR等交互技术提升游戏的沉浸感 回顾游戏的发展历程&#xff0c;沉浸感的提升一直是技术突破的主要方向。从《愤怒的小鸟》到CSGO,游戏建模方式从2D到3D的提升使游戏中的物体呈现立体感。玩家在游戏中可以只有切换视角&#xff0c;进而提升沉浸…
暂无图片
编程学习 ·

flink的伪分布式搭建

一 flink的伪分布式搭建 1.1 执行架构图 1.Flink程序需要提交给 Job Client2.Job Client将作业提交给 Job Manager3.Job Manager负责协调资源分配和作业执行。 资源分配完成后&#xff0c;任务将提交给相应的 Task Manage。4.Task Manager启动一个线程以开始执行。Task Manage…
暂无图片
编程学习 ·

十进制正整数与二进制字符串的转换(C++)

Function one&#xff1a; //十进制数字转成二进制字符串 string Binary(int x) {string s "";while(x){if(x % 2 0) s 0 s;else s 1 s;x / 2;}return s; } Function two&#xff1a; //二进制字符串变为十进制数字 int Decimal(string s) {int num 0, …
暂无图片
编程学习 ·

[含lw+源码等]微信小程序校园辩论管理平台+后台管理系统[包运行成功]Java毕业设计计算机毕设

项目功能简介: 《微信小程序校园辩论管理平台后台管理系统》该项目含有源码、论文等资料、配套开发软件、软件安装教程、项目发布教程等 本系统包含微信小程序做的辩论管理前台和Java做的后台管理系统&#xff1a; 微信小程序——辩论管理前台涉及技术&#xff1a;WXML 和 WXS…
暂无图片
编程学习 ·

树莓派驱动DHT11温湿度传感器

1&#xff0c;直接使用python库 代码如下 import RPi.GPIO as GPIO import dht11 import time import datetimeGPIO.setwarnings(True) GPIO.setmode(GPIO.BCM)instance dht11.DHT11(pin14)try:while True:result instance.read()if result.is_valid():print(ok)print(&quo…
暂无图片
编程学习 ·

ELK简介

ELK简介 ELK是三个开源软件的缩写&#xff0c;Elasticsearch、Logstash、Kibana。它们都是开源软件。不过现在还新增了一个 Beats&#xff0c;它是一个轻量级的日志收集处理工具(Agent)&#xff0c;Beats 占用资源少&#xff0c;适合于在各个服务器上搜集日志后传输给 Logstas…
暂无图片
编程学习 ·

Linux 基础

通常大数据框架都部署在 Linux 服务器上&#xff0c;所以需要具备一定的 Linux 知识。Linux 书籍当中比较著名的是 《鸟哥私房菜》系列&#xff0c;这个系列很全面也很经典。但如果你希望能够快速地入门&#xff0c;这里推荐《Linux 就该这么学》&#xff0c;其网站上有免费的电…
暂无图片
编程学习 ·

Windows2022 无线网卡装不上驱动

想来 Windows2022 和 windows10/11 的驱动应该差不多通用的&#xff0c;但是死活装不上呢&#xff1f; 搜一下&#xff0c;有人提到 “默认安装时‘无线LAN服务’是关闭的&#xff0c;如果需要开启&#xff0c;只需要在“添加角色和功能”中&#xff0c;选择开启“无线LAN服务…
暂无图片
编程学习 ·

【嵌入式面试宝典】版本控制工具Git常用命令总结

目录 创建仓库 查看信息 版本回退 版本检出 远程库 Git 创建仓库 git initgit add <file> 可反复多次使用&#xff0c;添加多个文件git commit -m <message> 查看信息 git status 仓库当前的状态git diff 差异对比git log 历史记录&#xff0c;提交日志--pret…
暂无图片
编程学习 ·

用Postman生成测试报告

newman newman是一款基于nodejs开发的可以运行postman脚本的工具&#xff0c;使用Newman&#xff0c;可以直接从命令运行和测试postman集合。 安装nodejs 下载地址&#xff1a;https://nodejs.org/en/download/ 选择自己系统相对应的版本内容进行下载&#xff0c;然后傻瓜式安…
暂无图片
编程学习 ·

Java面向对象之多态、向上转型和向下转型

文章目录前言一、多态二、引用类型之间的转换Ⅰ.向上转型Ⅱ.向下转型总结前言 今天继续Java面向对象的学习&#xff0c;学习面向对象的第三大特征&#xff1a;多态&#xff0c;了解多态的意义&#xff0c;以及两种引用类型之间的转换&#xff1a;向上转型、向下转型。  希望能…