google-glog 开源库分析(三)：glog核心类结构

google-glog类核心结构

图片地址：https://github.com/yangdw/yangdw.tech.doc/blob/master/专题_开源库/google-glog类关系结构.jpg

工作原理

• 每个日志输出都对应一个google::LogMessage类对象
  • 构造函数中为日志添加必要的前缀：文件名、函数、时间、日志等级等信息
  • 析构函数中将日志消息写入到日志文件中
  • 每个google::LogMessage对象都持有一个定制的C++输出流及日志缓存
• 通过定制C++输出，实现日志的便捷输出
  • 继承自标准输入输出流，定制日志库使用的输出流--输出缓存在输出流对象初始化时提供
• 通过C++匿名对象的短生命周期性质，实现日志的自动输出
  • 通过宏会在日志输出时创建google::LogMessage匿名对象，该匿名对象会在行末分号处结束生命周期自动调用析构函数
• 内部提供统一的日志输出接口
  • 通过内部类LogDestination提供日志输出接口，其内部包含日志文件输出类对象
  • 日志文件输出对象是继承了Logger的LogFileObject对象，每个LogFileObject对象对应一个日志文件
  • LogDestination控制日志的输出，同时也控制日志文件的创建等行为

示例分析

• GLOG(ERROR)<<"hello,world!";
  • 根据宏定义:

    • define LOG(severity) COMPACT_GOOGLE_LOG_ ## severity.stream()

    • define COMPACT_GOOGLE_LOG_ERROR google::LogMessage(FILE,LINE,google::GLOG_ERROR)

  • 日志输出语句扩展为：
    • google::LogMessage(FILE,LINE,google::GLOG_ERROR).stream()<<"hello,world!";
• google::LogMessage(FILE,LINE,google::GLOG_ERROR)，创建一个匿名对象
  • 在构造函数中，创建日志输出流对象及日志缓存空间，并为日志添加必要的前缀信息
  • 日志输出流对象、日志缓存空间及日志状态标记等封装为google::LogMessage::LogMessageData结构
• std::ostream& google::LogMessage::stream()，方法stream()提供输出流支持
  • 通过操作符<<将日志消息输出到日志缓存中
• 行结尾分号处，匿名对象生命周期结束，调用析构函数
  • 在析构函数中，日志消息通过LogDestination类提供的静态方法接口写入日志文件

功能划分

通过以上分析可以看出，google::LogMessage类是基本骨架，构建了日志对象及输出通道
具体的功能则有相应的类结构来完成，包括C++输出流及日志输出

C++输出流

• LogMessage::LogStream类，日志输出流对象
  • 继承自std::ostream，接收日志输出
  • 包含LogStreamBuf类数据成员
• LogStreamBuf，日志输出流缓存对象
  • 继承自std::streambuf，日志输出缓存
  • 本身不创建日志缓存区，构造函数时由参数传入内存区
• LogMessage::LogMessageData结构，每个LogMessage对象持有一个该结构对象
  • 包含LogMessage::LogStream类对象
  • 包含日志存储的内存区，用改内存区初始化LogMessage::LogSteam对象
  • 包含了日志的状体标记信息，如时间、等级、是否已经输出等信息

日志输出

• Logger抽象类提供了日志输出接口，其子类LogFileObject是日志文件对象
  • 每个日志文件对应一个LogFileObject对象
  • LogFileObject对象提供日志文件的管理：创建新日志文件
• LogDestination类提供了日志输出接口
  • 通过静态方法，提供全局性的日志输出接口
  • 包含一个LogFileObject对象数组--每个日志级别对应一个日志文件
  • 除了日志文件之外，还提供多日志输出渠道：终端、邮件、系统日志等