spdlog源码阅读 (2): sinks的创建和使用-白红宇

spdlog源码阅读 (2): sinks的创建和使用

阅读量：5033 次

发布时间：2019-06-12

本文共 3643 字，大约阅读时间需要 12 分钟。

2. sink创建

2.1 还是rotating_file_sink

我们仍然以rotating_file_sink为例来说明在spdlog中sink的创建过程。

在spdlog-master/tests中能够找到file_log.cpp文件，其中有关于rotate的示例代码，如下：

TEST_CASE("rotating_file_logger1", "[rotating_logger]]"){    1. prepare_logdir();    2. std::string basename = "logs/rotating_log";    3. auto logger = spdlog::rotating_logger_mt("logger", basename, 1024, 0);    //......}

line: 3,创建名为"logger"，文件名"rotating_log"，在文件夹logs下，文件最大为1024(字节),

且只能有一个文件。返回的是logger对象，并且它是支持多线程的(mt)。

2.2 create

继续查看rotating_logger_mt，如下：

inline std::shared_ptr
    
      spdlog::rotating_logger_mt(const std::string& logger_name, const filename_t& filename, size_t max_file_size, size_t max_files){    1. return create
     
      (logger_name, filename, SPDLOG_FILENAME_T("txt"), max_file_size, max_files);}

line: 1, 实际创建对象。create是一个模板函数，如下：

template 
    
     inline std::shared_ptr
     
       spdlog::create(const std::string& logger_name, Args... args){    2. sink_ptr sink = std::make_shared
      
       (args...);    3. return details::registry::instance().create(logger_name, { sink });}

Sink在本示例中即spdlog::sinks::rotating_file_sink_mt, 第二个模板参数也就是

rotating_file_sink_mt的构造函数参数。针对每一种sink，都会存在一个对应的create函数。

当然sink的实际创建也是发生在该函数中(line2)。

2.3 单例registry

1.2中 line:3又继续调用了registry执行对象的创建，我们先来看下registry是个什么鬼

#ifdef SPDLOG_NO_REGISTRY_MUTEXtypedef registry_t
    
      registry;#elsetypedef registry_t
     
       registry;#endif

可以看出在多线程的情况下，类registry需要锁的支持。

下面来到最需要关心的位置，也就是最后的create, 代码如下：

template
    
     std::shared_ptr
     
       create(const std::string& logger_name, const It& sinks_begin, const It& sinks_end){    1. std::lock_guard
      
        lock(_mutex);    throw_if_exists(logger_name);    std::shared_ptr
       
         new_logger;    2. if (_async_mode)        new_logger = std::make_shared
        
         (logger_name, sinks_begin, sinks_end, _async_q_size, _overflow_policy, _worker_warmup_cb, _flush_interval_ms, _worker_teardown_cb);    else        new_logger = std::make_shared
         
          (logger_name, sinks_begin, sinks_end); 3. if (_formatter) new_logger->set_formatter(_formatter); if (_err_handler) new_logger->set_error_handler(_err_handler); new_logger->set_level(_level); //Add to registry 4. _loggers[logger_name] = new_logger; return new_logger;}

line1: 在多线程的情况下，创建一个logger对象需要加锁。

line2: 区分日志同步写/异步写，实际logger对象创建也是发生在这里。

line3: 有自定义格式时，使用自定义的格式。

line4: 将新创建的对象加入全局管理(registry是个单例)，这也是需要加锁的原因。

2.4 小结

从上述的过程中，可以看到sink的实际创建是发生在create中，创建的sink对象做为参数参与了

logger对象的创建。在logger中sink起到的作用是什么，就是下面要讨论的问题了。

3. sink的使用

仍然以2.1 的例子继续，看下当时省略的代码先：

TEST_CASE("rotating_file_logger1", "[rotating_logger]]"){    //......    for (int i = 0; i < 10; ++i)        1. logger->info("Test message {}", i);    //......}

line1: 调用info输出日志，跟踪代码看下info到底是做了什么。

//片段1template 
    
     inline void spdlog::logger::log(level::level_enum lvl, const char* msg){    details::log_msg log_msg(&_name, lvl);    log_msg.raw << msg;    1. _sink_it(log_msg);}//片段2inline void spdlog::logger::_sink_it(details::log_msg& msg){    _formatter->format(msg);    2. for (auto &sink : _sinks)    {    if( sink->should_log( msg.level))    {        3. sink->log(msg);    }    }    if(_should_flush_on(msg))    flush();}