sylar服务器框架分析——日志系统

一、梳理函数调用流程

P1-P6：

1、基础写日志方式

// 1、这里定义了一个Logger类的智能指针logger，这里的new会调用Logger的构造函数
//在构造函数里调用m_formatter.reset函数将输出格式设置为默认值
//m_formatter.reset(new LogFormatter("%d{%Y-%m-%d %H:%M:%S}%T%t%T%F%T[%p]%T[%c]%T%f:%l%T%m%n"));
//这里的new会调用LogFormatter的构造函数，会调用LogFormatter::init()方法解析格式
//根据解析出来的格式项将不同类型的FormatItem添加到m_items里
//比如说，解析到有%t说明要打印线程号，就将ThreadIdFormatItem添加到m_items里
sylar::Logger::ptr logger(new sylar::Logger);  
//2、给logger添加一个StdoutLogAppender，即日志打印到标准输出上
logger->addAppender(sylar::LogAppender::ptr(new sylar::StdoutLogAppender)); 
//3、创建一个日志事件LogEvent的智能指针，这里暂时将服务开启至今时间用0代替，线程号用1代替，协程号用2代替
sylar::LogEvent::ptr event(new sylar::LogEvent(__FILE__,__LINE__,0,1,2,time(0)));
//4、这里调用logger->log函数，指定打印级别为DEBUG,打印的事件为上一句创建的event
//logger自身有一个成员m_level，也是一个日志打印级别，表示这个logger只打印m_level级别及以上的日志
//在logger->log函数里，会对比m_level和指定的打印级别(这里是DEBUG)，然后遍历logger里的所有appender，调用每个appender的log函数(这里只有一个StdoutLogAppender)
//appender里的log函数会调用m_formatter->format函数打印到不同的appender上。
//m_formatter->format函数里会遍历m_items里的FormatItem，调用所有类别的FormatItem的format函数，比如是线程号的FormatItem，就将线程号写入logger的stringstream流里
logger->log(sylar::LogLevel::DEBUG,event);  

使用了观察者模式

  第一组观察者模式是Logger和LogAppender：
  这里Logger类是Subject，里面有一个m_appenders成员，是LogAppender智能指针的vector集合，当要打印时调用Logger::log方法，就会通知里面所有的LogAppender打印，各自调用LogAppender::log方法。
  而LogAppender类是Observer，是一个基类，派生出StdoutLogAppender和FileLogAppender，子类重写父类的纯虚函数log。
 
  第二组观察者模式是LogFormatter和FormatItem：
  这里LogFormatter是Subject，里面有一个m_items成员，是FormatItem智能指针的vector集合，当要LogAppender要调用log方法打印时，会调用m_formatter->format方法，这个LogFormatter::format方法就会通知所有的格式项FormatItem调用FormatItem::format方法，将要打印的项写入到stringstream流里。
  而FormatItem类是Observer，是一个基类，派生出MessageFormatItem、LevelFormatItem、ThreadIdFormatItem等等一系列的子类（一种格式对应一个类，比如%t对应线程号，即ThreadIdFormatItem），子类重写父类的纯虚函数format。

P7-P8有修改：

2、使用宏通过流形式写日志

//1、同上
sylar::Logger::ptr logger(new sylar::Logger); 
//2、添加StdoutLogAppender和FileLogAppender，设置了FileLogAppender的打印格式和打印级别
logger->addAppender(sylar::LogAppender::ptr(new sylar::StdoutLogAppender)); 
sylar::FileLogAppender::ptr file_appender(new sylar::FileLogAppender("./log.txt"));
sylar::LogFormatter::ptr fmt(new sylar::LogFormatter("%d%T%p%T%m%n"));
file_appender->setFormatter(fmt);
file_appender->setLevel(sylar::LogLevel::ERROR);
logger->addAppender(file_appender);
//3、使用这两个宏通过流形式将不同的级别的日志写入到logger中
//这两个宏都是调用的是SYLAR_LOG_LEVEL(logger,level)这个宏，只是level设置不一样
//在SYLAR_LOG_LEVEL里，如果logger->getLevel()<=level，会创建一个LogEventWrap对象
//LogEventWrap对象只是将LogEvent封装了一下，里面还是创建了一个LogEvent对象的智能指针，最后返回LogEvent对象的流对象
//因此最后SYLAR_LOG_INFO(logger) 最后返回的是stringstream流对象，可以用<<将字符串写入
//最后在LogEventWrap对象的析构函数中，调用了logger的log函数，遍历logger里的所有appender，调用appender的log函数
SYLAR_LOG_INFO(logger) << "test macro";
SYLAR_LOG_ERROR(logger) << "test macro error";

为什么要加个LogEventWrap类将LogEvent类包装起来？

  因为这里想要以流的形式打印日志，即：