文档开发者中心
我的

【综合】【码手防御-1】防御式编程

作者:HW-HM


开篇打算谈谈防御式编程和契约式设计的概念。

先看看什么是契约,契约一般作用于两方,用于乙方为甲方完成一些任务,通常会形成正式的合同。契约合同明确地规定了双方的权力和义务,对于甲方(客户),合同规定了乙方(供应者)要做的工作;对于乙方,合同说明了如果约定的条件不满足,乙方没有义务一定要完成规定的任务。契约的好处就是避免了扯皮。

同样的道理也适合于软件,函数调用者就是甲方,函数实现者就是乙方。如果调用者传入的参数不符合函数要求,就别指望返回的结果正确,系统崩溃了也只能怪调用者自己,就是说调用者要负全责。如果调用者传入的参数满足函数要求,返回结果不对,那就是实现者有问题了。而在契约体制下,对于契约的检查并非义务,实际上是在履行权利。请看如下代码(当调用者传入空指针参数):

if (dest == NULL) { ... }

这就是义务,我方(义务方)必须负责以合适手法处理这尴尬局面,通常返回错误值。而:

assert(dest != NULL);

这是检查契约,履行权利。如果条件不满足,那么错误在对方而不在我,我可以立刻罢工了事,当然我也可以不行使这个权力,当作什么也没发生继续执行下去,天知道会发生什么。

契约式设计(Design by Contract):明确定义软件模块的权力和义务,并通过程序来检查,以确保程序正确性。软件的契约包括三个方面:

1、 先验条件:进入一段代码(函数)之前必须满足的条件,这是调用者的义务,实现者的权力。如果不满足,说明调用者有缺陷。

2、 后验条件:退出一段代码(函数)之后必须满足的条件,这是实现者的义务,调用者的权力。这如果不满足,说明实现者有缺陷。

3、 不变条件:在进入之前满足,在退出之后也要满足的条件,通常针对一个类。这是双方的权力和义务。如果不满足,说明程序有缺陷。

白纸黑字才是契约,契约应该写在代码里(注释和assert检查),写在接口文档里。如果只是存在于两个人或两个团队的脑子里,迟早要扯皮,要嗝屁。

什么是防御式编程呢?就是当契约不满足(或没有契约)时,程序不要嗝屁或行为不定。正式一点的说法是:防御式编程(Defensive Programming)是通过代码显式检查假定(契约)来使程序免于非法调用产生错误行为。也就是说,尽早行使权力,条件不满足时,妥善处理而不总是罢工了事。广义地讲,防御式编程是为了防错,是预防,一切能够防止程序错误的行为都是防御式编程。

契约式设计与防御性编程是什么关系呢?

契约式设计通常适用于一个系统(或应用)内部,因为外部系统你没法约束它,况且还有黑客的恶意攻击,对外部系统(或界面)的各种交互都是程序的正常逻辑需要处理的。契约式作用于内部,对内部假定使用断言而不是错误处理代码,当断言为假时,表明程序出现了BUG,而这样的断言在发布的版本中通常会去掉;契约式设计是为了保证程序的正确性。防御式编程重点关注与外部打交道的地方,这里的外部包括其他系统、界面输入、系统资源等,你不能对他们做任何假定,你不能假设内存足够、不能假设对外部系统的请求会立即返回、不能假设用户输入合法,所有这些都是代码的正常逻辑;防御式编程是为了保证系统的健壮性,不要做任何设想,遇到非法情况要不不输出,要么输出错误信息。

是否契约不满足就一定是BUG呢?在先验条件满足的情况下,实现者因客观原因(例如系统资源不足)不能完成任务可以抛出异常,这就是告诉调用者,后验条件没有满足,你不能按照正常逻辑走了。这也是我们认为的真正的异常:对方完全满足了契约,而我方仍然没有如约完成任务。

防御式编程是不是一定不能嗝屁呢?防御式编程重在检查发现问题,发现不满足条件后如何处理要看情况,有很多处理方式,譬如记录日志、提示错误、重启等,当然有意的嗝屁也是一种处理方式。如果确认是严重BUG,再玩下去只会一错再错,那么abort也是OK的,不过这种情况几乎没有,这样的产品,你敢发布么?

点赞
收藏
回复
10
分享
举报
浏览2555 发布于2019-11-20 02:58未知归属地
全部评论
最多点赞
最新发布
最早发布

在点个赞

10楼回复于2019-11-22 06:39 未知归属地

转走了楼主

9楼回复于2019-11-22 06:39 未知归属地

好文值得推荐

8楼回复于2019-11-22 06:39 未知归属地

系列阅读:【码手防御-2】契约式设计原则

7楼回复于2019-11-21 06:15 未知归属地

系列阅读:【码手防御-3】防御式编程技术

6楼回复于2019-11-21 06:14 未知归属地

期待下一篇呦

5楼回复于2019-11-20 08:36 未知归属地

好帖子就要顶起来

4楼回复于2019-11-20 08:36 未知归属地

经典经典

3楼回复于2019-11-20 06:58 未知归属地

希望尽快发出这个系列的其他文章,期待!

2楼回复于2019-11-20 06:58 未知归属地

主题明确,深深的打动人心,引发共鸣。

1楼回复于2019-11-20 06:58 未知归属地
写回答
新增插入模板功能
一键使用模板,快速填写内容,轻松发帖~
知道了
  • 为了保障您的信息安全,请勿上传您的敏感个人信息(如您的密码等信息)和您的敏感资产信息(如关键源代码、签名私钥、调试安装包、业务日志等信息),且您需自行承担由此产生的信息泄露等安全风险。
  • 如您发布的内容为转载内容,请注明内容来源。

我要发帖子

了解社区公约,与您携手共创和谐专业的开发者社区。