C++之assert惯用法

2024-06-11 21:52
文章标签 c++ assert 惯用

本文主要是介绍C++之assert惯用法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

1.引言

2.简单示例

3.推荐使用方法

4.常见使用场景和注意事项

4.1.检查参数的合法性

4.2.assert不能使用改变环境的语句

4.3.在未知的逻辑中添加assert(false)

5.总结


1.引言

        assert在 <assert.h> 头文件中定义,其作用是如果它的提交呢返回错误,则终止执行。

        原型定义:

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

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

        通常,它用于检查在程序执行过程中应始终为真的条件。即当违反真理时, 触发断言. 比如1+1=2,当1+1≠2时触发断言。比如,

    assert(false); // 中断程序;assert(0 && "the code is error!"); // 中断并打印信息

2.简单示例


#include <assert.h> // headerint divide(int numerator, int denominator) {assert(denominator != 0); // 确保分母不为零return numerator / denominator;
}int main() {int result = divide(10, 2);// ...return 0;
}

        在上面的示例中,assert 宏确保分母永远不为零。如果分母为零,程序将以指示文件名、行号和失败的表达式的错误消息终止。

3.推荐使用方法

经常在C++程序中,以便于在开发过程中进行断言检查,而在发布版本中则禁用这些检查。

推荐写成如下方式,编写一个assert_utils.h文件,内容如下:

#pragma once#ifndef RELEASE
#include <cassert>
#define ASSERT(f) assert(f) 
#else
#define ASSERT(f) ((void)0)
#endif

下面是对这段代码的解释:

1) #pragma once:这是一个预处理指令,用于确保头文件只被包含一次。它的效果取决于编译器,但大多数现代编译器都支持它。

2) #ifndef RELEASE:这是一个预处理指令,用于检查是否定义了RELEASE宏。如果没有定义,编译器将继续执行下面的代码块。

3) #include <cassert>:如果RELEASE宏没有定义,编译器将包含cassert头文件,这是标准C++库的一部分,提供了assert宏。

4) #define ASSERT(f) assert(f):定义了一个宏ASSERT,它接受一个表达式f作为参数。当ASSERT被调用时,它将执行assert(f),如果f为假(即表达式结果为0),程序将终止运行,并显示一个断言失败的消息。

5) #else:如果RELEASE宏被定义,编译器将跳过上面的代码块,执行下面的代码。

6) #define ASSERT(f) ((void)0):在发布版本中,ASSERT宏被定义为一个空操作,即什么都不做。这样,在发布版本的程序中,所有ASSERT调用都不会执行任何操作,从而避免了性能损耗和潜在的程序中断。

7) #endif:结束#ifndef RELEASE条件编译块。

4.常见使用场景和注意事项

4.1.检查参数的合法性

示例如下:

int  sendData(const char* pData, int len)
{//[1] 校验参数的合法性assert(pData);assert(len > 0)//[2]//...
}

每个assert只检验一个条件,因为同时检验多个条件时,如果断言失败,无法直观的判断是哪个条件失败,如:

assert(pData && len > 0);  //这样不好

4.2.assert不能使用改变环境的语句

因为assert只在DEBUG环境中生效,如果这么做,会导致DEBUG和RELEASE的逻辑不一致。如:

assert(i++ < 100);

在DEUG环境下,每次都会执行i++,而在RELEASE环境中不会执行i++,这样就会导致两种环境下的执行结果不一样,正确的写法是:

assert(i < 100);
i++;

4.3.在未知的逻辑中添加assert(false)

如:

