spdlog 安装和使用

1. 概述

介绍：spdlog 是一个高性能、超快速、零配置的 C++ 日志库，它旨在提供简洁的 API 和丰富的功能，同时保持高性能的日志记录。它支持多种输出目标、格式化选项、线程安全以及异步日志记录。

github 链接：https://github.com/gabime/spdlog

特点

高性能：spdlog 专为速度而设计，即使在高负载情况下也能保持良好的性能
零配置：无需复杂的配置，只需包含头文件即可在项目中使用。
异步日志：支持异步日志记录，减少对主线程的影响。
格式化：支持自定义日志消息的格式化，包括时间、线程ID、日志级别等
多平台：跨平台兼容，支持 Windows、Linux、macOS 等操作系统。
丰富的 API：提供丰富的日志级别和操作符重载，方便记录各种类型的日志。

安装

sudo apt-get install libspdlog-dev

2. 使用

日志输出等级枚举

namespace level { enum level_enum : int { trace = SPDLOG_LEVEL_TRACE, debug = SPDLOG_LEVEL_DEBUG, info = SPDLOG_LEVEL_INFO, warn = SPDLOG_LEVEL_WARN, err = SPDLOG_LEVEL_ERROR, critical = SPDLOG_LEVEL_CRITICAL, off = SPDLOG_LEVEL_OFF, n_levels }; 
}

日志输出格式自定义

logger->set_pattern("%Y-%m-%d %H:%M:%S [%t] [%-7l] %v"); %t - 线程 ID（Thread ID）
%n - 日志器名称（Logger name）
%l - 日志级别名称（Level name），如 INFO, DEBUG, ERROR 等
%v - 日志内容（message）
%Y - 年（Year）。 
%m - 月（Month）。 
%d - 日（Day）。 
%H - 小时（24-hour format）。 
%M - 分钟（Minute）。 
%S - 秒（Second）

① 日志记录器类：创建一个基本的日志记录器，并设置 日志级别 和 输出模式

