assert()函数用法总结

爱被打了一巴掌 2022-04-17 03:14 369阅读 0赞

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

以下是使用断言的几个原则：   
　　   
　　（1）使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的。   
　　   
　　（2）使用断言对函数的参数进行确认。   
　　   
　　（3）在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查。   
　　   
　　（4）一般教科书都鼓励程序员们进行防错性的程序设计，但要记住这种编程风格会隐瞒错误。当进行防错性编程时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。   
    
　　ASSERT ()是一个调试程序时经常使用的宏，在程序运行时它计算括号内的表达式，如果表达式为FALSE (0), 程序将报告错误，并终止执行。如果表达式不为0，则继续执行后面的语句。这个宏通常原来判断程序中是否出现了明显非法的数据，如果出现了终止程序以免导致严重后果，同时也便于查找错误。    
  
ASSERT只有在Debug版本中才有效，如果编译为Release版本则被忽略。

比较好的在程序中使用assert的地方：

(1)空指针检查。例如，针对一个函数的参数进行空指针检查。你可以这样使用：assert (pointer != NULL);，产生的错误会像这样：Assertion ‘pointer != ((void \*)0)’ failed。这样，当出现空指针时，你的程序就会退出，并很好的给出错误信息。

(2)检查函数参数的值。例如，如果一个函数只能在它的一个参数foo为正值的时候被调用，你可以在函数开始时这样写:assert (foo > 0);，这将帮助你检测函数的错误使用，这也给源代码阅读者很清晰的印象，那就是在这里对函数的参数值有限制。