assert

来源:互联网 发布:淘宝网聚优惠 编辑:程序博客网 时间:2024/06/03 17:34

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调用(因为Release版本中定义了NDEBUG这个宏常量,而在Release版本中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不能代替条件过滤

 

 

 

      在C中 , 相信assert这个断言是用的最频繁的宏之一,特别是在我们找BUG的时候,多用一些断言可以让我们更靠近出错的代码,不多说,进入我们的主题,写出一个assert宏来。

  首先我们都知道,assert在debug版下是有效的,在release版中assert是无效的,那么我们应该如何实现这一功能呢?实际上在release的版本中系统定义了NDBUG这个宏常量,当然在debug中没有定义这个宏常量,所以在定义这个宏之前检查是否定义过NDBUG这个宏就可以知道是debug版还是release版了,见下面的代码:

 

1 #if !defined(NDBUG)2  #define assert(p)        /*这里写上宏的代码*/    3  #else4 #define assert(p) 5 #endif

 

现在我们继续实现的assert , 我们都知道断言要是失败了,要输出失败位置所在文件的文件名和行号 , 当然输出应该重定向到标准出错里面。

 

__FILE__记录了当前执行的文件名。

__LINE__记录当前执行的行号。

stderr是标准出错。

当然断言要是失败的话 , 调用abort终止程序的执行 , 代码实现如下。

 

1 #if !defined(NDBUG)2 #define assert(p)    if(!(p)){fprintf(stderr,/3         "Assertion failed: %s, file %s, line %d/n",/4         #p, __FILE__, __LINE__);abort();}     5 #else6 #define assert(p) 7 #endif
0 0
原创粉丝点击