在 C++ 中实现调试日志输出

在 C++ 编程中，调试日志对于定位问题和优化代码至关重要。有效的调试日志不仅能帮助我们快速定位错误，还能提供有关程序运行状态的有价值的信息。本文将介绍几种常用的调试日志输出方法，并教你如何在日志中添加时间戳。

1. 使用 #ifdef _DEBUG 宏

在 C++ 中，常用的方式之一是使用条件编译宏，控制日志输出仅在调试模式下启用。这种方法非常简单，且不会影响发布版的性能，因为在发布版本中，日志宏会被去除。

#include <iostream>#ifdef _DEBUG
#define LOG_ERROR(msg) \
std::cerr << "[ERROR] " << __FILE__ << ":" << __LINE__ << " (" << __FUNCTION__ << ") - " << msg << std::endl;
#define LOG_DEBUG(msg) \
std::cout << "[DEBUG] " << __FILE__ << ":" << __LINE__ << " (" << __FUNCTION__ << ") - " << msg << std::endl;
#else
#define LOG_ERROR(msg)
#define LOG_DEBUG(msg)
#endif

解释：
_DEBUG 宏：这个宏是在调试模式下自动定义的，通过它，我们可以控制日志输出只在调试时启用。
LOG_DEBUG 宏：它会打印当前文件名、行号、函数名以及传入的调试信息。如果是发布版本，这个宏会被忽略。

优点:

  • 调试时能提供详细的信息。
  • 不会影响发布版的性能，因为宏在发布时会被完全去除。

缺点:

  • 宏在复杂的项目中使用可能会导致调试信息过多，尤其是在日志量大的时候，可能会影响性能。
  • 宏不能捕获异常或提供高级日志功能（如日志等级、异步处理等）。

2. 加入时间戳：精确到毫秒

为了进一步提升日志的有用性，我们可以在日志中加入时间戳，这对于调试复杂的异步操作、性能瓶颈等问题非常有帮助。C++11 引入了 库，允许我们精确到毫秒地记录时间。

#include <iostream>
#include <chrono>
#include <iomanip>#ifdef _DEBUG
#define LOG_DEBUG(msg) { \auto now = std::chrono::system_clock::now(); \auto duration = now.time_since_epoch(); \auto milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>(duration).count(); \std::time_t time_now = std::chrono::system_clock::to_time_t(now); \std::tm time_tm = *std::localtime(&time_now); \std::cout << "[" << std::put_time(&time_tm, "%Y-%m-%d %H:%M:%S") << "." << std::setw(3) << std::setfill('0') << (milliseconds % 1000) << "] " \<< "[DEBUG] " << __FILE__ << ":" << __LINE__ << " (" << __FUNCTION__ << ") - " << msg << std::endl; \
}
#else
#define LOG_DEBUG(msg)
#endif

解释：

  • 获取当前时间：

    • 使用 std::chrono::system_clock::now() 获取当前的系统时间。
    • 使用 std::chrono::duration_cast 将时间精确到毫秒，并计算出自纪元以来的毫秒数。

  • 格式化时间戳：

    • 将时间转换为 std::time_t 类型，再通过 std::localtime 转换为 std::tm 结构体。
    • 使用 std::put_time 将 std::tm 格式化为 HH:MM:SS 格式。
    • 毫秒部分通过 milliseconds % 1000 计算并格式化为三位数字。

  • 输出格式：

    • 时间戳格式为 [%Y-%m-%d %H:%M:%S]，例如 2025-01-18 17:52:59.489。
    • 日志中会显示文件名、行号、函数名以及调试信息。

例子：

int main() {LOG_DEBUG("This is a debug message with timestamp!");return 0;
}

输出（假设当前时间是 14:30:45.123）：

[2025-01-18 17:52:59.489] [DEBUG] main.cpp:10 (main) - This is a debug message with timestamp!

Windows 和 MFC 中的调试日志方法

除了标准的 C++ 方法外，Windows 和 MFC 也提供了一些内置的调试日志工具，这些工具可以帮助开发者在调试过程中获取更丰富的信息。

MFC 调试宏

在 MFC 中，有几个常用的宏可以帮助我们进行调试日志输出：

  • TRACE：用于向输出窗口打印调试信息，类似于 printf，但输出到 Visual Studio 的调试输出窗口。
TRACE("Code：%d\n", nCode);
  • ASSERT：用于验证条件，如果条件为假，会弹出断言对话框，显示出错的文件和行号。
ASSERT(n > 0);  // 如果 n <= 0，会弹出断言对话框
  • AfxMessageBox：弹出一个消息框，显示调试信息，通常用于调试时向用户展示错误或提示信息。
AfxMessageBox(_T("This is a message box"));

