spdlog: 高性能C++日志库教程

1. 项目介绍

spdlog 是一个由Gabriel Melman开发的高速、轻量级的C++日志库。它的设计目标是提供简单易用的日志记录功能，同时保持高性能。该项目支持多种日志目标，包括控制台、文件、轮转文件、syslog、Windows事件日志等。它还允许自定义日志过滤和在运行时动态改变日志级别。

2. 项目快速启动

安装（Header-only）

对于只需要头文件版本的用户，只需将include目录复制到你的构建树中：

$ git clone https://github.com/gabime/spdlog.git
$ cp -r spdlog/include/* /path/to/your/project/include/

安装（编译版）

如果你希望提高编译速度，可以编译安装：

$ git clone https://github.com/gabime/spdlog.git
$ cd spdlog
$ mkdir build && cd build
$ cmake ..
$ make -j

基本用法

以下是一个简单的示例，展示如何创建并使用一个控制台日志器：

#include <spdlog/spdlog.h>

int main() {
    // 创建一个名为"console"的彩色控制台日志器
    auto console = spdlog::stdout_color_mt("console");
    console->info("欢迎使用spdlog!");  // 输出信息
    console->error("这是一个错误消息!");  // 输出错误
    return 0;
}

3. 应用案例和最佳实践

日志文件基本记录

要记录到文件，你可以使用basic_logger_mt：

#include <spdlog/sinks/basic_file_sink.h>

void basic_logfile_example() {
    try {
        // 创建一个基础日志器，记录到"logs/basic-log.txt"
        auto logger = spdlog::basic_logger_mt("basic_logger", "logs/basic-log.txt");
    } catch (const spdlog::spdlog_ex& ex) {
        std::cout << "日志初始化失败：" << ex.what() << std::endl;
    }
}

文件轮转日志

对于定期备份日志文件，可使用rotating_logger_mt：

#include <spdlog/sinks/rotating_file_sink.h>

void rotating_example() {
    // 创建一个每5MB大小轮换且最多保留3个文件的日志器
    auto max_size = 1048576 * 5;  // 5MB
    auto max_files = 3;
    auto logger = spdlog::rotating_logger_mt(
        "some_logger_name", "logs/rotating.txt", max_size, max_files);
}

4. 典型生态项目

• fmt: 提供了丰富的格式化功能，与spdlog配合用于格式化日志。
• CMake: 使用CMake进行构建配置。
• Conan: 通过Conan包管理器可以方便地管理依赖。
• vcpkg: 支持Microsoft的vcpkg包管理工具。
• conda: 通过Anaconda环境管理器来安装。
• build2: 作为依赖项管理的一部分，可以在build2系统中使用。

为了获取更多关于spdlog的详细信息和使用技巧，建议查看其官方仓库和提供的示例代码。

官方仓库

本文档提供了基本的指导，但实际使用中可能需要根据具体需求进行调整。更多信息，请参考官方文档。