assert的用法

1. 函数使用概况

assert宏能测试传入表达式的真假值，当表达式为真(true)，则不会有任何反应；当表达式为假(false)，则函数将输出错误信息，并中断程序的执行。

assert宏可以用来判断某表达式的真假值，并在程序执行的过程中实时响应错误信息，因此在程序开发的过程中，常常被用来作程序纠错的工具，当程序开发完成，只需要在加载头文件前面，利用#define指令定义NDEBUG这个关键字，则所有assert都会失效，源程序不需做任何修改。

当传入的表达式为真，则assert不会有任何响应；当表达式为假时，assert函数会显示出发生错误的表达式、源代码文件名以及发生错误的程序代码行数，并调用abort函数，结束程序执行。

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

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

 

2.用法示例

请看下面的程序清单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.
已放弃

 

3. 问题及注意事项

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

如:
int CDecodeBuffer::GetIntValue(int nOffset, int nSize) const
{
//功能:取出缓冲区中的一个有符号整数
//参数:nOffset   开始位置
//     nSize     字节数
//返回值:  如可在法位置返回正常值 否则为INVALID_VALUE
//建立日期:2005-09-12
ASSERT(nOffset >= 0);
ASSERT(nOffset+nSize <= m_nInfomationSize);

int nReturnValue = INVALID_VALUE;
if (nOffset>=0 && nOffset+nSize<=m_nInfomationSize)
{

；

}