调试

首先需要指出一个非常重要、讨论前必须明确的问题，assert一般不应该直接用，而应该包装一下，比如微软就有ASSERT宏，可以跟踪line file这些有用信息，另外可以通过条件编译取消ASSERT。每次定位很久，只能说这种编程common sense还没有建立起来。

原文虽然说得很简单，其实涉及了几个方面，一个是版本管理发布，一个是错误处理机制，一个是如何写日志，我们一个个讨论。

首先是什么情况下用ASSERT，什么情况下应该处理wrong case？

一个成熟的代码里面，大概有百分之三十到七十的代码都是为了查错，fault tolerance。比如你写一个API或者对外使用的函数，别人要调用，你要确保传入的指针不为空，传入的参数合法，这时候都不应该，注意是不应该使用 ASSERT，因为这些情况out of your control。

什么情况可以使用ASSERT，应该是那些绝少发生的例子，而且你可以控制的那些代码段落，比如Object* p = new Object，返回空指针，这种情况下多半是内存申请出错，即使你容错了，后面的逻辑也不会正常，这时候就应该停止运行报错了。还有就是你的内部函数（注意是你程序的内部哦），因为内部函数的代码责任其实是你自己的，你传错参数只能说水平太差怨不得别人。也许有人会说，同组里别的程序员万一也调用了这个函数怎么办？这种情况当然是会有的，其实也没法避免，但可以用ASSERT以及Code review这些手段来规范，同一个程序组里面的问题属于内部矛盾好解决多了。

所以，大的原则可以是这样：内部函数尽量简化容错机制，稍微苛刻一些，而对外接口则尽量容忍，出错处理也要温柔。

第二个问题，ASSERT该怎么写？

我已经提到，不要直接使用assert，最好包装一下，加入#ifdef _DEBUG这种条件编译选项，保证Release版本不弹出ASSERT。这里其实也涉及到版本管理问题，一个商业产品发布一般包含两个版本（Release版以及Debug checked版本），即使是Windows操作系统也是如此。在Release版本要Disasble assert，这时候如果出错可以用后面的Crash Dump机制捕捉跟踪，而且要说明的是Release版本一样要附带PDB文件（或者Linux同类文件），保证Crash Dump可以定位。Debug版本也要发给用户，用户可以通过它返回更详细信息。每个Build出来的Release、Debug都应该妥善备份，将来客户提交Bug，对应版本以及PDB，就可以准确定位，不会出现很难差错的现象。

另外也可以加入日志log选项。在这里跑一下题，日志记录也是个大问题，要考虑多线程以及性能问题，其实不是加入日志系统就万事大吉了，说句难听的，对于那些2B Number One的人来讲，任何一个好东西都可能被他们用到烂。一般ASSERT跑出来，对于客户来说就等同于Crash了，所以可以参考一下Google的 Crash Report开源项目，比如Windows下可使用Crash Dump机制来捕捉崩溃时调用栈，这样即使Fail Soon Fail Fast也不会很难看。这些手段都是common sense的东西，一个正常的软件开发公司应该积累下这些代码财富才对。

断言（ASSERT)的用法

　　我一直以为assert仅仅是个报错函数，事实上，它居然是个宏，并且作用并非“报错”。

　　在经过对其进行一定了解之后，对其作用及用法有了一定的了解，assert()的用法像是一种“契约式编程”，在我的理解中，其表达的意思就是，程序在我的假设条件下，能够正常良好的运作，其实就相当于一个if语句：

if(假设成立)
{
     程序正常运行；
}
else
{
      报错&&终止程序！（避免由程序运行引起更大的错误）  
}

　　但是这样写的话，就会有无数个if语句，甚至会出现，一个if语句的括号从文件头到文件尾，并且大多数情况下，我们要进行验证的假设，只是属于偶然性事件，又或者我们仅仅想测试一下，一些最坏情况是否发生，所以这里有了assert().

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

1 #include "assert.h" 
2 void assert( int expression );

　　assert的作用是现计算表达式 expression ，如果其值为假（即为0），那么它先向stderr打印一条出错信息,然后通过调用 abort 来终止程序运行。
使用assert的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。
　　在调试结束后，可以通过在包含#include 的语句之前插入 #define NDEBUG 来禁用assert调用，示例代码如下：

1 #include 
2 #define NDEBUG 
3 #include

　　用法总结与注意事项：

　　1)在函数开始处检验传入参数的合法性
　　如:
　　

 1 int resetBufferSize(int nNewSize) 
 2 { 
 3 //功能:改变缓冲区大小, 
 4 //参数:nNewSize 缓冲区新长度 
 5 //返回值:缓冲区当前长度 
 6 //说明:保持原信息内容不变 nNewSize<=0表示清除缓冲区 
 7 assert(nNewSize >= 0); 
 8 assert(nNewSize <= MAX_BUFFER_SIZE); 
 9  
10 ... 
11 }

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

以下是使用断言的几个原则：
　　
　　（1）使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的。
　　
　　（2）使用断言对函数的参数进行确认。
　　
　　（3）在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查。
　　
　　（4）一般教科书都鼓励程序员们进行防错性的程序设计，但要记住这种编程风格会隐瞒错误。当进行防错性编程时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。

　　ASSERT ()是一个调试程序时经常使用的宏，在程序运行时它计算括号内的表达式，如果表达式为FALSE (0), 程序将报告错误，并终止执行。如果表达式不为0，则继续执行后面的语句。这个宏通常原来判断程序中是否出现了明显非法的数据，如果出现了终止程序以免导致严重后果，同时也便于查找错误。

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

assert()函数用法总结

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