VC++中的ASSERT断言

一、

摘自《高质量C/C++编程指南》Page 41-42...

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

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

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

{

    assert((pvTo != NULL)&& (pvFrom != NULL)); // 使用断言

    byte *pbTo = (byte *)pvTo; // 防止改变pvTo 的地址

    byte *pbFrom = (byte *)pvFrom; // 防止改变pvFrom 的地址

    while(size -- > 0)

       *pbTo ++ = *pbFrom ++ ;

    return pvTo;

}

示例6-5 复制不重叠的内存块

assert 不是一个仓促拼凑起来的宏。为了不在程序的Debug 版本和Release 版本引起差别，assert 不应该产生任何副作用。所以assert 不是函数，而是宏。程序员可以把assert看成一个在任何系统状态下都可以安全使用的无害测试手段。如果程序在assert 处终止了，并不是说含有该assert的函数有错误，而是调用者出了差错，assert 可以帮助我们找到发生错误的原因。

很少有比跟踪到程序的断言，却不知道该断言的作用更让人沮丧的事了。你化了很多时间，不是为了排除错误，而只是为了弄清楚这个错误到底是什么。有的时候，程序员偶尔还会设计出有错误的断言。所以如果搞不清楚断言检查的是什么，就很难判断错误是出现在程序中，还是出现在断言中。幸运的是这个问题很好解决，只要加上清晰的注释即可。这本是显而易见的事情，可是很少有程序员这样做。这好比一个人在森林里，看到树上钉着一块“危险”的大牌子。但危险到底是什么？树要倒？有废井？有野兽？除非告诉人们“危险”是什么，否则这个警告牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略，甚至被删除。

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

【规则6-5-2】在函数的入口处，使用断言检查参数的有效性（合法性）。

【建议6-5-1】在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查。

【建议6-5-2】一般教科书都鼓励程序员们进行防错设计，但要记住这种编程风格可能会隐瞒错误。当进行防错设计时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。

ASSERT宏中应该包含的元素：

判断条件；输出当前断言失败的位置（文件、行数等）；返回错误；终止程序...

几种典型的ASSERT的写法：

VC中的写法：

#defineASSERT(f) \

do \

{ \

  if (!(f) && AfxAssertFailedLine(THIS_FILE, __LINE__)) \

  AfxDebugBreak(); \

} while(0) \

#define_ASSERT(expr) \

       do { if (!(expr) && \

               (1 == _CrtDbgReport(_CRT_ASSERT, __FILE__, __LINE__, NULL, NULL))) \

            _CrtDbgBreak(); } while (0)

其他平台的写法：

# defineASSERT(x) ((x) || (dbg_printf("assertion failed ("__FILE__":%d):\"%s\"\n",__LINE__,#x), break_point(), FALSE))

 

二、

前不久看到一文章,说用assert的时候不要把非法情形和错误情形混淆了,错误始终是要处理的.

然后我review自己最近写的代码,愣是没有弄明白什么是非法什么是错误,难道错误不是非法么,非法不是错误么?

我本身用assert是相当频繁和随意的,但是经过这么一看,反而觉得原来那些assert的代码都要改成错误处理了...

花非花,雾非雾.

经过思考与实践,最终确定了规则.

非法情形,大部分你觉得有问题的地方,需要约束的地方,都可以认为可能存在非法情形.比如指针有效性,字符串长度,数值范围等等.更抽象的说,非法情形存在于动作开始执行前的状态中.

相对之,错误就是动作执行之后的结果,错误是针对执行结果的.

详细而言,当调用一个函数,进入函数体的时候,就进入了一个非法情形出现点,在这里,在执行任何具体的计算和动作之前,面对参数还有其他状态,你嗅到的任何东西都可以说是非法情形.然后函数开始执行,这里面所出现的任何(大多数)失败都是一种错误,需要进行处理.

需要着重强调的是,函数的执行结果(返回值)绝对是一种错误(如果返回值是那个意思的话),而不是非法状态.(考虑一种计算函数,它的返回结果限制在某个范围内,这是非法状态还是错误呢?我认为还是错误,虽然有些像非法状态,要进行更严格的处理和提示).

我极度强调在函数执行前确认非法状态,而不是当成错误处理(通常这种处理都是默默的,不透明的,不像assert那样嚣张-_-|||).因为我们写函数(接口)的目的,是希望能被正确的调用,而不是胡乱(导致局部或者整体状态混乱)的使用(为此我们居然要将assert写成错误处理的形式,以容忍各种白痴的调用行为).

但是有一些情形,在不得以的情况下,比如一个函数,要assert某个指针是有效的,然后才能执行某些动作,但是随后的执行状况是,极度可能在那个指针无效的时候却仍然不可避免的调用该函数,那么你就把assert简单的用if替换掉就是了,没什么难的.但是,第一次写下那个函数的时候,吓你一跳的assert永远是不二的选择,如果你直接就用了if之类的错误处理,后面出什么状况就不是那么显眼了.

正确的滥用assert吧,至少我是这么做的.

 

三、

程序一般分为Debug 版本和Release 版本，Debug 版本用于内部调试，Release 版本发行给用户使用。（这个概念可能不大好理解，想想VC下，调试时有个选项，一个是debug，一个是release）

assert(表达式);     的意思是：当表达式为真时，程序继续运行，如果表达市为假，那程序就会停止运行，并提示错误信息。

注意：assert是一个宏，只在debug版本中起作用，在release版本中，该语句是不起任何作用的。

先简单的看一个例子吧！

以下为一个使用了断言的C源程序：

#include<stdio.h>

#include<assert.h>

voidtest(int *p)

{

 assert(p != NULL);

 printf("%d\n", *p);

}

intmain(void)

{

 test(NULL);

}

 

编译及运行结果：

Qdieyou@qdieyou/cygdrive/e/gcc

$ gcc -oassert assert.c

Qdieyou@qdieyou/cygdrive/e/gcc

$./assert

assertion"p != NULL" failed: file "assert.c", line 6

19331[sig] assert 3288 e:\gcc\assert.exe: *** fatal error - called with threa

dlist_ix-1

Hangup

 

程序说明：由于我们在main函数中传了NULL指针值给test函数，在test函数执行到assert(p != NULL);发现表达式不为真，就终止了程序的运行，并提示错误的行数信息。

注意：由于assert宏只在debug版本中起作用，所以assert一般只用于内部函数对参数有效性进行检查，如果该函数作为一个外部接口来使用时，一般需要利用if，else语句进行防错设计。