C Primer Plus(第五版)学习笔记-诊断库

在日常工作中，如果对于函数传入的参数不知对错，或是声明指针变量，或是打开文件，都可以使用断言assert()来判定

一、首先让我们来看看，什么是断言，我理解为断言就是一个if else的语句，比如：

if(条件成立)

{

程序继续执行；

}

else

{

报错并终止程序

}

二、怎么使用断言

断言是一个宏，只判断宏参数是否为假或者空，assert宏的原型定义在assert.h中，其作用是如果它的条件返回错误，则终止程序执行，原型定义如下：

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

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

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


int main( void )
{
       int *p = NULL;

       assert(p==NULL); //p==NULL值为真，对程序没影响
       printf("debug-----1\r\n");  //正常执行
       assert(p);       //p为空，运行时会出错
       printf("debug-----2\r\n"); //永远不会执行到这里
       return 0;
}

运行结果：

debug-----1

Assertion failed: (p), function main, file ../assert/main.c, line 11.

使用assert的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。 可以在调试结束后，在包含#include 的语句之前插入 #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个生效，如果这么做，会使用程序在真正运行时遇到问题，如：

//错误
//这是因为如果出错，比如在执行之前i=100，那么这条语句就不会执行，那么i++这条命令就没有执行
assert(i++ < 100);

//正确
assert(i < 100);
i++;

4）assert和后面的语句应空一行，以形成逻辑和视觉上的一致感
5）有些地方，assert不能代替条件过滤

程序一般分为Debug 版本和Release 版本，Debug 版本用于内部调试，Release 版本发行给用户使用。断言assert 是仅在Debug 版本起作用的宏，它用于检查“不应该”发生的情况。以下是一个内存复制程序，在运行过程中，如果assert 的参数为假，那么程序就会中止（一般地还会出现提示对话，说明在什么地方引发了assert）。 


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


ASSERT只有在Debug版本中才有效，如果编译为Release版本则被忽略。