C++ 中assert断言函数的基本用法

2023-01-21 07:44:08

在我们的实际开发过程之中，常常会出现一些隐藏得很深的BUG，或者是一些概率性发生的BUG，通常这些BUG在我们调试的过程中不会出现很明显的问题，但是如果我们将其发布，在用户的各种运行环境下，这些程序可能就会露出马脚了。那么，如何让我们的程序更明显的暴露出问题呢？这种情况下，我们一般都会使用 assert 断言函数，这是C语言标准库提供的一个函数，也就是说，它的使用与操作系统平台，调试器种类无关。我们只要学会了它的使用，便可一次使用，处处开花。

断言assert原型

void assert(int expression);

assert宏的原型定义在 <assert.h> 中，其作用是先计算表达式expression的值为假(即为0),那么它就先向stderr打印一条出错信息，然后通过条用abort来终止程序；

使用assert的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。

下面实际使用一下 assert

#include <assert.h>

#include <iostream>
// #include <cassert>
using namespace std;
int main() {
    cout << "====assert test====\n";
    assert(true);    //表达式为真
    assert(1 >= 2);  //表达式为假
    return 0;
}

在 VS Code 中运行（Ctrl + Alt + N)

出现异常

上面这个错误是很典型异常，可以考虑用assert排查。

根据提示我们很快就能定位到错误点，就在assert(1 >= 2)处；既然assert这么便于定位出错点，在工程中使用它就显得很有必要；但其也有一定的使用规则；

断言语句不会永远被执行，可以屏蔽也可以启用，这就要求assert不管是在屏蔽还是启用状态下都不能对我们本身代码有所影响.

那么我们一般在什么情况下使用断言呢？

主要体现在以下几个方面：

可以在预计正常情况下程序不会到达的地方放置断言。（如assert(0);）
使用断言测试方法的前置条件和后置条件；

前置条件：代码执行前必须具备的特性；
后置条件：代码执行后必须具备的特性；

使用断言检测类的不变状态，确保任何情况下，某个变量的状态或范围必须满足。

断言assert使用规则

当然我们在使用断言的过程中会有一些我们应该注意的事项和养成一些良好的习惯，如：

每个assert只检验一个条件，因为同时检验多个条件时，如果断言失败，我们就无法直观的判断哪个条件失败；

无法直观的判断哪个条件失败：

assert(nOffset >= 0 && nOffset + nSize <= m_nInfomationSize);

只检验一个条件，比较直观：

assert(nOffset >= 0);
assert(nOffset + nSize <= m_nInfomationSize);

不能使用改变环境的语句，就像我们上面的代码改变了i变量，在实际编写代码的过程中是不能这样做的；

例如：

assert(i++ < 100)

错误点：这是因为如果出错，比如在执行之前i=100,那么这条语句就不会执行，那么i++这条命令就没有执行。

assert(i < 100)
i++;

正确。

assert和后面的语句应该空一行，以形成逻辑和视觉上的一致性，也算是一种良好的编程习惯，让编写的代码有一种视觉上的美感；
有的地方，assert不能代替条件过滤；

程序一般分为Debug 版本和Release 版本，Debug 版本用于内部调试，Release 版本发行给用户使用。断言assert 是仅在Debug 版本起作用的宏，它用于检查"不应该"发生的情况。

放在函数参数的入口处检查传入参数的合法性；

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

在我们使用C语言/C++做工程项目时，如果我们能在代码中合理的使用assert，能使我们创建更稳定、质量更好且不易于出错的代码；当需要在一个值为false时中断当前操作的话就可以使用断言。

单元测试必须使用断言；另外除了类型检查和单元测试外，断言还提供了一种确定各种特性是否在程序中得到维护的极好的方法；

码农公寓

断言assert原型

断言assert使用规则

相关文章