防御式编程:理解断言

防御式编程:理解断言,第1张

理论部分摘自代码大全 理论部分摘自代码大全 在防御式驾驶中要建立这样一种思维,那就是你永远也不能确定另一位司机将要做什么。这样才能确保在其他人做出危险动作时你也不会受到危害。你要承担起保护自己的责任,哪怕是其他司机犯的错误。防御式编程的主要思想是:子程序应该不因传入错误数据而被破坏,哪怕是由其他子程序产生的错误数据。

断言是指在开发期间使用的、让程序在运行时进行自检的代码。断言为真,则表明程序运行正常;断言为假,则意味着它已经在代码中发现意料之外的错误。

断言可以用于在代码中说明各种假定,澄清各种不希望的情形。

断言主要是用于开发和维护阶段。通常,断言只是在开发阶段被编译到目标代码中。在开发阶段,断言可以查清相互矛盾的假定、预料之外的情况以及传给子程序的错误数据等。

在OC中,断言使用NSAssert函数,是一个宏。基本形式是两个参数,第一个参数是一个bool值:断言的结果,第二个参数是一个描述字符串。断言的结果为false时,第二个参数描述字符串会输出。

这里举例一段BlocksKit中的代码:

断言通常用来判断外部输入的参数是否正确,所以cocoa封装了一个检查参数的断言,与NSAssert相比方便的地方就是自动定义了一个输出字符串。

NSParameterAssert是一个封装了NSAssert的宏,定义如下:

在来看上面代码中这句断言的使用:御桥

这段代码的意图是用传入的block来代替某个对应delegate的方法,所以要检查一下传入的block和这个delegate上对应的方法签名是否一致。如果不一致则中断程序,抛出“Incompatible block”提示信息。

在swift中,断言用assert函数。两个参数和OC中的相同。

通过声明可以发现,断言中会记录当前文件和行号,但是这里赋了默认值,所以使用assert时可码昌以省略。

这里顺带提下代码规范,有些人有时为了方便会把几句代码写在一行。这样写一个潜在的坏处就是如果发生异常,日志中记录了行号。但是因为这一行有几句代码,增加了判断是由具体哪一句代码产生异常。应该避免将几句代码写在一行里。

断言还有一个经常使用的地方是单元测试。在单元测试中,XCode中封装了几个在测试中经常使用的断言。

这里列举AFN单元测试中用到了XCTAssert的代码,只截取部分带断言代码:

XCT(Xcode Test)中还有很多类似的断言,有兴趣可以自己查文档,这里就不列举了。

错误处理代码用来检查不太可能经常发生的非正常情况,这些情况在写代码时就预料到的,而且在产品代码中也要处理这些情况。而断言是用于检查代码中的bug,如果在发生异常的时候触发了断言,采取的措施就不仅仅是镇模猛对错误做出恰当的反应,而是应该修改源码并重新编译。可以把断言理解成一种注释,它说明了这个程序的假定。

断言的可以在编译器中设置关闭,如果你把一些 *** 作写在断言里,在某些情况下可能编译器会过滤掉这些代码。

这样写就很危险,应该这样写:

对于要求高健壮性的代码,可能项目非常庞大,超长的开发周期和很多的开发人员,也可能出现断言被触发但是没有被注意到,这时应该也处理一下触发断言时的错误。

欢迎关注我的微博: @没故事的卓同学

断言assert是一个宏,该宏在<assert>中,,当使用assert时候,给他个参数,即一个判读为真的表达式。预处理器产生测试该断言的代码,如果断言不为真,则发出一个错误信息告诉断言是什么以及它失败一会,程序会终止。

我们一般可以用在判断某件 *** 作是否成功上。

摘录林锐博士高质量编程一书中相关内容。

~~~~~~~~~~~~~~~~~~~~~~~~

程序一般分为Debug版本和Release版本,Debug版本用于内部调试,Release版本发行给用户使用。

断言assert是仅在Debug版本起作用的宏,它用于检查“不应该”发生的情况。以下是一个内存复制程序,在运行过程中,如果assert的参数为假,那么程序就会中止(一般地还会出现提示对话,说明在什么地方引发了assert)。

//复制不重叠的内存块

void memcpy(void *pvTo, void *pvFrom, size_t size)