namespace spdlog { 
class logger { logger(std::string name)； logger(std::string name, sink_ptr single_sink) logger(std::string name, sinks_init_list sinks) void set_level(level::level_enum log_level); void set_formatter(std::unique_ptr<formatter> f); template<typename... Args> void trace(fmt::format_string<Args...> fmt, Args &&...args) template<typename... Args> void debug(fmt::format_string<Args...> fmt, Args &&...args) template<typename... Args> void info(fmt::format_string<Args...> fmt, Args &&...args) template<typename... Args> void warn(fmt::format_string<Args...> fmt, Args &&...args) template<typename... Args> void error(fmt::format_string<Args...> fmt, Args &&...args) template<typename... Args> void critical(fmt::format_string<Args...> fmt, Args &&...args) void flush(); //刷新日志 //策略刷新--触发指定等级日志的时候立即刷新日志的输出 void flush_on(level::level_enum log_level); 
};

② 异步日志记录类：为了异步记录日志，可以使用 spdlog::async_logger

class async_logger final : public logger { async_logger(std::string logger_name, sinks_init_list sinks_list, std::weak_ptr<details::thread_pool> tp, async_overflow_policy overflow_policy = async_overflow_policy::block);async_logger(std::string logger_name, sink_ptr single_sink, std::weak_ptr<details::thread_pool> tp, async_overflow_policy overflow_policy = async_overflow_policy::block); // 异步日志输出需要异步工作线程的支持，这里是线程池类 
class SPDLOG_API thread_pool { thread_pool(size_t q_max_items, size_t threads_n, std::function<void()> on_thread_start, std::function<void()> on_thread_stop); thread_pool(size_t q_max_items, size_t threads_n, std::function<void()> on_thread_start); thread_pool(size_t q_max_items, size_t threads_n); }; 
} std::shared_ptr<spdlog::details::thread_pool> thread_pool() { return details::registry::instance().get_tp(); 
} // 默认线程池的初始化接口 
inline void init_thread_pool(size_t q_size, size_t thread_count) 
auto async_logger = spdlog::async_logger_mt("async_logger", "logs/async_log.txt"); 
async_logger->info("This is an asynchronous info message");

③ 日志记录器工厂类

using async_factory = async_factory_impl<async_overflow_policy::block>; template<typename Sink, typename... SinkArgs> 
inline std::shared_ptr<spdlog::logger> create_async( std::string logger_name, SinkArgs &&...sink_args) // 创建一个彩色输出到标准输出的日志记录器，默认工厂创建同步日志记录器 
template<typename Factory = spdlog::synchronous_factory> 
std::shared_ptr<logger> stdout_color_mt(const std::string &logger_name, color_mode mode = color_mode::automatic); 
// 标准错误 
template<typename Factory = spdlog::synchronous_factory> 
std::shared_ptr<logger> stderr_color_mt(const std::string &logger_name, color_mode mode = color_mode::automatic); 
// 指定文件 
template<typename Factory = spdlog::synchronous_factory> 
std::shared_ptr<logger> basic_logger_mt(const std::string &logger_name, const filename_t &filename, bool truncate = false, const file_event_handlers &event_handlers = {}) 
// 循环文件 
template<typename Factory = spdlog::synchronous_factory> 
std::shared_ptr<logger> rotating_logger_mt(const std::string &logger_name, const filename_t &filename, size_t max_file_size, size_t max_files, bool rotate_on_open = false) 
...

④ 日志落地类

namespace spdlog { 
namespace sinks { 
class SPDLOG_API sink 
{ 
public: virtual ~sink() = default; virtual void log(const details::log_msg &msg) = 0; virtual void flush() = 0; virtual void set_pattern(const std::string &pattern) = 0; virtual void set_formatter(std::unique_ptr<spdlog::formatter> sink_formatter) = 0; void set_level(level::level_enum log_level); 
}; using stdout_sink_mt; 
using stderr_sink_mt; 
using stdout_color_sink_mt; 
using stderr_color_sink_mt; // 滚动日志文件-超过一定大小则自动重新创建新的日志文件 sink_ptr rotating_file_sink(filename_t base_filename, std::size_t max_size, std::size_t max_files, bool rotate_on_open = false, const file_event_handlers &event_handlers = ); 
using rotating_file_sink_mt = rotating_file_sink<std::mutex>; // 普通的文件落地对啊 ing 
sink_ptr basic_file_sink(const filename_t &filename, bool truncate = false, const file_event_handlers &event_handlers = {}); using basic_file_sink_mt = basic_file_sink<std::mutex>; 
using kafka_sink_mt = kafka_sink<std::mutex>; 
using mongo_sink_mt = mongo_sink<std::mutex>; 
using tcp_sink_mt = tcp_sink<std::mutex>; 
using udp_sink_mt = udp_sink<std::mutex>; ..... //*_st：单线程版本，不用加锁，效率更高。 //*_mt：多线程版本，用于多线程程序是线程安全的。 
} 
}

全局接口

void set_level(level::level_enum log_level); 		// 输出等级设置接口 
void flush_every(std::chrono::seconds interval); 	// 日志刷新策略-每隔 N 秒刷新一次 
void flush_on(level::level_enum log_level);			// 日志刷新策略-触发指定等级立即刷新

3. 代码样例

3.1 同步日志

样例代码

#include <spdlog/spdlog.h>
#include <spdlog/sinks/stdout_color_sinks.h> 
#include <spdlog/sinks/basic_file_sink.h> 
#include <iostream>int main(){// 1. 设置全局刷新策略 spdlog::flush_every(std::chrono::seconds(1)); // 每秒刷新spdlog::flush_on(spdlog::level::debug);       // debug 及以上级别立即刷新spdlog::set_level(spdlog::level::debug);      // 全局日志等级// 2. 创建同步日志器 -- 工厂接口默认创建的就是同步日志器// auto logger = spdlog::stdout_color_mt("default-logger"); // 标准输出auto logger = spdlog::basic_logger_mt("file-logger", "sync.log");   // 文件输出// %v: 日志的输出内容logger->set_pattern("[%n][%H:%M:%S][%t][%-7l] %v");logger->trace("你好! {}", "千璇"); // trace 默认不会输出（因为 level >= debug 才输出）logger->debug("你好! {}", "千璇");logger->info("你好! {}", "千璇");logger->warn("你好! {}", "千璇");logger->error("你好! {}", "千璇");logger->critical("你好! {}", "千璇");std::cout << "日志输出演示完毕!\n";// 3. 清理所有 logger，确保 flush 并释放资源spdlog::drop_all(); return 0;
}