Windows API 调试函数

  • OutputDebugString：这个函数可以将调试信息输出到调试器的输出窗口。
OutputDebugString(_T("This is a debug string"));
  • DbgPrint：在 Windows 驱动开发中，DbgPrint 用于向调试输出发送信息，适用于驱动程序开发。
DbgPrint("This is a debug message\n");

ASSERT 宏

Windows API 也提供了 ASSERT 宏，它和 MFC 中的 ASSERT 类似，用于检查条件并在条件失败时中断程序。

ASSERT(n > 0);  // 如果条件不成立，会弹出一个调试对话框

日志类 (Logger Class)

可以创建一个日志类来封装日志的输出。通过这种方式，你可以集中管理日志的格式、日志级别以及输出目的地（控制台、文件等）。

#include <iostream>
#include <fstream>
#include <string>class Logger {
public:enum LogLevel { INFO, WARNING, ERROR, DEBUG };Logger(LogLevel level = INFO) : logLevel(level) {}void log(LogLevel level, const std::string& msg) {if (level >= logLevel) {std::cout << "[" << levelToString(level) << "] " << msg << std::endl;}}private:LogLevel logLevel;std::string levelToString(LogLevel level) {switch (level) {case INFO: return "INFO";case WARNING: return "WARNING";case ERROR: return "ERROR";case DEBUG: return "DEBUG";default: return "UNKNOWN";}}
};#define LOG(level, msg) Logger().log(level, msg)

优点:

  • 支持多级别的日志记录（如 INFO, WARNING, ERROR, DEBUG）。
  • 更易于扩展，可以将日志输出到文件、数据库等。
  • 方便控制日志输出的内容和级别。

缺点:

  • 需要创建对象或静态方法，可能会影响性能。
  • 配置和管理较复杂。

第三方日志库：spdlog

对于更复杂的日志需求，第三方库如 spdlog 提供了丰富的功能，例如支持多级别日志、异步日志、文件轮转等。以下是一个使用 spdlog 输出带有时间戳的日志的简单例子：

#include <spdlog/spdlog.h>#define LOG_DEBUG(msg) spdlog::debug("[DEBUG] {}:{} ({}) - {}", __FILE__, __LINE__, __FUNCTION__, msg)
#define LOG_ERROR(msg) spdlog::error("[ERROR] {}:{} ({}) - {}", __FILE__, __LINE__, __FUNCTION__, msg)int main() {spdlog::set_level(spdlog::level::debug);  // Set global log levelLOG_DEBUG("This is a debug message.");LOG_ERROR("This is an error message.");
}

spdlog 会自动为每条日志加上时间戳，并支持丰富的输出格式和多种输出方式（如文件、终端、日志服务器等）。

日志文件输出

如果需要将日志写入文件，直接重定向输出流是一个简单的方法。可以结合条件编译、日志类或者外部库。

#include <iostream>
#include <fstream>#define LOG_TO_FILE(msg) { \std::ofstream logFile("log.txt", std::ios::app); \logFile << "[INFO] " << __FILE__ << ":" << __LINE__ << " (" << __FUNCTION__ << ") - " << msg << std::endl; \
}int main() {LOG_TO_FILE("This is a log message.");
}

优点:

  • 可以持久化日志数据，便于后期查看和分析。
  • 控制台和文件输出灵活配置。

缺点:

  • 对性能有一定影响，尤其是写入文件时。
  • 没有日志级别、过滤和格式化等高级功能。

日志文件轮转

如果日志文件过大，可以实现文件轮转的功能，即超过一定大小后自动切换到新文件。这通常通过日志库（如 spdlog）或者自行实现。

#include <iostream>
#include <fstream>#define LOG_ROTATE_FILE(msg) { \static int count = 0; \std::ofstream logFile("log_" + std::to_string(count) + ".txt", std::ios::app); \logFile << "[INFO] " << msg << std::endl; \if (++count >= 10) count = 0; \
}int main() {for (int i = 0; i < 15; ++i) {LOG_ROTATE_FILE("Log message number " + std::to_string(i));}
}

优点:

  • 自动管理日志文件的大小，避免日志文件过大。
  • 文件轮转能有效管理日志。

缺点:

  • 需要额外的逻辑来处理日志切换和命名。

总结

在 C++ 开发中，调试日志是调试和优化代码的重要工具。通过使用条件编译宏、std::chrono 来精确记录时间戳，我们可以在调试日志中添加有用的上下文信息，帮助我们快速定位问题。在 Windows 和 MFC 环境下，内置的调试工具如 TRACE、ASSERT 以及 OutputDebugString 也能为我们提供方便的调试信息。此外，第三方日志库如 spdlog 提供了更多的功能，适用于需要高效、异步日志记录的复杂项目。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/893402.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

