C++ assert 函数用法总结与注意事项

前言

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

简介

       原型定义：

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

       assert的作用是先计算表达式 expression ，如果其值为假（即为0），那么它先向stderr打印一条出错信息，然后

#include <stdio.h>
#include <assert.h>
#include <stdlib.h>

int main()
{
    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的规律就是，在方法或者函数的最开始使用，如果在方法的中间使用则需要慎重考虑是否是应该的。方法的最开始还没开始一个功能过程，在一个功能过程执行中出现的问题几乎都是异常。