spdlog使用

1.概述

spdlog github地址，spdlog日志库自身带有包括控制台日志记录、基础文件日志记录、循环文件日志记录、每日文件日志记录等在内的日志记录方式，能满足日常不同的情景需求。
本文主要介绍spdlog日志库的基本使用，包括创建日志记录器(logger)、创建日志记录器槽(sink)、设置日志输出内容格式(pattern)、设置日志输出等级(level)等。如果想要获得这个库更加全面详细的使用资料，可以阅读spdlog学习笔记这篇文章。

2.基础概念

下面陈列的函数主要用于简单说明功能，其中的参数省略了一些命名空间以及类名

1.level_enum: 日志等级枚举，包括 trace、info、debug、warn、err、critical、off、n_levels。

2.sink: 日志记录器槽，进行底层操作（比如格式化内容、输出内容到控制台/文件）的类。spdlog自带的几种sinks已经能满足日常需求，也可以派生其基类设计新的sink以满足特殊的需求。sink类主要使用的函数包括：

• set_pattern(const std::string&) ：设置日志输出的内容格式。
• set_level(level_enum) ： 设置日志输出的最低等级。
• log(log_msg) ：由logger自动调用，外部不会主动调用。

3.logger: 日志记录器，被顶层调用来输出日志的类。一个logger对象中存储有多个sink，当调用logger的日志输出函数时，logger会调用自身存储的所有sink对象的log(log_msg) 函数进行输出。与自带的sink对应，spdlog也自带了几种logger。logger类主要使用的函数包括：

• set_pattern(const std::string&) ：设置logger包含的所有sink的日志输出内容格式。
• set_level(level_enum) ：设置logger日志输出最低等级，如果logger包含的sink没有设置日志等级的话，则会为其设置日志等级。
• log(level_enum level,log_msg content) ：按照level等级进行输出content，logger其中日志输出最低等级小于或等于level的sink会进行执行输出操作。
• trace(content,arg1,arg2…) ：按照trace等级进行输出，输出内容由content与后面的参数格式化而成。同类的函数还包括：debug/info/warn…。

3.st/mt： 对象版本，spdlog中的logger对象和sink对象都有两种版本，一种是以st结尾的单线程版本，以及以mt结尾的多线程版本。

• st：单线程版本，不用加锁，效率更高。
• mt：多线程版本，用于多线程程序是线程安全的。

3.使用示例

3.1创建logger

1.使用spdlog自带的logger

 //<1.创建名称为LoggerName1、内容输出到控制台的单线程版本日志记录器
auto logger1 = spdlog::stdout_color_st("LoggerName1");

//<2.创建名称为LoggerName2、内容输出到Logs/BasicFileLog.txt的多线程版本日志记录器
auto logger2 = spdlog::basic_logger_mt("LoggerName2", "Logs/BasicFileLog.txt");

//<3.创建名称为LoggerName3、内容输出到Logs/RotatingFileLog.txt的多线程版本日志记录器
//参数1024*1024*5设置了文件最大容量为5mb，参数3设置了文件最大数量为3
//当日志文件存储超过5mb时，将重命名日志文件并且新增另外一个日志文件
//当日志文件数量超过3时，将删除第一个日志文件

auto logger3 = spdlog::rotating_logger_mt("LoggerName3", "Logs/RotatingFileLog.txt", 1024 * 1024 * 5, 3);

//<4.创建名称为LoggerName4、内容输出到Logs/DailyFileLog.txt的多线程版本日志记录器
//参数2和30指定每天生成日志文件的时间为凌晨2点30分

auto logger4 = spdlog::daily_logger_mt("LoggerName4", "Logs/DailyFileLog.txt", 2, 30);

2.使用sink创建logger

//<1.创建名称为LoggerName1、内容输出到控制台的单线程版本日志记录器
auto logger1 = std::make_shared<spdlog::logger>("LoggerName1", 
std::make_shared<spdlog::sinks::stdout_color_sink_st>());

//<2.创建名称为LoggerName2、内容输出到Logs/BasicFileLog.txt的多线程版本日志记录器
auto logger2 = std::make_shared<spdlog::logger>("LoggerName2", std::make_shared<spdlog::sinks::basic_file_sink_mt>("Logs/BasicFileLog.txt"));

//<3.创建名称为LoggerName3、内容输出到Logs/RotatingFileLog.txt的多线程版本日志记录器
//参数1024*1024*5设置了文件最大容量为5mb，参数3设置了文件最大数量为3
//当日志文件存储超过5mb时，将重命名日志文件并且新增另外一个日志文件
//当日志文件数量超过3时，将删除第一个日志文件
auto logger3 = std::make_shared<spdlog::logger>("LoggerName3", std::make_shared<spdlog::sinks::rotating_file_sink_mt>("Logs/RotatingFileLog.txt",1024 * 1024 * 5, 3));

//<4.创建名称为LoggerName4、内容输出到Logs/DailyFileLog.txt的多线程版本日志记录器
//参数2和30指定每天生成日志文件的时间为凌晨2点30分
auto logger4 = std::make_shared<spdlog::logger>("LoggerName4", 
std::make_shared<spdlog::sinks::daily_file_sink_mt>("Logs/DailyFileLog.txt", 2,30));

3.创建使用同个sink的多个logger

//<1.创建sink
auto sink = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("Logs/RotatingFileLog.txt", 1024 * 1024 * 5, 3);

