assert() 断言的用法

转载自：http://www.diybl.com/course/3_program/c++/cppjs/20071111/85534.html

ASSERT ()是一个调试程序时经常使用的宏，在程序运行时它计算括号内的表达式，如果表达式为FALSE (0), 程序将报告错误，并终止执行。如果表达式不为0，则继续执行后面的语句。这个宏通常原来判断程序中是否出现了明显非法的数据，如果出现了终止程序以免导致严重后果，同时也便于查找错误。ASSERT只有在Debug版本中才有效，如果编译为Release版本则被忽略。  

assert宏的原型定义在assert.h中，其作用是如果它的条件返回错误，则终止程序执行。原型定义:

#define ASSERT(f)   
do  
 {   
        if (!(f) && AfxAssertFailedLine(THIS_FILE, __LINE__))  
                AfxDebugBreak();   
 } while (0)

使用方法为：

ASSERT(逻辑表达式)

如果括号中的逻辑表达式值为假的话，会弹出调试命令窗口，提示具体在哪个文件的哪一行发生了断言错误！

#include "assert.h"  
void assert( int expression );

assert的作用是现计算表达式 expression ，如果其值为假（即为0），那么它先向stderr打印一条出错信息,然后通过调用 abort 来终止程序运行。　　

请看下面的程序清单badptr.c：

#include   
#include   
#include   
int main( void )   
{   
 　　 FILE *fp;   
 　　 fp = fopen( "test.txt", "w" );//以可写方式打开一个文件，如果不存在就创建一个同名文件   
 　　 assert( fp ); //所以这里不会出错   
 　　 fclose( fp );   

 　　 fp = fopen("noexitfile.txt", "r" );//以只读方式打开一个文件，如果不存在就打开文件失败   
 　　 assert( fp ); //所以这里出错   

 　　 fclose( fp ); //程序永远都执行不到这里来  
 
 　　 return 0;   
 　　} 

使用assert的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。在调试结束后，可以通过在包含#include 的语句之前插入 #define NDEBUG 来禁用assert调用，示例代码如下：

#include  
#define NDEBUG  
#include

用法总结与注意事项：

1)在函数开始处检验传入参数的合法性

如: 　　

int resetBufferSize(int nNewSize)  

{   

 　　//功能:改变缓冲区大小,  

　　 //参数:nNewSize 缓冲区新长度  

 　　//返回值:缓冲区当前长度  

 　　//说明:保持原信息内容不变 nNewSize<=0表示清除缓冲区  

 　　assert(nNewSize >= 0);  

 

 　　assert(nNewSize <= MAX_BUFFER_SIZE);  

　　//...  

} 

2)每个assert只检验一个条件,因为同时检验多个条件时,如果断言失败,无法直观的判断是哪个条件失败

//不好: 
assert(nOffset>=0 && nOffset+nSize<=m_nInfomationSize);　　

//好: 
assert(nOffset >= 0);
assert(nOffset+nSize <= m_nInfomationSize);

3)不能使用改变环境的语句,因为assert只在DEBUG个生效,如果这么做,会使用程序在真正运行时遇到问题

　　错误: assert(i++ < 100)

　　这是因为如果出错，比如在执行之前i=100,那么这条语句就不会执行，那么i++这条命令就没有执行。

　　正确: assert(i < 100)

　　 i++;　　

4)assert和后面的语句应空一行,以形成逻辑和视觉上的一致感

5)有的地方,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 看成一个在任何系统状态下都可以安全使用的无害测试手段。　　

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

　　

　　以下是使用断言的几个原则：　　

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

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

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

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

 

断言(ASSERT)的使用，方法很简单。为什么要用，初学者可能比较迷惑。 

契约式编程讲的比较清楚，建议可以先看看这类书。 

一个函数由前置条件、后置条件和不变式组成。在VC中，我们可以通过断言来保证这三个条件。可以大大提高了软件的质量。

如果ASSERT()中的条件不成立(比如 ASSERT(0) ; ),会弹出一个比较吓人的对话框。 

点击重试，可以到达 ASSERT 断言不成立的那一行， 

此时可以在watch窗口查看变量值，找出出错的原因。 

如果程序能够继续运行，可以按F5继续调试。