当前位置：首页 > news >正文

spdlog简单介绍和使用

news 2026/2/8 20:56:49

spdlog 是一个C++的快速、可扩展的日志库，具有高性能和友好的接口。它支持多种日志输出目标，如控制台、文件、远程服务器等，并具有强大的日志格式化和异步日志记录功能。

以下是对spdlog的简单介绍和使用示例：

安装 spdlog

你可以使用包管理工具（如CMake、vcpkg、Conan等）来安装spdlog，或者从GitHub仓库获取源代码进行构建。这里以CMake为例：

下载spdlog源代码或使用git克隆官方仓库：
```
git clone https://github.com/gabime/spdlog.git
```

在你的CMake项目中包含spdlog：

add_subdirectory(path_to_spdlog_source_directory)

在你的CMakeLists.txt中链接spdlog：

target_link_libraries(your_project_name PRIVATE spdlog::spdlog)

使用 spdlog

使用spdlog非常简单，以下是一个基本的示例：

#include <spdlog/spdlog.h>int main() {// 初始化spdlog，使用stdout作为输出目标auto console = spdlog::stdout_logger_mt("console");// 记录日志消息console->info("This is an informational message.");console->error("This is an error message.");console->critical("This is a critical message.");spdlog::info("Welcome to spdlog!"); return 0;
}

在上述示例中，我们首先包含了spdlog头文件，然后创建了一个名为"console"的日志记录器，并将其绑定到stdout（控制台）。接着，我们使用info、error和critical方法记录不同级别的日志消息。

日志级别

spdlog 支持多种日志级别，包括以下几种：

trace: 用于追踪信息。
debug: 用于调试信息。
info: 用于一般信息。
warn: 用于警告信息。
error: 用于错误信息。
critical: 用于严重错误信息。

你可以根据需要选择不同的级别来记录日志。默认情况下，spdlog 的日志级别是debug，你可以在初始化日志记录器时指定不同的级别。

日志格式

spdlog 允许你自定义日志消息的格式。你可以使用占位符来指定日志消息中的各个部分，例如时间戳、日志级别、消息内容等。默认情况下，spdlog 使用一种简单的格式，但你可以通过设置自定义格式字符串来更改它。以下是一个示例：

spdlog::set_pattern("[%Y-%m-%d %H:%M:%S.%e] [%l] %v");

这个示例将时间戳、日志级别和消息内容分别用占位符表示。

spdlog 还支持异步日志记录，可以提高日志记录的性能，特别是在多线程环境中。

这只是一个spdlog的基本介绍和使用示例。你可以根据需要进一步探索其丰富的功能和配置选项，以满足特定的日志记录需求。

接下来我们详细介绍一下spdlog库的使用

创建和初始化日志记录器

在使用 spdlog 之前，需要创建和初始化一个或多个日志记录器。通常，你会在应用程序的入口处初始化日志记录器。以下是初始化日志记录器的示例：

#include <spdlog/spdlog.h>int main() {// 初始化默认日志记录器，使用stdout作为输出目标spdlog::stdout_logger_mt("console");// 初始化一个自定义日志记录器，使用文件作为输出目标auto file_logger = spdlog::basic_logger_mt("file_logger", "my_log.txt");// 设置日志级别spdlog::set_level(spdlog::level::debug);// 更多初始化和设置选项...// 记录日志消息spdlog::get("console")->info("This is an informational message.");spdlog::get("file_logger")->error("This is an error message.");// 关闭和销毁日志记录器spdlog::drop("console");spdlog::drop("file_logger");return 0;
}

在上述示例中，我们首先初始化了一个默认的日志记录器（"console"），并将其绑定到stdout。然后，我们初始化了一个自定义的日志记录器（"file_logger"），并将其绑定到名为"my_log.txt"的文件。我们还设置了日志级别为debug，这意味着它将记录所有级别的日志。

记录日志消息

一旦初始化了日志记录器，就可以使用它来记录日志消息。spdlog 支持多种日志级别，包括 trace、debug、info、warn、error 和 critical，你可以根据需要选择不同的级别来记录日志。以下是一些示例：

spdlog::get("console")->trace("This is a trace message.");
spdlog::get("console")->debug("This is a debug message.");
spdlog::get("console")->info("This is an informational message.");
spdlog::get("console")->warn("This is a warning message.");
spdlog::get("console")->error("This is an error message.");
spdlog::get("console")->critical("This is a critical message.");

自定义日志格式

spdlog::set_pattern("[%Y-%m-%d %H:%M:%S.%e] [%l] %v");

这个示例将时间戳、日志级别和消息内容分别用占位符表示。

输出目标

spdlog 支持多种输出目标，包括控制台、文件、远程服务器等。你可以通过创建不同的日志记录器，并将它们绑定到不同的输出目标来实现多个日志通道。以下是一个输出目标示例：

auto file_logger = spdlog::basic_logger_mt("file_logger", "my_log.txt");

此示例将创建一个名为"file_logger"的自定义日志记录器，并将其绑定到名为"my_log.txt"的文件。

异步日志记录

spdlog 支持异步日志记录，可以提高日志记录的性能，特别是在多线程环境中。要启用异步日志记录，你可以使用以下方式初始化日志记录器：

auto async_file_logger = spdlog::basic_logger_st("async_file_logger", "async_log.txt");

在这个示例中，我们使用了_st后缀，表示启用了异步日志记录。

spdlog 还提供了许多其他功能和选项，如日志文件的切割、回滚、日志旋转等。你可以根据具体需求进一步探索这些功能。

spdlog 是一个功能强大而又易于使用的C++日志库，适用于各种应用程序。请参考 spdlog 的官方文档以获取更多详细信息和用法示例：GitHub - gabime/spdlog: Fast C++ logging library.