在spdlog中实现全局日志显示文件名和行号

概述

spdlog是一个高性能的C++日志库，在实际开发中，我们经常需要在日志中显示文件名和行号信息，以便快速定位问题。本文将详细介绍如何在spdlog中实现全局日志自动显示文件名和行号的功能。

问题背景

开发者在使用spdlog时，希望全局日志能自动显示文件名和行号信息，类似于以下输出格式：

DEBUG main.cpp:2: hello

技术实现方案

方案一：使用日志宏

spdlog提供了日志宏（如SPDLOG_DEBUG）来实现这一功能。这些宏的设计初衷是为了在编译时移除不必要的日志输出，提高性能。

使用步骤如下：

1. 在包含spdlog头文件之前定义宏：

#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_TRACE
#include <spdlog/spdlog.h>

2. 使用宏进行日志记录：

SPDLOG_DEBUG("hello");

这种方式的优点是：

• 编译时可优化掉低于指定级别的日志
• 自动包含文件名和行号信息
• 性能较高

方案二：自定义日志格式

如果坚持要使用函数式接口（如spdlog::debug()），可以通过自定义日志格式来实现：

1. 设置全局日志格式：

spdlog::set_pattern("[%l] %s:%#: %v");

2. 使用函数式接口记录日志：

spdlog::debug("hello");

其中格式说明符：

• %s：源文件名
• %#：行号
• %v：实际日志消息

性能考虑

使用宏的方式在性能上更有优势，因为：

1. 低于当前日志级别的日志语句会在编译期被移除
2. 避免了运行时的日志级别判断开销

而使用函数式接口的方式则更加灵活，但会带来一定的运行时开销。

最佳实践建议

对于大多数项目，推荐使用宏的方式：

1. 在项目公共头文件中定义SPDLOG_ACTIVE_LEVEL
2. 统一使用SPDLOG_*系列宏进行日志记录
3. 在发布版本中可以提高日志级别以减少日志量

总结

在spdlog中显示文件名和行号有两种主要方式：使用预定义宏或自定义日志格式。根据项目对性能和灵活性的需求，开发者可以选择最适合的方案。对于性能敏感型项目，建议采用宏的方式；而对于需要动态调整日志格式的项目，则可以考虑自定义格式的方案。