The differences between assert , TRACE, ASSERT, VERIFY

今天在路上遇见一个朋友，他急忙地问我关于断言assert的作用，原来他是要去参加面试。关于assert, TRACE, ASSERT, VERIFY这几个宏，以前在编程的时候总结过一些它们的用法，使用的时候比较简单，但是要详细完整地说出它们的作用还是查一下资料好。下面是查阅的一些资料将其整理如下：( 欢迎大家指正:) )

---

From:《高质量程序设计指南——C++/C语言(第3版)》P.116

如何使用断言(assert)？

断言(assert)的语义如下：如果表达式的值为0(假)，则输出错误消息并终止程序的执行(一般还会出现提示对话框，说明在什么地方引发了

assert)；如果表达式为非0(真)，则不进行任何操作。因此断言失败表明程序存在一个bug。

C++/C的宏assert(expression)就是这样的断言，当表达式为假时，调用库函数abort()终止程序。

程序一般分为Debug版本和Release版本，Debug版本用于内部调试，Release版本发行给用户使用(感觉这种解释有点儿多余)。由于assert(expression)的宏体全部被条件编译伪指令#ifdef _DEBUG和#endif所包含，因此assert()只能在Debug版本里有效。

assert不是一个仓促拼凑起来的宏。为了不在程序的Debug版本和Release版本中造成差别，assert不应该带来任何副作用。所以assert不是函数，而是宏。(这句话不太理解，难道是函数就有差别吗？)

程序员可以把assert看成一个在任何系统状态下都可以安全使用的无害测试手段。所以不要把程序中的assert语句删除掉。

[note 1]:
如果程序在assert处终止了，并不是说含有该assert的函数有错误，而是调用函数出了差错，(这句话好像也不太准确，觉得表述为，如果出现了assert错误，说明assert(expression)中的expression为FALSE，这样理解容易些)。assert可以帮助我们(程序员)追踪到错误发生的原因。

[note 2]:
在函数的入口处，建议使用assert来检查参数的有效性(合法性)。
例如：
内存拷贝函数memcpy，如果assert的expression为假，那么程序就会中止。这样就可以检查程序对memcpy()的调用是否正确。

#include <assert.h> //assert头文件 #include <string.h>//memcpy库函数头文件 typedef unsigned char byte; //typedef unsigned int size_t; //memcpy相当于复制(要保留源数据)，memmove相当于剪切(不保留源数据) void *memcpy(void *pvTo, const void *pvFrom, size_t size) { assert((pvTo != NULL) && (pvFrom != NULL)); // 使用断言，防止pvTo或pvFrom为NULL byte *pbTo = (byte *) pvTo; // 防止改变pvTo的地址 byte *pbFrom = (byte *) pvFrom; // 防止改变pvFrom的地址 assert(pbTo >= pbFrom + size || pbFrom >= pbTo + size); // 防止内存重叠(overlap)，要保留源数据 while(size-- > 0) { *pbTo++ = *pbFrom++ ; } return pvTo; } //测试用例 char src[]="*********"; char dst[]="abcdefghijklmnopqrstuvwxyz"; char *ptr; ptr=(char *)memcpy(dst,src,sizeof(src)/sizeof(char)); // print "*********" ptr=(char *)memcpy(dst,src,3); // print "***defghijklmnopqrstuvwxyz"

[note 3]:
请给assert语句加注释，告诉人们assert语句究竟要干什么。

[note 4]:
要注意assert语句仅仅在Debug版本中才有效，而在Release版本中无效。使用assert的目的是捕捉在运行时不应该发生的非法情况(而不是错误情况)。什么是错误情况？

例如：
用malloc返回NULL，动态内存申请失败不是非法情况，而是错误情况。所以我们要用if语句主动捕捉错误情况并给出错误处理代码，而不应该使用assert，否则在Release版本中失效。

//错误示例 int *pBuf=(int*)malloc(sizeof(int)*1000); assert(pBuf!=NULL); // 错误地使用assert //... // do something //正确示例 int *pBuf=(int*)malloc(sizeof(int)*1000); if (NULL==pBuf) { //... // 错误处理代码 } else { //... // 正确处理代码 }

[note 5]:
一般教科书都鼓励程序员们进行防错程序设计，但要知道这种编程风格可能会隐瞒错误。当进行防错设计时，如果“不可能发生”的事情的确发生了，则要使用assert进行报警。

[note 6]:
要区分assert和跟踪语句tracer的不同。tracer是指一些用于报告程序执行过程中当前状态的输出语句，相当于printf的作用，但输出的不一定是bug。

[note 7]:
程序通过了assert的检查，并不保证就万无一失了。

例如：

memcpy()中的assert，如果给它传入了两个未初始化的野指针(wild pointer，地址不为0但是没有指向合法的内存块)，那么assert()就失去了作用。(所以，我们程序员在使用函数之前，应该避免一些非法操作)

[note 8]:
ASSERT宏中应该包含的元素：判断条件、输出当前断言失败的位置(文件、行数等)、返回错误、终止程序...

[note 9]:
几种典型的ASSERT的写法。

//VC中的写法： #define ASSERT(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) //其他平台的写法： # define ASSERT(x) ((x) || (dbg_printf("assertion failed ("__FILE__":%d): /"%s/"/n",__LINE__,#x), break_point(), FALSE))

简要概括

断言类型 定义 ANSI C 断言 void assert( int expression ); C Runtime Lib 断言 _ASSERT( booleanExpression ); _ASSERTE( booleanExpression ); MFC 断言 ASSERT( booleanExpression ); VERIFY( booleanExpression ); ASSERT_VALID( pObject ); ASSERT_KINDOF( classname, pobject ); ATL 断言 ATLASSERT( booleanExpression ); [assert] 接收一个expression，如果expression为TRUE，则无动作，否则中断当前程序执行。而且只在debug版本中出现，在release版本中被忽略。 [TRACE] 接收跟printf一样的参数。在debug版的调试状态下出现，用于在debug窗口中输出信息。在release版本中被忽略。 [ASSERT] 接收一个expression，如果expression为TRUE，则无动作，否则中断当前程序执行。在debug版本下出现。对于系统中出现这个宏导致的中断，应该认为你的函数调用未能满足系统的调用此函数的前提条件。例如，对于一个还没有创建的窗口调用SetWindowText等。它与assert的区别在于，ASSERT出现在MFC中。在release版本中被忽略。 [VERIFY] 和ASSERT功能类似。所不同的是，在release版本中，ASSERT不计算输入的表达式的值，而VERIFY计算表达式的值。 注意： VERIFY()宏，这个宏允许你将程序代码放在布尔表达式里。这个宏通常用来检查 Windows API 的返回值。有些人可能为这个原因而滥用VERIFY() ，事实上这是危险的，因为VERIFY() 违反了断言的思想，不能使程序代码和调试代码完全分离，最终可能会带来很多麻烦。因此，专家们建议尽量少用这个宏。 总而言之: assert, TRACE, ASSERT只在debug版本中起作用(除VERIFY)，且TRACE, ASSERT, VERIFY仅仅在MFC可用。