结果

lighthouse@VM-8-10-ubuntu:spdlog$ ./sync
日志输出演示完毕!# 对应日志文件 sync.log 内容如下
[file-logger][21:35:34][1909301][debug  ] 你好! 千璇
[file-logger][21:35:34][1909301][info   ] 你好! 千璇
[file-logger][21:35:34][1909301][warning] 你好! 千璇
[file-logger][21:35:34][1909301][error  ] 你好! 千璇
[file-logger][21:35:34][1909301][critical] 你好! 千璇

3.2 异步日志演示

#include <spdlog/spdlog.h>
#include <spdlog/sinks/stdout_color_sinks.h> 
#include <spdlog/async.h>
#include <iostream>int main(){// 1. 设置全局刷新策略 spdlog::flush_every(std::chrono::seconds(1)); // 每秒刷新spdlog::flush_on(spdlog::level::debug);       // debug 及以上级别立即刷新spdlog::set_level(spdlog::level::debug);      // 全局日志等级// 2. 初始化异步日志输出线程配置// void init_thread_pool(size_t q_size, size_t thread_count)spdlog::init_thread_pool(3072, 1);// 3. 创建异步日志器auto logger = spdlog::stdout_color_mt<spdlog::async_factory>("async-logger");logger->set_pattern("[%n][%H:%M:%S][%t][%-7l] %v");logger->trace("你好! {}", "千璇"); // trace 默认不会输出（因为 level >= debug 才输出）logger->debug("你好! {}", "千璇");logger->info("你好! {}", "千璇");logger->warn("你好! {}", "千璇");logger->error("你好! {}", "千璇");logger->critical("你好! {}", "千璇");std::cout << "日志输出演示完毕!\n";// 3. 清理所有 logger，确保 flush 并释放资源spdlog::drop_all(); return 0;
}

输出

日志输出演示完毕!
[async-logger][22:02:34][1915206][debug  ] 你好! 千璇
[async-logger][22:02:34][1915206][info   ] 你好! 千璇
[async-logger][22:02:34][1915206][warning] 你好! 千璇
[async-logger][22:02:34][1915206][error  ] 你好! 千璇
[async-logger][22:02:34][1915206][critical] 你好! 千璇

4. 二次封装

原因：

避免单例锁冲突：spdlog 内部有一个单例模式，其有一个默认的日志器，我们可以通过该单例获取日志器再进行日志的输出，但是如果每次日志输出都需要从单例获取对象，容易造成一些冲突导致性能下降，因此一般不直接使用其默认日期，而是创建一个 全局的线程安全日志器 进行使用
spdlog 的日志输出没有关于行号、文件名的输出，使用 普通接口 没有无法实现，因此需要使用宏进行一次二次封装对文件名和行号进行输出
封装初始化接口，便于使用：假设当前一个程序运行的时候，如果它是一个我们的调试模式，那就直接在我们的标准输出里边去进行一个日志的输出，但是如果已经线上运行了，那我们就不需要再去进行标准输出的输出了，而是希望能够将其通过 配置文件 的配置，将日志输出到文件当中，而这里的操作希望能够封装起来（操作：调试模式输出到标准输出 / 文件），便于我们代码当中的使用

思想

