【C++框架#2】gflags 和 gtest 安裝使用

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