c++ assert 的用法和注意事项

assert在程序的release版本中仍然有效（不要与VC中的ASSERT混淆），要使assert失效，只有在包含assert头文件（assert.h）的语句前定义NDEBUG宏或在编译器参数中添加-DNDEBUG参数。

********************************************************相关文章转载**********************************************

#来自http://community.csdn.net/Expert/topic/4342/4342874.xml?temp=.2288935

当构造一个应用程序的时候，应该始终记住：应该让程序在出现bug或非预期的错误的时候，应该让程序尽可能早地突然死亡。这样做可以帮助你在开发——测试循环中尽早地发现错误。不导致突然死亡的错误将很难被发现；它们通常会被忽略，直到程序在客户系统中运行以后才被注意到。
    检查非预期状态的最简单的方式是通过标准C库的assert宏。这个宏的参数是一个布尔表达式（Boolean expression）。当表达式的值为假的时候，assert会输出源文件名、出错行数和表达式的字面内容，然后导致程序退出。Assert宏可用于大量程序内部需要一致性检查的场合。例如，可以用assert检查程序参数的合法性、检查函数（或C++中的类方法）的前提条件和最终状态（postcondition）、检查非预期的函数返回值，等等。
    每次使用assert宏，不仅可以作为一项运行期的检查，还可以被当作是嵌入代码中的文档，用于指明程序的行为。如果你的程序中包含了assert( condition )，它就是在告诉阅读代码的人：condition在这里应该始终成立；否则很可能是程序中的bug。
    对于效率至上的代码，assert这样的运行时检查可能引入严重的效率损失。在这种情况下，你可以定义NDEBUG宏并重新编译源码（可以通过在编译器参数中添加 –DNDEBUG参数做到）。在这种情况下，assert宏的内容将被预处理器清除掉。应该只在当效率必须优先考虑的情况下，对包含效率至上的代码的文件设置NDEBUG宏进行编译。
    因为assert可能被预处理过程清除，当使用这个宏的时候必须确信条件表达式不存在副作用。特别的，不应该在assert的条件表达式中使用这些语句：函数调用、对变量赋值、使用修改变量的操作符（如 ++ 等）。

    例如，假设你在一个循环中重复调用函数do_something。这个函数在成功的情况下返回0，失败则返回非0值。但是你完全不期望它在程序中出现失败的情况。你可能会想这样写：
for (i = 0; i < 100; ++i)
  assert (do_something () == 0);

    不过，你可能发现这个运行时检查引入了不可承受的性能损失，并因此决定稍候指定NDEBUG以禁用运行时检测。这样做的结果是整个对assert的调用会被完全删除，也就是说，assert宏的条件表达式将永远不会被执行，do_something一次也不会被调用。因此，这样写才是正确的：
for (i = 0; i < 100; ++i) {
  int status = do_something ();
  assert (status == 0);
}

    另外一个需要记住的是，不应该使用assert去检测不合法的用户输入。用户即使在输入不合适的信息后也不希望看到程序仅在输出一些含义模糊的错误信息后崩溃。你应该检查用户的非法输入并向用户返回可以理解的错误信息。只当进行程序内部的运行时检查时才应使用assert宏。
    一些建议使用assert宏的地方：
    &#8226; 检查函数参数的合法性，例如判断是否为NULL指针。由 { assert (pointer != NULL)} 得到的错误输出
    Assertion ‘pointer != ((void *)0)’ failed.
    与当程序因对NULL指针解引用得到的错误信息
    Segmentation fault (core dumped)
    相比而言要清晰得多。

    &#8226; 检查函数参数的值。例如，当一个函数的foo参数必须为正数的时候我们可以在函数开始处进行这样的检查：
    assert (foo > 0);
    这会帮助你发现错误的调用；同时它很清楚地告诉了读代码的人：这个函数对参数的值有特殊的要求。

    不要就此退缩；在你的程序中适当地时候使用assert宏吧。

www.AdvancedLinuxProgramming.com
英文版版权归原作者
完美废人 翻译

*****************************************************************************************************************

断言（ASSERT)的用法

　　我一直以为assert仅仅是个报错函数，事实上，它居然是个宏，并且作用并非“报错”。

　　在经过对其进行一定了解之后，对其作用及用法有了一定的了解，assert()的用法像是一种“契约式编程”，在我的理解中，其表达的意思就是，程序在我的假设条件下，能够正常良好的运作，其实就相当于一个if语句：

if(假设成立)
{
     程序正常运行；
}
else
{
      报错&&终止程序！（避免由程序运行引起更大的错误）  
}

　　但是这样写的话，就会有无数个if语句，甚至会出现，一个if语句的括号从文件头到文件尾，并且大多数情况下，我们要进行验证的假设，只是属于偶然性事件，又或者我们仅仅想测试一下，一些最坏情况是否发生，所以这里有了assert().

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

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

　　assert的作用是现计算表达式 expression ，如果其值为假（即为0），那么它先向stderr打印一条出错信息,然后通过调用 abort 来终止程序运行。
 使用assert的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。 
　　在调试结束后，可以通过在包含#include 的语句之前插入 #define NDEBUG 来禁用assert调用，示例代码如下： 

1 #include 
2 #define NDEBUG 
3 #include

 　　用法总结与注意事项： 

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

 1 int resetBufferSize(int nNewSize) 
 2 { 
 3 //功能:改变缓冲区大小, 
 4 //参数:nNewSize 缓冲区新长度 
 5 //返回值:缓冲区当前长度 
 6 //说明:保持原信息内容不变 nNewSize<=0表示清除缓冲区 
 7 assert(nNewSize >= 0); 
 8 assert(nNewSize <= MAX_BUFFER_SIZE); 
 9  
10 ... 
11 } 

　　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）。 

以下是使用断言的几个原则： 
　　 
　　（1）使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的。 
　　 
　　（2）使用断言对函数的参数进行确认。 
　　 
　　（3）在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查。 
　　 
　　（4）一般教科书都鼓励程序员们进行防错性的程序设计，但要记住这种编程风格会隐瞒错误。当进行防错性编程时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。 
  
　　ASSERT ()是一个调试程序时经常使用的宏，在程序运行时它计算括号内的表达式，如果表达式为FALSE (0), 程序将报告错误，并终止执行。如果表达式不为0，则继续执行后面的语句。这个宏通常原来判断程序中是否出现了明显非法的数据，如果出现了终止程序以免导致严重后果，同时也便于查找错误。  

ASSERT只有在Debug版本中才有效，如果编译为Release版本则被忽略。