{

void *pbTo = (byte *) pvTo

void *pbFrom = (byte *) pvFrom

assert( pvTo != NULL &&pvFrom != NULL )

while(size - - >0 )

*pbTo + + = *pbFrom + +

return (pvTo)

}

assert不是一个仓促拼凑起来的宏,为了不在程序的Debug版本和Release版本引起差别,assert不应该产生任何副作用。所以assert不是函数,而是宏。程序员可以把assert看历蔽成一个在任何系统状态下都可以安全使用的无害测试手段。

以下是使用断言慧烂神的几个原则:

1)使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别,后者是必然存在的并且是一定要作出处理的。

2)使用断言对函数的参数进行确认。

3)在编写函数时,要进行反复的考查,并且自问:“我打算做哪些假定?”一旦确定了的假定,就要使用断言对假定进行检查。

4)一般教科书都鼓励程序员们进行防错性的程前亏序设计,但要记住这种编程风格会隐瞒错误。当进行防错性编程时,如果“不可能发生”的事情的确发生了,则要使用断言进行报警。

下面介绍一下断言在JAVA中的使用,JAVA是从JDK1.4才开始支持断言的(添加了关键字assert),请注意老版的JRE不支持。

断言概述

编写代码时,我们总是会做出一些假设,断言就是用于在代码中捕捉这些假设

可以将断言看作是异常处理的一种高级形式

断言表示为一些布尔表达式,程序员相信在程序中的某个特定点该表达式值为真

可以氏槐滑在任何时候启用和禁用断言验证,因此可以在测试时启用断言而在部署时禁用断言。同样,程序投入运行后,最终用户在遇到问题时可以重新起用断言。

使用断言可以创建更稳定,品质更好且易于除错的代码

当需要在一个值为FALSE时中断当前 *** 作的话,歼腊可以使用断言

单元测试必须使用断言(Junit/JunitX)

除了类型检查和单元测试外,断言还提供了一种确定个种特性是否在程序中得到维护的极好的方法

使用断言使我们向按契约式设计更近了一部

常见的断言特性

前置条件断言:代码执行之前必须具备的特性

后置条件断言:代码执行之后必须具备的特性

前后不变断言:代码执行前后不能变化的特性

断言使用方式

断言可以有两种形式

1.assert Expression1

2.assert Expression1:Expression2

其中Expression1应该总是一个布尔值,Expression2是断言失败时输出的失败消息的字符串。如果Expression1为假,则抛出一个 AssertionError,这是一个错误,而不是一个异常,也就是说是一个不可控制异常(unchecked Exception),AssertionError由于是错误,所以可以不捕获,但不推荐这样做,因为那样会使你的系统进入不稳定状态。

起用断言

断言在默认情况下是关闭的,要在编译时启用断言,需要使用source1.4标记 既javac source1.4 Test.java ,在运行时启用断言需要使用 -ea参数 。要在系统类中启用和禁用断言可以使用 -esa 和 -dsa参数。

例如:

public class AssertExampleOne{

public AssertExampleOne(){}

public static void main(String args[]){

int x=10

System.out.println("Testing Assertion that x==100")

assert x=100"Out assertion failed!"

System.out.println("Test passed!")

}

}

如果编译时未加 -source1.4,则编译通不过

在执行时未加 -ea 时输出为

Testing Assertion that x==100

Test passed

jre忽略了断言的就代码,而使用了该参数就会输出为

Testing Assertion that x==100

Exception in thread "main" java.lang.AssertionError: Out assertion failed!

at AssertExampleOne.main(AssertExampleOne.java:6)

断言的副作用

由于程序员的问题,断言的使用可能会带来副作用 ,例如:

boolean isEnable=false

//...

assert isEnable=true

这个断言的副作用是因为它修改了程序中变量的值并且未抛出错误,这样的错误如果不细心的检查是很难发现的。但是同时我们可以根据以上的副作用明歼得到一个有用的特性,根据它来测试断言是否打开。

public class AssertExampleTwo{

public static void main(String args[]){

boolean isEnable=false

//...

assert isEnable=true

if(isEnable==false){

throw new RuntimeException("Assertion shoule be enable!")

}

}

}

何时需要使用断言

1.可以在预计正常情况下程序不会到达的地方放置断言 :assert false

2.断言可以用于检查传递给私有方法的参数。(对于公有方法,因为是提供给外部的接口,所以必须在方法中有相应的参数检验才能保证代码的健壮性)

