这里对C语言中的 assert
宏进行大致讲述。
函数名: assert
功 能: 测试一个条件并可能使程序终止
用 法: void assert(int test);
定义与声明
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>
完整实例
这又是一个完整的例子:
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
struct ITEM {
int key;
int value;
};
/* add item to list, make sure list is not null */
void additem(struct ITEM *itemptr) {
assert(itemptr != NULL);
/* add item to list */
}
int main(void)
{
additem(NULL);
return 0;
}
其它
其它参考:http://zhidao.baidu.com/question/201080430.html
几个需要注意的用法
在函数开始处检验传入参数的合法性
如:
int resetBufferSize(int nNewSize)
{
//功能:改变缓冲区大小,
//参数:nNewSize 缓冲区新长度
//返回值:缓冲区当前长度
//说明:保持原信息内容不变 nNewSize<=0表示清除缓冲区
assert(nNewSize >= 0);
assert(nNewSize <= MAX_BUFFER_SIZE);
...
}
每个 assert
只检验一个条件
因为同时检验多个条件时,如果断言失败,无法直观的判断是哪个条件失败
不好的例子:
assert(nOffset>=0 && nOffset+nSize<=m_nInfomationSize);=
好的例子:
assert(nOffset >= 0);
assert(nOffset+nSize <= m_nInfomationSize);
不能使用改变环境的副作用语句
因为assert只在DEBUG个生效,如果这么做,会使用程序在真正运行时遇到问题
错误的例子:
assert(i++ < 100)
这是因为如果出错,比如在执行之前 i=100
,那么这条语句就不会执行,那么 i++
这条命令就没有执行。
正确的例子:
assert(i < 100)
i++;
assert
和后面的语句应空一行
这样以便形成逻辑和视觉上的一致感
有时 assert
不能代替条件过滤
注意:当对于浮点数:
#include<assert.h>
// float pi=3.14;
// assert(pi=3.14); //
float pi=3.14f;
assert(pi=3.14f);
在 switch
语句中总是要有 default
子句来显示信息( Assert
)
int number = SomeMethod();
switch(number)
{
case 1:
Trace.WriteLine("Case 1:");
break;
case 2:
Trace.WriteLine("Case 2:");
break;
default :
Debug.Assert(false);
break;
}