MFC程序设计（二）基于对话框编程

MFC程序设计（二）基于对话框编程

从现在开始&#xff0c;我们将以基于对话框的MFC应用程序来讲解MFC应用 向导生成基于对话框MFC应用程序 对话框是一种特殊类型的窗口&#xff0c;绝大多数Windows程序都通过对话框与用户进行交互。在Visual C中&#xff0c;对话框既可以单独组成一个简单的应用程序&#xff0…
阅读更多...
Flink Gauss CDC：深度剖析存量与增量同步的创新设计

Flink Gauss CDC：深度剖析存量与增量同步的创新设计

目录 设计思路 1.为什么不直接用FlinkCDC要重写Flink Gauss CDC 2.存量同步的逻辑是什么 2.1、单主键的切片策略是什么 2.2、​​​​​复合主键作切片&#xff0c;怎么保证扫描到所有的数据 3、增量同步的逻辑是什么 4、存量同步结束之后如何无缝衔接增量同步 5、下游…
阅读更多...
idea新增java快捷键代码片段

idea新增java快捷键代码片段

最近在写一些算法题&#xff0c;有很多的List<List这种编写&#xff0c;想着能否自定义一下快捷键 直接在写代码输入&#xff1a;lli&#xff0c;即可看见提示
阅读更多...
深度学习-91-大语言模型LLM之基于langchain的模型IO的提示模板

深度学习-91-大语言模型LLM之基于langchain的模型IO的提示模板

文章目录 1 Model的输入输出2 提示模板2.1 提示模板的特点2.2 提示模板的类型3 使用提示模板3.1 设置环境变量3.2 PromptTemplate提示模板3.2.1 通过from_template方法3.2.2 直接生成提示模板3.2.3 使用提示模板3.2.4 复用提示模板3.3 ChatPromptTemplate聊天提示模板3.3.1 通过…
阅读更多...
stm8s单片机（二）外部中断实验

stm8s单片机（二）外部中断实验

中断优先级 stm8的中断优先级不是固定不变的&#xff0c;stm8的中断分为硬件优先级与软件优先级&#xff1b;当多个中断发生时&#xff0c;cpu会先响应软件优先级高的中断&#xff0c;若软件优先级相同会先响应硬件优先级高的&#xff1b; 其中软件优先级有四个 /*** brief …
阅读更多...
社区版Dify实现文生视频 LLM+ComfyUI+混元视频

社区版Dify实现文生视频 LLM+ComfyUI+混元视频

社区版Dify实现文生视频 LLMComfyUI混元视频 一、 社区版Dify实现私有化混元视频效果二、为什么社区版Dify可以在对话框实现文生视频&#xff1f;LLMComfyUI混元视频 实现流程图&#xff08;重点&#xff09;1. 文生视频模型支持ComfyUI2. ComfyUI可以轻松导出API实现封装3. Di…
阅读更多...
helm推送到harbor私有库--http: server gave HTTP response to HTTPS client

helm推送到harbor私有库--http: server gave HTTP response to HTTPS client

harbor私有库访问的是http模式 harbor 2.8版本以上可以存储helm镜像 docker镜像推送的时候需要docker端配置insecure-registries 发现helm推送只能在harbor部署的本机使用localhost才能推送成功&#xff0c;即 helm push xxx.tgz oci://localhost:80/library 使用helm pus…
阅读更多...
transformers使用过程问题

transformers使用过程问题

transfomers新旧版本冲突&#xff0c;和accelerate、datasets、evaluate这些库直接也经常会发生冲突 我使用了下面的版本&#xff0c;暂时没有冲突&#xff0c;如果有冲突再更新 transformers4.41.2 datasets2.20.0 accelerate0.31.0 evaluate0.4.2pip install transformers安…
阅读更多...
svn tag

svn tag

一般发布版本前&#xff0c;需要在svn上打个tag。步骤如下&#xff1a; 1、空白处右击&#xff0c;选择TortoiseSVN->Branch/tag; 2、填写To path&#xff0c;即tag的路基以及tag命名&#xff08;一般用版本号来命名&#xff09;&#xff1b;填写tag信息&#xff1b;勾选cr…
阅读更多...
【JavaSE】(8) String 类

【JavaSE】(8) String 类

一、String 类常用方法 1、构造方法 常用的这4种构造方法&#xff1a;直接法&#xff0c;或者传参字符串字面量、字符数组、字节数组。 在 JDK1.8 中&#xff0c;String 类的字符串实际存储在 char 数组中&#xff1a; String 类也重写了 toString 方法&#xff0c;所以可以直…
阅读更多...
【理解工具调用的流程，本质体现了大模型智能性】

