关于assert断言的使用介绍

关于assert断言的使用介绍
/sentimental_man/blog/static/73001618200871531835407/
创作者：Qdieyou，转载请加注。

程序一般分为Debug 版本和Release 版本，Debug 版本用于内部调试，Release 版本发行给用户使用。

（这个概念可能不大好理解，想想VC下，调试时有个选项，一个是debug，一个是release）
assert(表达式); 的意思是：当表达式为真时，程序继续运行，如果表达市为假，那程序就会停止运行，并提示错误信息。

注意：assert是一个宏，只在debug版本中起作用，在release版本中，该语句是不起任何作用的。

先简单的看一个例子吧！
以下为一个使用了断言的C源程序：
#include <stdio.h>
#include <assert.h>
void test(int *p)
{
assert(p != NULL);
printf("%d\n", *p);
}
int main(void)
{
test(NULL);
}
编译及运行结果：
Qdieyou@qdieyou /cygdrive/e/gcc
$ gcc -o assert assert.c
Qdieyou@qdieyou /cygdrive/e/gcc
$ ./assert
assertion "p != NULL" failed: file "assert.c", line 6
19331 [sig] assert 3288 e:\gcc\assert.exe: *** fatal error - called with threa
dlist_ix -1
Hangup
程序说明：由于我们在main函数中传了NULL指针值给test函数，在test函数执行到assert(p != NULL);发现表达式不为真，就终止了程序的运行，并提示错误的行数信息。

注意：由于assert宏只在debug版本中起作用，所以assert一般只用于内部函数对参数有效性进行检查，如果该函数作为一个外部接口来使用时，一般需要利用if，else语句进行防错设计。

——Qdieyou
以下摘自《C高效编程》
【规则6-5-1】使用断言捕捉不应该发生的非法情况。

不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的。

【规则6-5-2】在函数的入口处，使用断言检查参数的有效性（合法性）。

【建议6-5-1】在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查。

【建议6-5-2】一般教科书都鼓励程序员们进行防错设计，但要记住这种编程风格可能会隐瞒错误。

当进行防错设计时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。

滥用assert
前不久看到一文章,说用assert的时候不要把非法情形和错误情形混淆了,错误始终是要处理的.
然后我review自己最近写的代码,愣是没有弄明白什么是非法什么是错误,难道错误不是非法么,非法不是错误么?
我本身用assert是相当频繁和随意的,但是经过这么一看,反而觉得原来那些assert的代码都要改成错误处理了...
花非花,雾非雾.
经过思考与实践,最终确定了规则.
非法情形,大部分你觉得有问题的地方,需要约束的地方,都可以认为可能存在非法情形.比如指针有效性,字
符串长度,数值范围等等.更抽象的说,非法情形存在于动作开始执行前的状态中.
相对之,错误就是动作执行之后的结果,错误是针对执行结果的.
详细而言,当调用一个函数,进入函数体的时候,就进入了一个非法情形出现点,在这里,在执行任何具体的计
算和动作之前,面对参数还有其他状态,你嗅到的任何东西都可以说是非法情形.然后函数开始执行,这里面所出现的任何(大多数)失败都是一种错误,需要进行处理.
需要着重强调的是,函数的执行结果(返回值)绝对是一种错误(如果返回值是那个意思的话),而不是非法状态.(考虑一种计算函数,它的返回结果限制在某个范围内,这是非法状态还是错误呢?我认为还是错误,虽然有些像非法状态,要进行更严格的处理和提示).
我极度强调在函数执行前确认非法状态,而不是当成错误处理(通常这种处理都是默默的,不透明的,不像assert那样嚣张-_-|||).因为我们写函数(接口)的目的,是希望能被正确的调用,而不是胡乱(导致局部或者整体状态混乱)的使用(为此我们居然要将assert写成错误处理的形式,以容忍各种白痴的调用行为).
但是有一些情形,在不得以的情况下,比如一个函数,要assert某个指针是有效的,然后才能执行某些动作,但是随后的执行状况是,极度可能在那个指针无效的时候却仍然不可避免的调用该函数,那么你就把assert简
单的用if替换掉就是了,没什么难的.但是,第一次写下那个函数的时候,吓你一跳的assert永远是不二的选择,如果你直接就用了if之类的错误处理,后面出什么状况就不是那么显眼了.
正确的滥用assert吧,至少我是这么做的.
函数名: assert
功能: 测试一个条件并可能使程序终止
用法: void assert(int test);
程序例:
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
struct ITEM {
int key;
int value;
};
/* add item to list, make sure list is not null */
void additem(struct ITEM *itemptr) {
assert(itemptr != NULL);
/* add item to list */
}
int main(void)
{
additem(NULL);
return 0;
}
assert(断言)可以有两种形式：
assert Expression1 ;
assert Expression1 : Expression2 ;
Expression1 应该总是产生一个布尔值。

