C++ Assert()断言机制原理以及使用方法之美

MSDN原文如是说：

Evaluates an expression and, when the result 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

用法总结：

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不能代替条件过滤

ASSERT只有在Debug版本中才有效，如果编译为Release版本则被忽略掉。（在C中，ASSERT是宏而不是函数），使用ASSERT“断言”容易在debug时输出程序错误所在。

而assert()的功能类似，它是ANSI C标准中规定的函数，它与ASSERT的一个重要区别是可以用在Release版本中。

使用assert的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。

在调试结束后，可以通过在包含#include <assert.h>的语句之前插入 #define NDEBUG 来禁用assert调用，示例代码如下：

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

加入#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;
}