muduo库的高性能日志库(三)——Logging文件
admin
2024-01-28 22:06:36

目录

  • SourceFile内部类
  • Impl内部类
    • 内部实现细节
  • Logger类
    • 1. 规定日志的几个等级
    • 2. 两个内部类
    • 3. 设置日志属性
    • 4. 构造函数
    • 5. 析构函数
  • 日志宏

接下看一下Logging文件,该文件主要负责全局日志级别,输出目的地设置
Logger内有两个内部类
SourceFile,主要负责获取文件名
Impl,实际用于日志消息的处理类

SourceFile内部类

该类就负责获取基文件名
eg:
/home/gty/muduo/muduo/base/test.cc
对应的基文件名就是
test.cc

实现很简单,调用了c语言库函数strrchr

C 库函数char *strrchr(const char *str, int c)
在参数 str 所指向的字符串中搜索最后一次出现字符 c(一个无符号字符)的位置

  class SourceFile{//找到基文件的文件名,并将data_指向基文件名的开始,size_存文件名长度public:templateSourceFile(const char (&arr)[N])  //数组引用: data_(arr),size_(N-1){//C 库函数 char *strrchr(const char *str, int c) //在参数 str 所指向的字符串中搜索最后一次出现字符 c(一个无符号字符)的位置const char* slash = strrchr(data_, '/'); // builtin functionif (slash){data_ = slash + 1;size_ -= static_cast(data_ - arr);}}explicit SourceFile(const char* filename): data_(filename){const char* slash = strrchr(filename, '/');if (slash){data_ = slash + 1;}size_ = static_cast(strlen(data_));}const char* data_;int size_;};

Impl内部类

该类就是指定了一条日志的具现化

|----日志打印时间
|----日志缓存(LogStream)
|----日志的level
|----行号
|----文件名称

具体如下

//内部类,实际用于日志消息的处理类
class Impl
{public:typedef Logger::LogLevel LogLevel;Impl(LogLevel level, int old_errno, const SourceFile& file, int line);//格式化时间戳void formatTime();void finish();Timestamp time_;   //日志时间戳LogStream stream_; //日志缓存流LogLevel level_;   //日志级别int line_;         //当前记录日志宏的源代码名称SourceFile basename_;  //当前记录日志宏的源代码名称
};

下面看看该类的实现细节

内部实现细节

__thread char t_errnobuf[512];
__thread char t_time[64];  //当前线程的时间字符串“年:月:日:时:分:秒”
__thread time_t t_lastSecond;  //当前线程上一次日志记录时的秒数//Impl的构造函数
Logger::Impl::Impl(LogLevel level, int savedErrno, const SourceFile& file, int line): time_(Timestamp::now()),//登记当前时间stream_(),   //Logstream类level_(level),  //日志级别line_(line),   //行号basename_(file)  //文件名称
{formatTime();  //格式化时间CurrentThread::tid(); //缓存当前线程tid//将当前线程id和日志等级名称输出到buf当中stream_ << T(CurrentThread::tidString(), CurrentThread::tidStringLength());stream_ << T(LogLevelName[level], 6);if (savedErrno != 0)  //如果savedErrno不为0,saveErrno为错误号{//将错误码对应的错误信息存入t_errnobuf当中,并且输入到stream_的buf当中stream_ << strerror_tl(savedErrno) << " (errno=" << savedErrno << ") ";}
}//格式化时间
void Logger::Impl::formatTime()
{int64_t microSecondsSinceEpoch = time_.microSecondsSinceEpoch();//获取微秒格式时间//获得秒,kMicroSecondsPerSecond为1000000time_t seconds = static_cast(microSecondsSinceEpoch / Timestamp::kMicroSecondsPerSecond);//获得微秒,及剩余微秒数int microseconds = static_cast(microSecondsSinceEpoch % Timestamp::kMicroSecondsPerSecond);if (seconds != t_lastSecond) //日志记录不在同一秒数{t_lastSecond = seconds; //更新日志记录时间struct tm tm_time;if (g_logTimeZone.valid()){tm_time = g_logTimeZone.toLocalTime(seconds);}else{::gmtime_r(&seconds, &tm_time); // FIXME TimeZone::fromUtcTime}int len = snprintf(t_time, sizeof(t_time), "%4d%02d%02d %02d:%02d:%02d",tm_time.tm_year + 1900, tm_time.tm_mon + 1, tm_time.tm_mday,tm_time.tm_hour, tm_time.tm_min, tm_time.tm_sec);assert(len == 17); (void)len;}//输入到缓冲区当中if (g_logTimeZone.valid()){Fmt us(".%06d ", microseconds);assert(us.length() == 8);stream_ << T(t_time, 17) << T(us.data(), 8);}else{Fmt us(".%06dZ ", microseconds);assert(us.length() == 9);stream_ << T(t_time, 17) << T(us.data(), 9);}
}//所有信息输出完毕,然后再将文件名称和行号输出到buf当中
void Logger::Impl::finish()
{stream_ << " - " << basename_ << ':' << line_ << '\n';
}

Logger类

Logger的两个内部类看完,分析这个类

1. 规定日志的几个等级

    |----TRACE|----DEBUG|----INFO|----WARN|----ERROR|----FATAL|----NUM_LOG_LEVELS

代码如下:

  enum LogLevel{TRACE,DEBUG,INFO,WARN,ERROR,FATAL,NUM_LOG_LEVELS,};

2. 两个内部类

|----SourceFile  (文件名截取)
|----Impl        (实际日志信息处理类)

3. 设置日志属性

|----setLogLevel(***)  //设置日志等级
|----setOutput(***)    //设置输出函数
|----setFlush(***)     //设置刷新函数
|----setTimeZone(***)  //设置日期格式

代码如下:

  //设置日志级别static void setLogLevel(LogLevel level);//设置输出函数(默认的输出函数是输出到stdout)typedef void (*OutputFunc)(const char* msg, int len);//设置刷新函数(默认的刷新函数是刷新到stdout)typedef void (*FlushFunc)();static void setOutput(OutputFunc);  //默认fwrite到stdoutstatic void setFlush(FlushFunc);    //默认fflush到stdoutstatic void setTimeZone(const TimeZone& tz);  默认 GMT

下面为默认的OutputFuncFlushFunc

//默认为stdout
void defaultOutput(const char* msg, int len)
{size_t n = fwrite(msg, 1, len, stdout);//FIXME check n(void)n;
}//默认为stdout
void defaultFlush()
{fflush(stdout);
}
//设置默认的输出和刷新函数
Logger::OutputFunc g_output = defaultOutput;
Logger::FlushFunc g_flush = defaultFlush;
TimeZone g_logTimeZone;

初始化日志等级

//初始化日至等级
Logger::LogLevel initLogLevel()
{//getenv()用来取得参数name环境变量的内容。//参数name为环境变量的名称,如果该变量存在则会返回指向该内容的指针。if (::getenv("MUDUO_LOG_TRACE"))return Logger::TRACE;else if (::getenv("MUDUO_LOG_DEBUG"))return Logger::DEBUG;elsereturn Logger::INFO;
}Logger::LogLevel g_logLevel = initLogLevel();

4. 构造函数

有四个重载
四种不同类型的日志格式

  Logger(SourceFile file, int line);Logger(SourceFile file, int line, LogLevel level);Logger(SourceFile file, int line, LogLevel level, const char* func);Logger(SourceFile file, int line, bool toAbort);

5. 析构函数

日志打印的基本所有操作都是在析构中进行的

//主要在析构进行
Logger::~Logger()
{impl_.finish();const LogStream::Buffer& buf(stream().buffer());g_output(buf.data(), buf.length());if (impl_.level_ == FATAL){//如果这是一个FATAL刷新缓冲区,然后直接中断程序g_flush();abort();}
}

日志宏

使用LOG_*之类的宏会创建一个临时匿名Logger对象,这个对象有一个Impl对象,而Impl对象有一个LogStream对象。LOG_*宏会返回一个LogStream对象的引用。用于将内容输入到LogStream中的一个buffer中。

在Logger的析构函数中,调用 g_output,即 g_output(buf.data(), buf.length()),将存于LogStream的buffer的日志内容输出。如果是FATAL错误,还要调用g_flush,最后abort()程序。如果没有调用g_flush,会一直输出到缓冲区(标准输出缓冲区,文件FILE缓冲区)满才会真的输出在标准输出,或者写入到文件中去。

//日志宏
#define LOG_TRACE if (muduo::Logger::logLevel() <= muduo::Logger::TRACE) \muduo::Logger(__FILE__, __LINE__, muduo::Logger::TRACE, __func__).stream()
#define LOG_DEBUG if (muduo::Logger::logLevel() <= muduo::Logger::DEBUG) \muduo::Logger(__FILE__, __LINE__, muduo::Logger::DEBUG, __func__).stream()
#define LOG_INFO if (muduo::Logger::logLevel() <= muduo::Logger::INFO) \muduo::Logger(__FILE__, __LINE__).stream()
#define LOG_WARN muduo::Logger(__FILE__, __LINE__, muduo::Logger::WARN).stream()
#define LOG_ERROR muduo::Logger(__FILE__, __LINE__, muduo::Logger::ERROR).stream()
#define LOG_FATAL muduo::Logger(__FILE__, __LINE__, muduo::Logger::FATAL).stream()
#define LOG_SYSERR muduo::Logger(__FILE__, __LINE__, false).stream()
#define LOG_SYSFATAL muduo::Logger(__FILE__, __LINE__, true).stream()

相关内容

热门资讯

贵港工伤赔偿标准最新或2023... 工伤保险待遇标准又称工伤赔偿标准,是指工伤职工、工亡职工亲属依法应当享受的赔偿项目和标准。那么在贵港...
玉林工伤赔偿标准最新或2023... 工伤保险待遇标准又称工伤赔偿标准,是指工伤职工、工亡职工亲属依法应当享受的赔偿项目和标准。那么在玉林...
广告传媒公司最新或2023(历...   尊敬的各位客户、合作伙伴、社会各界朋友,xx广告传媒公司的各位同仁、兄弟姐妹们:  大家好!  ...
大嘴足彩118期离散:胆材指数... 周六17117期足彩头奖6注130万,二等奖118注2.8万,任九937注11671元,奖金中等偏上...
晚清民国时期艺术大师:吴昌硕的... 画风是一位艺术家品格、气质、性情、学养的映现,特别是表达了「这一个」真我的写意画。真我即本质本性的自...