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++中unordered_set哈希集合的实现

《C++中unordered_set哈希集合的实现》std::unordered_set是C++标准库中的无序关联容器,基于哈希表实现,具有元素唯一性和无序性特点,本文就来详细的介绍一下unorder... 目录一、概述二、头文件与命名空间三、常用方法与示例1. 构造与析构2. 迭代器与遍历3. 容量相关4

C++中悬垂引用(Dangling Reference) 的实现

《C++中悬垂引用(DanglingReference)的实现》C++中的悬垂引用指引用绑定的对象被销毁后引用仍存在的情况,会导致访问无效内存,下面就来详细的介绍一下产生的原因以及如何避免,感兴趣... 目录悬垂引用的产生原因1. 引用绑定到局部变量,变量超出作用域后销毁2. 引用绑定到动态分配的对象,对象

C++读写word文档(.docx)DuckX库的使用详解

《C++读写word文档(.docx)DuckX库的使用详解》DuckX是C++库,用于创建/编辑.docx文件,支持读取文档、添加段落/片段、编辑表格,解决中文乱码需更改编码方案,进阶功能含文本替换... 目录一、基本用法1. 读取文档3. 添加段落4. 添加片段3. 编辑表格二、进阶用法1. 文本替换2

C++中处理文本数据char与string的终极对比指南

《C++中处理文本数据char与string的终极对比指南》在C++编程中char和string是两种用于处理字符数据的类型,但它们在使用方式和功能上有显著的不同,:本文主要介绍C++中处理文本数... 目录1. 基本定义与本质2. 内存管理3. 操作与功能4. 性能特点5. 使用场景6. 相互转换核心区别

C++右移运算符的一个小坑及解决

《C++右移运算符的一个小坑及解决》文章指出右移运算符处理负数时左侧补1导致死循环,与除法行为不同,强调需注意补码机制以正确统计二进制1的个数... 目录我遇到了这么一个www.chinasem.cn函数由此可以看到也很好理解总结我遇到了这么一个函数template<typename T>unsigned

C++统计函数执行时间的最佳实践

《C++统计函数执行时间的最佳实践》在软件开发过程中,性能分析是优化程序的重要环节,了解函数的执行时间分布对于识别性能瓶颈至关重要,本文将分享一个C++函数执行时间统计工具,希望对大家有所帮助... 目录前言工具特性核心设计1. 数据结构设计2. 单例模式管理器3. RAII自动计时使用方法基本用法高级用法

深入解析C++ 中std::map内存管理

《深入解析C++中std::map内存管理》文章详解C++std::map内存管理,指出clear()仅删除元素可能不释放底层内存,建议用swap()与空map交换以彻底释放,针对指针类型需手动de... 目录1️、基本清空std::map2️、使用 swap 彻底释放内存3️、map 中存储指针类型的对象

C++ STL-string类底层实现过程

《C++STL-string类底层实现过程》本文实现了一个简易的string类,涵盖动态数组存储、深拷贝机制、迭代器支持、容量调整、字符串修改、运算符重载等功能,模拟标准string核心特性,重点强... 目录实现框架一、默认成员函数1.默认构造函数2.构造函数3.拷贝构造函数(重点)4.赋值运算符重载函数

C++ vector越界问题的完整解决方案

《C++vector越界问题的完整解决方案》在C++开发中,std::vector作为最常用的动态数组容器,其便捷性与性能优势使其成为处理可变长度数据的首选,然而,数组越界访问始终是威胁程序稳定性的... 目录引言一、vector越界的底层原理与危害1.1 越界访问的本质原因1.2 越界访问的实际危害二、基

c++日志库log4cplus快速入门小结

《c++日志库log4cplus快速入门小结》文章浏览阅读1.1w次,点赞9次,收藏44次。本文介绍Log4cplus,一种适用于C++的线程安全日志记录API,提供灵活的日志管理和配置控制。文章涵盖... 目录简介日志等级配置文件使用关于初始化使用示例总结参考资料简介log4j 用于Java,log4c