//根据业务类型处理业务
void  dealPro(int type)
{if (type == 0){// 文本业务}else if (type == 1){// 地图业务}else if (type == 2){// 测试业务}else{assert(false);}
}

        上述代码,我们的业务逻辑只涉及到文本、地图、测试业务,其它的都是非法业务,添加assert(false),一旦type不等与1、2、3,就会出现断言错误,查看程序堆栈,这样就非常快速的定位程序是哪个地方出现逻辑错误了,这个也是一个非常好的调试技巧。

5.总结

        总之,assert是一种在开发过程中快速检测程序错误的有效工具,但在发布的产品代码中通常被禁用以避免性能影响。开发者可以根据需要使用assert或其他错误处理机制来确保程序的正确性和健壯性。

这篇关于C++之assert惯用法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1052372

相关文章

从原理到实战深入理解Java 断言assert

《从原理到实战深入理解Java断言assert》本文深入解析Java断言机制,涵盖语法、工作原理、启用方式及与异常的区别,推荐用于开发阶段的条件检查与状态验证,并强调生产环境应使用参数验证工具类替代... 目录深入理解 Java 断言(assert):从原理到实战引言:为什么需要断言?一、断言基础1.1 语

从入门到精通C++11 <chrono> 库特性

《从入门到精通C++11<chrono>库特性》chrono库是C++11中一个非常强大和实用的库,它为时间处理提供了丰富的功能和类型安全的接口,通过本文的介绍,我们了解了chrono库的基本概念... 目录一、引言1.1 为什么需要<chrono>库1.2<chrono>库的基本概念二、时间段(Durat

C++20管道运算符的实现示例

《C++20管道运算符的实现示例》本文简要介绍C++20管道运算符的使用与实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录标准库的管道运算符使用自己实现类似的管道运算符我们不打算介绍太多,因为它实际属于c++20最为重要的

Visual Studio 2022 编译C++20代码的图文步骤

《VisualStudio2022编译C++20代码的图文步骤》在VisualStudio中启用C++20import功能,需设置语言标准为ISOC++20,开启扫描源查找模块依赖及实验性标... 默认创建Visual Studio桌面控制台项目代码包含C++20的import方法。右键项目的属性:

c++中的set容器介绍及操作大全

《c++中的set容器介绍及操作大全》:本文主要介绍c++中的set容器介绍及操作大全,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录​​一、核心特性​​️ ​​二、基本操作​​​​1. 初始化与赋值​​​​2. 增删查操作​​​​3. 遍历方

解析C++11 static_assert及与Boost库的关联从入门到精通

《解析C++11static_assert及与Boost库的关联从入门到精通》static_assert是C++中强大的编译时验证工具,它能够在编译阶段拦截不符合预期的类型或值,增强代码的健壮性,通... 目录一、背景知识:传统断言方法的局限性1.1 assert宏1.2 #error指令1.3 第三方解决

C++11委托构造函数和继承构造函数的实现

《C++11委托构造函数和继承构造函数的实现》C++引入了委托构造函数和继承构造函数这两个重要的特性,本文主要介绍了C++11委托构造函数和继承构造函数的实现,具有一定的参考价值,感兴趣的可以了解一下... 目录引言一、委托构造函数1.1 委托构造函数的定义与作用1.2 委托构造函数的语法1.3 委托构造函

C++11作用域枚举(Scoped Enums)的实现示例

《C++11作用域枚举(ScopedEnums)的实现示例》枚举类型是一种非常实用的工具,C++11标准引入了作用域枚举,也称为强类型枚举,本文主要介绍了C++11作用域枚举(ScopedEnums... 目录一、引言二、传统枚举类型的局限性2.1 命名空间污染2.2 整型提升问题2.3 类型转换问题三、C

C++链表的虚拟头节点实现细节及注意事项

《C++链表的虚拟头节点实现细节及注意事项》虚拟头节点是链表操作中极为实用的设计技巧,它通过在链表真实头部前添加一个特殊节点,有效简化边界条件处理,:本文主要介绍C++链表的虚拟头节点实现细节及注... 目录C++链表虚拟头节点(Dummy Head)一、虚拟头节点的本质与核心作用1. 定义2. 核心价值二

C++ 检测文件大小和文件传输的方法示例详解

《C++检测文件大小和文件传输的方法示例详解》文章介绍了在C/C++中获取文件大小的三种方法,推荐使用stat()函数,并详细说明了如何设计一次性发送压缩包的结构体及传输流程,包含CRC校验和自动解... 目录检测文件的大小✅ 方法一:使用 stat() 函数(推荐)✅ 用法示例:✅ 方法二:使用 fsee