封装出一个全局接口，用户进行日志器的创建和初始化，初始化接口接收参数如下：
1. 运行模式 – bool
2. 输出文件名 – 用于发布模式
3. 输出日志等级 – 用于发布模式
对日志输出的接口，进行宏的封装，加入文件名行号的输出

logger.hpp 代码如下

#include <spdlog/spdlog.h>
#include <spdlog/sinks/stdout_color_sinks.h> 
#include <spdlog/sinks/basic_file_sink.h> 
#include <spdlog/async.h>
#include <iostream>// mode: true 发布 / false 调试
std::shared_ptr<spdlog::logger> g_default_logger;
void init_logger(bool mode, const std::string& filename, int32_t level){// 如果是调试, 则标准输出日志器输出等级最低if(!mode){g_default_logger = spdlog::stdout_color_mt("default-logger");g_default_logger->set_level(spdlog::level::level_enum::trace);g_default_logger->flush_on(spdlog::level::level_enum::trace);}else{// 发布: 输出等级根据参数而定g_default_logger = spdlog::basic_logger_mt("file-logger", filename);g_default_logger->set_level((spdlog::level::level_enum)level);g_default_logger->flush_on((spdlog::level::level_enum)level);}g_default_logger->set_pattern("[%n][%H:%M:%S][%t][%-8l]%v");
}#define LOG_TRACE(format, ...) g_default_logger->trace(std::string("[{}:{} ") + format, __FILE__, __LINE__, ##__VA_ARGS__)
#define LOG_DEBUG(format, ...) g_default_logger->debug(std::string("[{}:{}] ") + format, __FILE__, __LINE__, ##__VA_ARGS__)
#define LOG_INFO(format, ...) g_default_logger->info(std::string("[{}:{}] ") + format, __FILE__, __LINE__, ##__VA_ARGS__)
#define LOG_WARN(format, ...) g_default_logger->warn(std::string("[{}:{}] ") + format, __FILE__, __LINE__, ##__VA_ARGS__)
#define LOG_ERROR(format, ...) g_default_logger->error(std::string("[{}:{}] ") + format, __FILE__, __LINE__, ##__VA_ARGS__)
#define LOG_FATAL(format, ...) g_default_logger->critical(std::string("[{}:{}] ") + format, __FILE__, __LINE__, ##__VA_ARGS__)

测试代码如下

#include "logger.hpp"
#include <gflags/gflags.h>DEFINE_bool(run_mode, false, "程序运行模式: false-调试; true 发布");
DEFINE_string(log_file, "", "发布模式下指定日志的输出文件");
DEFINE_int32(log_level, 0, "发布模式下指定日志的输出等级");int main(int argc, char* argv[]){google::ParseCommandLineFlags(&argc, &argv, true);init_logger(FLAGS_run_mode, FLAGS_log_file, FLAGS_log_level);LOG_DEBUG("你好: {}", "island");LOG_INFO("你好: {}", "island");LOG_WARN("你好: {}", "island");LOG_ERROR("你好: {}", "island");LOG_FATAL("你好: {}", "island");LOG_DEBUG("这是一个测试");  // 这里用 ##__VA_ARGS__ 可以省略参数, 但是如果用 __VA_ARGS__ 就不行return -1;
}

结果输出

lighthouse@VM-8-10-ubuntu:spdlog$ ./main
[default-logger][23:27:45][1934415][debug   ][main.cc:12] 你好: island
[default-logger][23:27:45][1934415][info    ][main.cc:13] 你好: island
[default-logger][23:27:45][1934415][warning ][main.cc:14] 你好: island
[default-logger][23:27:45][1934415][error   ][main.cc:15] 你好: island
[default-logger][23:27:45][1934415][critical][main.cc:16] 你好: island
[default-logger][23:27:45][1934415][debug   ][main.cc:17] 这是一个测试
lighthouse@VM-8-10-ubuntu:spdlog$ ./main --run_mode=true --log_file=./main.log --log_level=3