//<2.创建共同使用sink的多个logger，这些logger把内容一起输出到RotatingFileLog.txt中
auto logger1 = std::make_shared<spdlog::logger>("LoggerName1", sink);
auto logger2 = std::make_shared<spdlog::logger>("LoggerName2", sink);
auto logger3 = std::make_shared<spdlog::logger>("LoggerName3", sink);

4.创建使用多个sink的单个logger

//<1.创建多个sink
auto sink1 = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
auto sink2 = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("Logs/RotatingFileLog.txt", 1024 * 1024 * 5, 3);
std::vector< spdlog::sink_ptr> sinks = { sink1,sink2 };

//<2.创建使用多个sink的单个logger，logger会把内容输出到不同位置，此处是控制台以及RotatingFileLog.txt
auto logger = std::make_shared<spdlog::logger>("LoggerName", sinks.begin(), sinks.end());

3.2设置logger

1.设置pattern控制输出内容格式，设置level控制输出日志等级

 //<1.创建多个sink
auto sink1 = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
auto sink2 = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("Logs/RotatingFileLog.txt", 1024 * 1024 * 5, 3);
std::vector< spdlog::sink_ptr> sinks = { sink1,sink2 };

//<2.创建使用多个sink的单个logger，logger会把内容输出到不同位置，此处是控制台以及RotatingFileLog.txt
auto logger = std::make_shared<spdlog::logger>("LoggerName", sinks.begin(), sinks.end());

//<3.设置sink的pattern和level
sink1->set_pattern("[%Y-%m-%d %H:%M:%S.%e][%l]>>>%v");
sink1->set_level(spdlog::level::debug);
sink2->set_pattern("[%Y-%m-%d][%L]%v");
sink2->set_level(spdlog::level::info);

//<4.输出日志
logger->debug("The message will only be shown on stdout.");//因为日志等级为debug，所以只会调用sink1进行输出
logger->info("The message will only be shown on stdout.");//日志等级为info，sink1与sink2都会进行输出

2.常用的pattern标记

下面的表格是我从spdlog学习笔记中截取部分常用的标记

flag	meaning	example
%v	The acutal text to log	“some user text”
%t	Thread id	“1232”
%P	Process id	“3456”
%n	Logger’s name	“some logger name”
%l	The log level of the message	“debug”,“info”,etc
%L	Short log level of the message	“D”,“I”,etc
%Y	Year in 4 digits
%m	Month 1-12
%d	Day of month 1-31
%H	Hours in 24 format 0-23
%M	Minutes 0-59
%S	Seconds 0-59
%e	Millisecond part of the current second 0-999
%^	start color range
%$	end color range
%@	Source file and line (use SPDLOG_TRACE(…),SPDLOG_INFO(…) etc.)	my_file.cpp:123
%!	Source function (use SPDLOG_TRACE(…),SPDLOG_INFO(…) etc. see tweakme for pretty-print)	my_func

3.3使用logger

1.通过spdlog::get(std::string)获取指定名称的logger进行使用

//<1.创建logger
//A.cpp
auto logger1 = std::make_shared<spdlog::logger>("LoggerName1", 
std::make_shared<spdlog::sinks::stdout_color_sink_mt>());
auto logger2 = std::make_shared<spdlog::logger>("LoggerName2", 
std::make_shared<spdlog::sinks::stdout_color_sink_mt>());
spdlog::register(logger2);
auto logger3 = spdlog::stdout_color_st("LoggerName3");

//<2.使用spdlog::get(std::string)获取logger
//B.cpp
auto logger1 = spdlog::get("LoggerName1");//logger1为空，因为logger1在A.cpp中没被注册
if (logger1)
{
    logger1->info("Hello world!");
}
auto logger2 = spdlog::get("LoggerName2");//logger2不为空，因为logger2在A.cpp中已被注册
if (logger2)
{
    logger2->info("Good night.");//输出
}
auto logger3 = spdlog::get("LoggerName3");//logger2不为空，因为spdlog自带的logger对象在构造时会自动注册
if (logger3)
{
    logger3->info("Good night.");//输出
}

2.通过spdlog::default_logger()调用默认的logger进行使用

 //<1.创建logger，并且将logger设置为默认的日志记录器
//A.cpp
auto logger = spdlog::stdout_color_mt("LoggerName");
spdlog::set_default_logger(logger);

//<2.使用spdlog::default_logger()获取默认的日志记录器
//B.cpp
auto logger = spdlog::default_logger();
if (logger)
{
    logger->info("Gigigigigi");//输出
}
spdlog::info("Taco Tuesday");//同样使用default_logger进行输出，更加方便的调用方式；未作default_logger是否为空的判断，会有程序中断的可能。

3.使用宏调用默认的logger的方法进行日志输出

#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_INFO
#include <spdlog/spdlog.h>
SPDLOG_INFO("This message will be shown.");//输出
SPDLOG_DEBUG("This message will not be shown.");//不输出

4.使用fmt库格式化字符串

spdlog::info("Support for string.For example,hello,{}.", "Leborn Jame");//[2021-04-13 22:06:21.219] [info] Support for string.For example,hello,Leborn Jame.

spdlog::warn("Supprot for integer.For example,{:08d}.", 23);//[2021-04-13 22:07:48.865] [warning] Supprot for integer.For example,00000023.

spdlog::error("Support for float.For example,{:3.2}.", 1.23456);//[2021-04-13 22:07:48.865] [error] Support for float.For example,1.2.

spdlog::critical("Support for position parameter.For example,{1} and {0}.", "dog", "cat");//[2021-04-13 22:07:48.866] [critical] Support for position parameter.For example,cat and dog.