【理解工具调用的流程，本质体现了大模型智能性】

1、工具调用 调用完结果看里面tool_calls 是否为空&#xff0c;不为空就调用工具函数处理&#xff0c; 如果为空就中断循环。大模型返回的message结果智能判断是否继续调用 输入输出如下&#xff1a; 请输入&#xff1a;深圳西安天气 ------------------------------------…
阅读更多...
excel实用工具

excel实用工具

持续更新… 文章目录 1. 快捷键1.1 求和 2. 命令2.1 查找 vloopup 1. 快捷键 1.1 求和 windows: alt mac : command shift T 2. 命令 2.1 查找 vloopup vlookup 四个入参数 要查找的内容 &#xff08;A2 6xx1&#xff09;查找的备选集 &#xff08;C2:C19&#xff09;…
阅读更多...
【C++】模板（进阶）

【C++】模板（进阶）

本篇我们来介绍更多关于C模板的知识。模板初阶移步至&#xff1a;【C】模板&#xff08;初阶&#xff09; 1.非类型模板参数 1.1 非类型模板参数介绍 模板参数可以是类型形参&#xff0c;也可以是非类型形参。类型形参就是我们目前接触到的一些模板参数。 //类型模板参数 …
阅读更多...
一文学会YOLO系列算法（从V3到11）实现遥感图像目标检测

一文学会YOLO系列算法（从V3到11）实现遥感图像目标检测

目录 前言 数据集介绍 数据集转换 YOLO代码的下载 YOLO的配置 1.数据集的配置 2.模型的配置 YOLO11模型的训练 其它版本YOLO的训练 前言 遥感技术的快速发展&#xff0c;特别是在高分辨率遥感图像的获取能力上的显著提升&#xff0c;已经大大拓宽了遥感数据在环境监测…
阅读更多...
图解Git——分布式Git《Pro Git》

图解Git——分布式Git《Pro Git》

分布式工作流程 Centralized Workflow&#xff08;集中式工作流&#xff09; 所有开发者都与同一个中央仓库同步代码&#xff0c;每个人通过拉取、提交来合作。如果两个开发者同时修改了相同的文件&#xff0c;后一个开发者必须在推送之前合并其他人的更改。 Integration-Mana…
阅读更多...
【高阶数据结构】布隆过滤器（BloomFilter）

【高阶数据结构】布隆过滤器（BloomFilter）

1. 概念 1.1 背景引入 背景&#xff1a;在计算机软件中&#xff0c;一个常见的需求就是 在一个集合中查找一个元素是否存在 &#xff0c;比如&#xff1a;1. Word 等打字软件需要判断用户键入的单词是否在字典中存在 2. 浏览器等网络爬虫程序需要保存一个列表来记录已经遍历过…
阅读更多...
【json_object】mysql中json_object函数过长，显示不全

【json_object】mysql中json_object函数过长，显示不全

问题&#xff1a;json只显示部分 解决&#xff1a; SET GLOBAL group_concat_max_len 1000000; -- 设置为1MB&#xff0c;根据需要调整如果当前在navicat上修改&#xff0c;只有效本次连接和后续会话&#xff0c;重新连接还是会恢复默认值1024 在my.ini配置文件中新增或者修…
阅读更多...
计算机网络 （52）秘钥分配

计算机网络 （52）秘钥分配

一、重要性 在计算机网络中&#xff0c;密钥分配是密钥管理中的一个核心问题。由于密码算法通常是公开的&#xff0c;因此网络的安全性主要依赖于密钥的安全保护。密钥分配的目的是确保密钥在传输过程中不被窃取或篡改&#xff0c;同时确保只有合法的用户才能获得密钥。 二、方…
阅读更多...
第35天：安全开发-JavaEE应用原生反序列化重写方法链条分析触发类类加载

第35天：安全开发-JavaEE应用原生反序列化重写方法链条分析触发类类加载

时间轴&#xff1a; 序列化与反序列化图解&#xff1a; 演示案例&#xff1a; Java-原生使用-序列化&反序列化 Java-安全问题-重写方法&触发方法 Java-安全问题-可控其他类重写方法 Java-原生使用-序列化&反序列化 1.为什么进行序列化和反序列化&#xff1…
阅读更多...
MindAgent：基于大型语言模型的多智能体协作基础设施

MindAgent：基于大型语言模型的多智能体协作基础设施

2023-09-18 &#xff0c;加州大学洛杉矶分校&#xff08;UCLA&#xff09;、微软研究院、斯坦福大学等机构共同创建的新型基础设施&#xff0c;目的在评估大型语言模型在游戏互动中的规划和协调能力。MindAgent通过CuisineWorld这一新的游戏场景和相关基准&#xff0c;调度多智…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023