深入理解断言assert()函数(待整理)



assert()函数用法总结

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

#include <assert.h>
void assert( int expression );

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

#include <stdio.h>
#include <assert.h>
#include <stdlib.h>
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;
}

[root@localhost error_process]# gcc badptr.c 
[root@localhost error_process]# ./a.out 
a.out: badptr.c:14: main: Assertion `fp' failed.

　　已放弃使用assert()的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。在调试结束后，可以通过在包含#include <assert.h>的语句之前插入 #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不能代替条件过滤。
assert是用来避免显而易见的错误的，而不是处理异常的。错误和异常是不一样的，错误是不应该出现的，异常是不可避免的。c语言异常可以通过条件判断来处理，其它语言有各自的异常处理机制。

一个非常简单的使用assert的规律就是，在方法或者函数的最开始使用，如果在方法的中间使用则需要慎重考虑是否是应该的。方法的最开始还没开始一个功能过程，在一个功能过程执行中出现的问题几乎都是异常。

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

#define NDEBUG是what?

Re:#define NDEBUG是what?
按照字母序首先我们来看看<assert.h>，这个文件提供的接口功能很简单，但却是我们极其常用的功能-断言机制(如果条件为False，则输出Diagnostics信息，然后Abort)。当然在最终产品中使用断言并不是一种好的方法，不过断言是一种很有用的帮助我们调试程序的好工具。

我们一般在程序的调试版本中使用断言机制，一般用来对Input进行Validation，输出一些Diagnostics信息。如：
assert((idx > 10) && (idx < 100));

< assert.h>中提供一个宏assert，这个宏的功能由另一个宏NDEBUG(标志是否是DEBUG版本)决定。如果NDEBUG宏在你include <assert.h>时没有被定义，这时断言功能开启；否则断言功能关闭。如：

#define NDEBUG
#include <assert.h> /* 此时断言功能关闭 */

你也大可不必在你的各个源文件中控制断言功能的开关，在编译器选项中同样可以定义NDEBUG宏，如gcc -DNDEBUG test.c，当然对于大的project，这些是应该放在Makefile中的，这样的结果就相当于在你所有#include <assert.h>的地方之前定义了NDEBUG宏，也就是说在每个编译单元中，断言功能都是关闭的。

assert宏看起来很简单，但是由于其是C标准库提供的接口，所以在实现的时候需要考虑的更加细致和全面一些。从上面的叙述上来看assert.h文件的结构应该大致如下：
#undef assert
#ifdef NDEBUG
#define assert(test) ((void)0)
#else
#define assert(test) ...
#endif

我们可以很轻松的就拿出一个assert的实现版本：
/* NDEBUG not defined */
#define assert(test) if (!(test)) \
fprintf(stderr, "Assertion Failed: %s, file %s, line %d\n", \
#test, __FILE__, __LINE__); \

那么这个版本的实现可以接受不，答案是不能。原因有以下几点：
1) 这个实现中直接用到了stderr和fprintf，这两个符号都是在<stdio.h>中声明的，但是C标准库头文件基本上都是各自独立的，在<assert.h>中是不会再包含其他头文件的，那么这就要求使用assert的程序自己包含<stdio.h>，这显然不符合一个C标准库的基本要求；
2) assert宏应该最终展开为一个void expression，因为用户很可能在他们的程序中写出像(assert(0 < x), x < y)这样的代码来，而在上面的实现版本中，显然assert展开后不是一个void expression。

我们再来看看P.J.Plauger的实现版本：
/* NDEBUG not defined */
void _Assert(char *);
#define _STR(x) _VAL(x)
#define _VAL(x) #x

#define assert(test) (test) ? (void)0 \
: _Assert(__FILE__ ":" _STR(__LINE__) " " #test)

/* in xassert.c */
#include <assert.h>
#include <stdio.h>

void _Assert(char *msg) {
fprintf(stderr, "%s -- assertion failed\n", msg);
abort();
}
  
分析一下这一版本的实现，首先assert宏并没有直接调用任何库输出函数，而是调用了一个自己实现的函数_Assert，把向stderr输出诊断信息的活都交给了_Assert。_STR和_VAL是两个辅助宏，用来将__LINE__字符串化。这里比较难懂的地方就是_Assert(__FILE__ ":" _STR(__LINE__) " " #test)这一句，其实这个也很好理解。看看下面语句的执行结果：
printf("%s\n", "Hello" " " "Tony!");
执行上面语句你会看到Hello Tony!，这样一来实际上_Assert(__FILE__ ":" _STR(__LINE__) " " #test)就可以被理解为：
_Assert("THE_FILENAME_STRING" ":" "THE_LINE_STRING" " " "THE_TEST_STRING")