muduo LogFile详解

1. 简介

LogFile用于日志消息记录。
日志消息长度达到设定值、日志记录时间超过当天进行日志滚动。当短时间内日志长度较小时，不能将日志信息长时间放如缓存中，因此日志每记录1024次数就检查一次距前一次flush到文件的时间是否超过3s，若是则flush到文件中。另外，可以选择是否使用互斥锁锁保证线程安全。

2. 类与接口

// Use of this source code is governed by a BSD-style license
// that can be found in the License file.
//
// Author: Shuo Chen (chenshuo at chenshuo dot com)

#include "LogFile.h"

#include "FileUtil.h"
#include "ProcessInfo.h"

#include <assert.h>
#include <stdio.h>
#include <time.h>


// https://blog.csdn.net/wanggao_1990/article/details/118882674

LogFile::LogFile(const string& basename, //  日志文件名，默认保存在当前工作目录下
                 off_t rollSize,           //  日志文件超过设定值进行roll
                 bool threadSafe,          //  默认线程安全，使用互斥锁操作将消息写入缓冲区
                 int flushInterval,        //  flush刷新时间间隔
                 int checkEveryN)          //  每1024次日志操作，检查一个是否刷新、是否roll
	: basename_(basename),
	  rollSize_(rollSize),
	  flushInterval_(flushInterval),
	  checkEveryN_(checkEveryN),
	  count_(0),
	  mutex_(threadSafe ? new MutexLock : NULL), // 操作AppendFiles是否加锁
	  startOfPeriod_(0),                         // 用于标记同一天的时间戳(GMT的零点)
	  lastRoll_(0),                              // 上一次roll的时间戳
	  lastFlush_(0)                              // 上一次flush的时间戳
{
	assert(basename.find('/') == string::npos);
	rollFile();
}

LogFile::~LogFile() = default;

// 将len长度logline写入日志
void LogFile::append(const char* logline, int len)
{
	if (mutex_) {
		MutexLockGuard lock(*mutex_);
		append_unlocked(logline, len);
	} else {
		append_unlocked(logline, len);
	}
}

void LogFile::flush()
{
	if (mutex_) {
		MutexLockGuard lock(*mutex_);
		file_->flush();
	} else {
		file_->flush();
	}
}

// 将len长度logline添加到日志
void LogFile::append_unlocked(const char* logline, int len)
{
	file_->append(logline, len);

	// 当前写入日志总长度超过 rollSize_， 就进行日志roll
	if (file_->writtenBytes() > rollSize_) {
		rollFile();
	} else {
		++count_;
		// 每写入日志checkEveryN_ = 1024 次就检查是否需要roll
		if (count_ >= checkEveryN_) {
			count_ = 0;
			time_t now = ::time(NULL);
			time_t thisPeriod_ = now / kRollPerSeconds_ * kRollPerSeconds_;
			// 超过当天时间就roll
			if (thisPeriod_ != startOfPeriod_) {
				rollFile();
			} else if (now - lastFlush_ > flushInterval_) {  // 距离上一次flush间隔超过flushInterval_ = 3 秒就再一次flush
				lastFlush_ = now;
				file_->flush();
			}
		}
	}
}

// 滚动日志,相当于重新生成日志文件，再向里面写数据 
// 可以回滚返回true,否则返回false
bool LogFile::rollFile()
{
	time_t now = 0;
	string filename = getLogFileName(basename_, &now);
	
	// 注意，这里先除KRollPerSeconds然后乘KPollPerSeconds表示对齐值KRollPerSeconds的整数倍，
	// 也就是事件调整到当天零点(/除法会引发取整)
	time_t start = now / kRollPerSeconds_ * kRollPerSeconds_;

	if (now > lastRoll_) {
		lastRoll_ = now;
		lastFlush_ = now;
		startOfPeriod_ = start;
		file_.reset(new FileUtil::AppendFile(filename));
		return true;
	}
	return false;
}

// 构造一个日志文件名,日志名由基本名字+时间戳+主机名+进程id+加上“.log”后缀
// now记录当前时间
// 返回新生成的日志名
string LogFile::getLogFileName(const string& basename, time_t* now)
{
	string filename;
	filename.reserve(basename.size() + 64);
	filename = basename;

	char timebuf[32];
	struct tm tm;
	*now = time(NULL);
	gmtime_r(now, &tm); // FIXME: localtime_r ?
	strftime(timebuf, sizeof timebuf, ".%Y%m%d-%H%M%S.", &tm);
	filename += timebuf;

	filename += ProcessInfo::hostname();

	char pidbuf[32];
	snprintf(pidbuf, sizeof pidbuf, ".%d", ProcessInfo::pid());
	filename += pidbuf;

	filename += ".log";

	return filename;
}

3. 源码

Github