tb-common-utils源码分析(1):CLogger

tb-common-utils是淘宝开发使用的一个公共库，淘宝使用广泛的kv系统tair即是使用该库作为其他底层库。该源码可在http://code.taobao.org/project/view/3/中找到。

我们先从最基本的开始分析，首先今天要介绍的是clogger类，该类用于记录日志信息。

先看该类的成员变量：

private: // 文件句柄 int _fd; // 文件名 char *_name; int _check; // 最大文件数量 size_t _maxFileIndex; // 最大文件大小 int64_t _maxFileSize; public: // 单例模式 static CLogger _logger; // 日志级别 int _level; 

setMaxFileSize函数用于设置日志文件的最大大小，从代码中可以看出，日志的最大大小是1GB：

void CLogger::setMaxFileSize( int64_t maxFileSize) { if ( maxFileSize < 0x0 || maxFileSize > 0x40000000){ maxFileSize = 0x40000000;//1GB } _maxFileSize = maxFileSize; }  

setMaxFileIndex函数用于设置日志文件的最大数量，从代码中可以看出，日志文件的最大数量是1024个：

void CLogger::setMaxFileIndex( int maxFileIndex ) { if ( maxFileIndex < 0x00 ) { maxFileIndex = 0x0F; } if ( maxFileIndex > 0x400 ) {//1024 maxFileIndex = 0x400;//1024 } _maxFileIndex = maxFileIndex; }  

checkFile用于检测文件是否已经打开了，如果没有打开，或者已经打开的不是当前文件，则重新打开，并绑定到标准输出：

void CLogger::checkFile() { struct stat stFile; struct stat stFd; fstat(_fd, &stFd); int err = stat(_name, &stFile); // 如果打开失败并且文件不存在, 或者，已经打开的文件，并非我们指定的文件 // 则说明当前指定文件没有打开 if ((err == -1 && errno == ENOENT) || (err == 0 && (stFile.st_dev != stFd.st_dev || stFile.st_ino != stFd.st_ino))) { // 打开当前文件 int fd = open(_name, O_RDWR | O_CREAT | O_APPEND | O_LARGEFILE, 0640); // 保存当前句柄 dup2(fd, _fd); // 将当前标准输出设置为当前文件 dup2(fd, 1); // 如果当前不是标准错误输出 if (_fd != 2) dup2(fd, 2); close(fd); } }  

setLogLevel用于设置日志级别，其成员变量_errstr是一个静态成员数组，保存着各个日志级别的字符串，其成员级别越来越高。从该成员数组的初始化中，我们可以看出，日志级别分别支持error、warn、info、debug。默认的日志级别为最高。

logMessage用于输出日志信息，比较复杂，看代码：

void CLogger::logMessage(int level,const char *file, int line, const char *function,const char *fmt, ...) { // 如果当前要打印的日志的级别，大于设定的日志级别，则退出 if (level>_level) return; // 如果设定了文件名，并且打开了check，则进行文件检测 // _check默认是关闭的 if (_check && _name) { checkFile(); } // 得到当前时间 time_t t; time(&t); struct tm *tm = ::localtime((const time_t*)&t); char data1[4000]; char buffer[5000]; va_list args; va_start(args, fmt); vsnprintf(data1, 4000, fmt, args); va_end(args); int size; if (level < TBSYS_LOG_LEVEL_INFO) { size = snprintf(buffer,5000,"[%04d-%02d-%02d %02d:%02d:%02d] %-5s %s (%s:%d) %s/n", tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec, _errstr[level], function, file, line, data1); } else { size = snprintf(buffer,5000,"[%04d-%02d-%02d %02d:%02d:%02d] %-5s %s:%d %s/n", tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec, _errstr[level], file, line, data1); } // 去掉过多的换行 while (buffer[size-2] == '/n') size --; buffer[size] = '/0'; while (size > 0) { // 全部写入文件 ssize_t success = ::write(_fd, buffer, size); if (success == -1) break; size -= success; } // 如果_maxFileSize大于0 if ( _maxFileSize ){ pthread_mutex_lock(&_fileSizeMutex); off_t offset = ::lseek(_fd, 0, SEEK_END); if ( offset < 0 ){ // we got an error , ignore for now } else { // 如果文件大小大于设置最大值，则分割日志 if ( static_cast<size_t>(offset) >= _maxFileSize ) { rotateLog(NULL); } } pthread_mutex_unlock(&_fileSizeMutex); } } 

rotateLog用于分割日志，如果可以指定旧文件的命令格式，如果不指定，则按默认格式来：

void CLogger::rotateLog(const char *filename, const char *fmt) { // 如果filename没有指定，则默认为当前已设定的文件 if (filename == NULL && _name != NULL) { filename = _name; } // 如果当前进程可以访问该文件 if (access(filename, R_OK) == 0) { char oldLogFile[256]; time_t t; time(&t); struct tm *tm = ::localtime((const time_t*)&t); // 如果设定了文件名的格式 if (fmt != NULL) { char tmptime[256]; strftime(tmptime, sizeof(tmptime), fmt, tm); sprintf(oldLogFile, "%s.%s", filename, tmptime); } else { sprintf(oldLogFile, "%s.%04d%02d%02d%02d%02d%02d", filename, tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec); } //如果文件数量过多，则删除最前面的文件，并加入当前文件 if ( _maxFileIndex > 0 ) { pthread_mutex_lock(&_fileIndexMutex); if ( _fileList.size() >= _maxFileIndex ) { std::string oldFile = _fileList.front(); _fileList.pop_front(); unlink( oldFile.c_str()); } _fileList.push_back(oldLogFile); pthread_mutex_unlock(&_fileIndexMutex); } rename(filename, oldLogFile); } // 重新打开新的日志文件 int fd = open(filename, O_RDWR | O_CREAT | O_APPEND | O_LARGEFILE, 0640); dup2(fd, _fd); dup2(fd, 1); if (_fd != 2) dup2(fd, 2); close(fd); } 

主要函数介绍完了，看看如何使用。

为方便使用，此处定义了一些宏：

#define TBSYS_LOG_LEVEL(level) TBSYS_LOG_LEVEL_##level, __FILE__, __LINE__, __FUNCTION__ #define TBSYS_LOGGER tbsys::CLogger::_logger #define TBSYS_PRINT(level, ...) TBSYS_LOGGER.logMessage(TBSYS_LOG_LEVEL(level), __VA_ARGS__) #define TBSYS_LOG(level, ...) (TBSYS_LOG_LEVEL_##level>TBSYS_LOGGER._level) ? (void)0 : TBSYS_PRINT(level, __VA_ARGS__)

在使用时，我们只需要调用TBSYS_LOG()即可，如TBSYS_LOG(DEBUG,"test")。