关于assert断言的使用

最新推荐文章于 2024-08-31 07:55:09 发布

abilly

最新推荐文章于 2024-08-31 07:55:09 发布

阅读量948

点赞数

原文网址：http://blog.163.com/sentimental_man/blog/static/73001618200871531835407/

assert()函数用法
assert宏的原型定义在<assert.h>中，其作用是如果它的条件返回错误，则终止程序执行，原型定义：
#include <assert.h>
void assert( int expression );
assert的作用是现计算表达式 expression，如果其值为假（即为0），那么它先向stderr打印一条出错信息，
然后通过调用 abort来终止程序运行。

程序一般分为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】一般教科书都鼓励程序员们进行防错设计，但要记住这种编程风格可能会隐瞒错误。当进行防错设计时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。

用法和注意事项总结：

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语言标准库中提供的一个通用的预处理器宏，在代码中常用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++里面更倾向于使用异常来进行错误处理。