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

相关文章

C++ move 的作用详解及陷阱最佳实践

《C++move的作用详解及陷阱最佳实践》文章详细介绍了C++中的`std::move`函数的作用,包括为什么需要它、它的本质、典型使用场景、以及一些常见陷阱和最佳实践,感兴趣的朋友跟随小编一起看... 目录C++ move 的作用详解一、一句话总结二、为什么需要 move?C++98/03 的痛点⚡C++

详解C++ 存储二进制数据容器的几种方法

《详解C++存储二进制数据容器的几种方法》本文主要介绍了详解C++存储二进制数据容器,包括std::vector、std::array、std::string、std::bitset和std::ve... 目录1.std::vector<uint8_t>(最常用)特点:适用场景:示例:2.std::arra

C++构造函数中explicit详解

《C++构造函数中explicit详解》explicit关键字用于修饰单参数构造函数或可以看作单参数的构造函数,阻止编译器进行隐式类型转换或拷贝初始化,本文就来介绍explicit的使用,感兴趣的可以... 目录1. 什么是explicit2. 隐式转换的问题3.explicit的使用示例基本用法多参数构造

C++,C#,Rust,Go,Java,Python,JavaScript的性能对比全面讲解

《C++,C#,Rust,Go,Java,Python,JavaScript的性能对比全面讲解》:本文主要介绍C++,C#,Rust,Go,Java,Python,JavaScript性能对比全面... 目录编程语言性能对比、核心优势与最佳使用场景性能对比表格C++C#RustGoJavapythonjav

C#中Trace.Assert的使用小结

《C#中Trace.Assert的使用小结》Trace.Assert是.NET中的运行时断言检查工具,用于验证代码中的关键条件,下面就来详细的介绍一下Trace.Assert的使用,具有一定的参考价值... 目录1、 什么是 Trace.Assert?1.1 最简单的比喻1.2 基本语法2、⚡ 工作原理3

C++打印 vector的几种方法小结

《C++打印vector的几种方法小结》本文介绍了C++中遍历vector的几种方法,包括使用迭代器、auto关键字、typedef、计数器以及C++11引入的范围基础循环,具有一定的参考价值,感兴... 目录1. 使用迭代器2. 使用 auto (C++11) / typedef / type alias

C++ scoped_ptr 和 unique_ptr对比分析

《C++scoped_ptr和unique_ptr对比分析》本文介绍了C++中的`scoped_ptr`和`unique_ptr`,详细比较了它们的特性、使用场景以及现代C++推荐的使用`uni... 目录1. scoped_ptr基本特性主要特点2. unique_ptr基本用法3. 主要区别对比4. u

C++11中的包装器实战案例

《C++11中的包装器实战案例》本文给大家介绍C++11中的包装器实战案例,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录引言1.std::function1.1.什么是std::function1.2.核心用法1.2.1.包装普通函数1.2.

C++多线程开发环境配置方法

《C++多线程开发环境配置方法》文章详细介绍了如何在Windows上安装MinGW-w64和VSCode,并配置环境变量和编译任务,使用VSCode创建一个C++多线程测试项目,并通过配置tasks.... 目录下载安装 MinGW-w64下载安装VS code创建测试项目配置编译任务创建 tasks.js

C++ 多态性实战之何时使用 virtual 和 override的问题解析

《C++多态性实战之何时使用virtual和override的问题解析》在面向对象编程中,多态是一个核心概念,很多开发者在遇到override编译错误时,不清楚是否需要将基类函数声明为virt... 目录C++ 多态性实战:何时使用 virtual 和 override?引言问题场景判断是否需要多态的三个关