3.使用断言测试方法执行的前置条件和后置条件

4.使用断言检查类的不变状态,确保任何情况下,某个变量的状态必须满足。(如age属性应大于0小于某个合适值)

什么地方不要使用断言

断言语句不是永远会执行,可以屏蔽也可以启用

因此:

1.不要使用断言作为公共方法的参数检查,公共方法的参数永远都要执行

2.断言语句不可以有任何边界效应,不要使用断言语句去修改变量和改变方法的返回值

下边是介绍断言的用法:

assert是在J2SE1.4中引入的新特性,assertion就是在代码中包括的布尔型状态,程序员认为这个状态是true。一般来说assert在开发的时候是检查程序的安全性的,在发布的时候通常都不使用assert。在1.4中添加了assert关键字和java.lang.AssertError类的支持。

首先,我们有必要从一个例子说起assert

public class AssertTest

{

public static void main(String[] args)

{

AssertTest at = new AssertTest()

at.assertMe(true)

at.assertMe(false)

}

private void assertMe(boolean boo)

{

assert boo?true:false

System.out.println("true condition")

}

}

程序中包含了assert的话,你要用javac -source 1.4 xxx.java来编译,否则编译器会报错的。要想让assert得部分运行的话,要使用java -ea xxx来运行,否则包含assert得行会被忽略。下面我们运行

javac -source 1.4 AssertTest.java

java -ea AssertTest

看看结果的输出是:

true condition

Exception in thread "main" java.lang.AssertionError

at AssertTest.assertMe(AssertTest.java:13)

at AssertTest.main(AssertTest.java:7)

当我们运行at.assertMe(true)得时候,由于assert boo?true:false相当于 assert true因此没有任何问题,程序往下执行打印出true condition,但是执行at.assertMe(false)的时候相当于assert false,这个时候解释器就会抛出AssertionError了,程序就终止了。大家必须清楚AssertionError是继承自Error得,因此你可以不再程序中catch它的,当然你也可以在程序中catch它然后程序可以继续执行。例如:

public class AssertTest

{

public static void main(String[] args)

{

AssertTest at = new AssertTest()

try

{

at.assertMe(true)

at.assertMe(false)

}

catch(AssertionError ae)

{

System.out.println("AsseriontError catched")

}

System.out.println("go on")

}

private void assertMe(boolean boo)

{

assert boo?true:false

System.out.println("true condition")

}

}

assert还有另外一种表达的方式,就是assert exp1:exp2其中exp1是个boolean返回值得表达式,而exp2可以是原始的数据类型或者对象都可以例如:

boolean boo = true

String str = null

assert boo = false:str="error"

我们刚开始讲得assert exp1得形式,当exp1是false得时候,AssertionError得默认构造器会被调用,但是assert exp1:exp2这样的形式,当exp1为true的时候后面exp2被或略,如果false的话,后面的表达式的结果会被计算出来并作为AssertionError得构造器参数。看下面的例子:

public class AssertTest

{

public static void main(String[] args)

{

AssertTest at = new AssertTest()

at.assertMe(true)

at.assertMe(false)

}

private void assertMe(boolean boo)

{

String s = null

assert boo?true:false:s = "hello world"

System.out.println("true condition")

}

}运行的时候会得到这样的结果

true condition

Exception in thread "main" java.lang.AssertionError: hello world

at AssertTest.assertMe(AssertTest.java:14)

at AssertTest.main(AssertTest.java:7)

Assert最好不要滥用,原因是assert并不一定都是enable的,下面两种情况就不应该用assert

不要再public的方法里面检查参数是不是为null之类的 *** 作

例如public int get(String s)

{

assert s != null

}

如果需要检查也最好通过if s = null 抛出NullPointerException来检查

不要用assert来检查方法 *** 作的返回值来判断方法 *** 作的结果

例如 assert list.removeAll()这样看起来好像没有问题 但是想想如果assert 被disable呢,那样他就不会被执行了 所以removeAll() *** 作就没有被执行 可以这样代替

boolean boo = list.removeAl()

assert boo

就说这么多吧,assert是scjp1.4的考试内容 所以还是有必要了解的


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/yw/12542566.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-26
下一篇 2023-05-26

发表评论

登录后才能评论

评论列表(0条)

保存