spdlog是c++中高效线程安全的日志库,支持异步、多输出和自定义格式。1. 通过vcpkg或源码集成,头文件仅需包含即可使用。2. 基础用法包括info、warn、Error等日志级别,默认需启用debug模式。3. 使用basic_logger_mt将日志写入文件,确保目录存在。4. 组合stdout_color_sinks和file_sink实现控制台与文件双输出。5. 异步日志需初始化线程池,提升高并发性能。6. 自定义格式通过set_pattern设置时间、级别、内容等占位符。7. 最佳实践建议统一配置、命名logger、生产环境用异步、合理轮转文件。

在C++项目中实现高效、线程安全且易于使用的日志功能,spdlog 是一个非常受欢迎的选择。它是一个基于现代C++(C++11及以上)的高性能日志库,支持异步日志、多线程安全、多种日志格式和输出目标(控制台、文件等),并且使用简单。
1. 安装与集成 spdlog
spdlog 是一个头文件-only 的库,因此集成非常方便,无需编译。
方法一:通过 vcpkg 安装
vcpkg install spdlog
方法二:直接下载源码
方法三:使用 CMake 添加为子模块
add_subdirectory(vendor/spdlog) target_link_libraries(your_target spdlog)
2. 快速开始:基本日志输出
以下是一个简单的例子,展示如何使用 spdlog 输出日志到控制台:
#include <spdlog/spdlog.h> int main() { spdlog::info("这是一条信息日志"); spdlog::warn("这是一个警告"); spdlog::error("这是一个错误"); spdlog::debug("调试信息(需启用调试模式)"); return 0; }
默认情况下,debug 级别的日志不会显示,需要设置日志级别:
立即学习“C++免费学习笔记(深入)”;
spdlog::set_level(spdlog::level::debug); // 启用 debug 级别
3. 使用文件日志记录
将日志写入文件是常见需求。spdlog 提供了 basic_logger_mt 来创建线程安全的文件日志器:
#include <spdlog/sinks/basic_file_sink.h> auto file_logger = spdlog::basic_logger_mt("file_logger", "logs/app.log"); file_logger->info("这条日志会写入文件"); file_logger->error("出错啦:无法打开文件");
确保 logs/ 目录存在,否则会抛出异常。
4. 同时输出到控制台和文件
可以组合多个 sink,实现日志同时输出到控制台和文件:
#include <spdlog/sinks/stdout_color_sinks.h> #include <spdlog/sinks/basic_file_sink.h> auto console_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>(); auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("logs/app.log"); auto combined_logger = std::make_shared<spdlog::logger>("multi", spdlog::sinks_init_list{console_sink, file_sink}); combined_logger->info("这条消息会同时出现在控制台和文件中"); combined_logger->set_level(spdlog::level::trace); // 注册为默认 logger(可选) spdlog::set_default_logger(combined_logger);
5. 异步日志提升性能
在高并发场景下,同步日志可能成为性能瓶颈。spdlog 支持异步日志,通过后台线程写入:
spdlog::init_thread_pool(8192, 1); // 队列大小 8192,1个线程 auto async_file = spdlog::basic_logger_mt<spdlog::async_factory>("async_file", "logs/async.log"); async_file->info("这条日志异步写入,不影响主线程");
注意:使用异步日志前必须调用 init_thread_pool。
6. 自定义日志格式
spdlog 允许自定义日志格式。例如:
spdlog::set_pattern("[%Y-%m-%d %H:%M:%S.%e] [%n] [%l] %v");
其中:
-
%Y-%m-%d:年-月-日 -
%H:%M:%S.%e:时:分:秒.毫秒 -
%n:logger 名称 -
%l:日志级别 -
%v:日志内容
也可以为特定 logger 设置格式:
file_logger->set_pattern("[%H:%M:%S] %v");
7. 最佳实践建议
- 在程序启动时统一配置日志系统,避免分散设置
- 使用命名 logger 区分模块,如 “net”, “db”, “ui”
- 生产环境启用异步日志以减少 I/O 阻塞
- 合理设置日志级别,避免过度输出
- 定期轮转日志文件(可结合
rotating_file_sink)
基本上就这些。spdlog 功能强大且使用直观,能显著提升 C++ 项目的可观测性。只要引入头文件并简单配置,就能拥有工业级的日志能力。不复杂但容易忽略的是线程安全和性能影响,推荐优先使用异步模式处理高频日志。