ASSERT()



断言（ASSERT)的用法

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

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

 

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

 

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

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

#include "assert.h"

void assert( int expression );

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

#include <stdio.h>
#define NDEBUG
#include <assert.h>

 　　用法总结与注意事项： 

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

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

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

MSDN原文如是说：

Evaluates an expression and, when theresult is false, prints a diagnostic message and aborts the program.

（判断一个表达式，如果结果为假，输出诊断消息并中止程序。）

void assert(   

   int expression   

);  

参数：Expression (including pointers) that evaluates to nonzero or 0.（表达式【包括指针】是非零或零）

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

MSDN示例程序;

// crt_assert.c  

// compile with: /c  

#include <stdio.h>  

#include <assert.h>  

#include <string.h>  

  

void analyze_string( char *string );   // Prototype  

  

int main( void )  

{  

   char  test1[] = "abc", *test2 = NULL, test3[] = "";  

  

   printf ( "Analyzing string '%s'\n", test1 ); fflush( stdout );  

   analyze_string( test1 );  

   printf ( "Analyzing string '%s'\n", test2 ); fflush( stdout );  

   analyze_string( test2 );  

   printf ( "Analyzing string '%s'\n", test3 ); fflush( stdout );  

   analyze_string( test3 );  

}  

  

// Tests a string to see if it is NULL,   

// empty, or longer than 0 characters.  

void analyze_string( char * string )  

{  

   assert( string != NULL );        // Cannot be NULL  

   assert( *string != '\0' );       // Cannot be empty  

   assert( strlen( string ) > 2 );  // Length must exceed 2  

}  

输出结果

Analyzing string 'abc'  

Analyzing string '(null)'  

Assertion failed: string != NULL, file assert.cpp, line 25  

abnormal program termination 

 

加入#define NDEBUG之后，上文第一个例子输出结果为：

Analyzing string 'abc'  

Analyzing string '(null)'  

Analyzing string ''  

 

在面试中经常用到的一个题目：

已知memcpy的函数为： void* memcpy(void *dest , const void* src , size_t count)其中dest是目的指针，src是源指针。不调用c++/c的memcpy库函数，请编写memcpy。

 

void* memcpy(void *dst, const void *src, size_t count)      

{      

    //安全检查  

    assert( (dst != NULL) && (src != NULL) );      

  

    unsigned char *pdst = (unsigned char *)dst;      

    const unsigned char *psrc = (const unsigned char *)src;      

  

    //防止内存重复  ,还未复制的内容被复制的内容覆盖掉了

    assert(!(psrc<=pdst && pdst<psrc+count));      

    assert(!(pdst<=psrc && psrc<pdst+count));      

  

    while(count--)      

    {      

        *pdst = *psrc;      

        pdst++;      

        psrc++;      

    }      

    return dst;      

}