Expression2 可以是得出一个值的任意表达式。

这个值用于生成显示更多调试信息的String 消息。

断言在默认情况下是禁用的。

要在编译时启用断言，需要使用source 1.4 标记：
javac -source 1.4 Test.java
要在运行时启用断言，可使用-enableassertions 或者-ea 标记。

要在运行时选择禁用断言，可使用-da 或者-disableassertions 标记。

要系统类中启用断言，可使用-esa 或者-dsa 标记。

还可以在包的基础上启用或者禁用断言。

可以在预计正常情况下不会到达的任何位置上放置断言。

断言可以用于验证传递给私有方法的参数。

不过，断言不应该用于验证传递给公有方法的参数，因为不管是否启用了断言，公有方法都必须检查其参数。

不过，既可以在公有方法中，也可以在非公有方法中利用断言测试后置条件。

另外，断言不应该以任何方式改变程序的状态。

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不能代替条件过滤
assert
Monday, 4. December 2006, 05:28:37
assert()是C语言标准库中提供的一个通用的预处理器宏，在代码中常用assret()来判断一个必须的前提条件，以便程序能够正确执行。

使用assert()必须包含的头文件是#include <assert.h>
如果assert(条件)，中的条件为假，则程序输出诊断消息，然后终止。

因此，assert只是帮你检查文件是否被打开，如果没有被打开，就会中止，不会向下执行。

准确的说，assert函数并不是C++的东西，而是C的一个宏，你打开assert.h文件就能看到assert的定义，它里面的参数是一个表达式，如果为真则不会进行处理，如果为假就进行一些处理，这个不同的编译器的宏是不一样的，而且甚至你可以自己定义自己的assert宏。

有的编译器的定义会打出当前的行号和文件名，然后core掉当前程序。

比如这样：
代码:
int a = 10;
assert(1 == a/10);
cout << a << endl;
如果程序执行到assert发现条件不满足，就会打印当前行号，文件名并core掉当前程序。

不过我们可以自己定义assert宏来满足自己的要求，不一定是core掉当前函数。

一般使用的时候都会加一个DEBUG宏定义来确定assert是否生效所以一般assert的定义是这样的：
代码:
#ifdef NDEBUG//这里NDEBUG是判断是否定义了DEBUG编译器自动定义的
# define assert(expr) (__ASSERT_VOID_CAST (0))//这一句的意思就是让assert不做任何事情
#else
# define assert(expr)
(__ASSERT_VOID_CAST ((expr) ? 0 :
(__assert_fail (__STRING(expr), __FILE__, __LINE__,
__ASSERT_FUNCTION), 0)))
这里大量用到了宏定义，不过大概意思能看懂吧，如果没有定义DEBUG，把assert定义为空，否则判断assert的表达式是否为0，是则运行__assert_fail，否就再次把assert视为空（__ASSERT_FUNCTION), 0）。

以上是linux里面的定义，其他系统也大同小异，如果自己定义assert的话，就不用include assert.h了，而且也不一定要core掉自己的程序。

不过作为一种调试方式，在c++里面更倾向于使用异常来进行错误处理。