上一篇中我们将C++11的线程做了简单的封装,再加上消息队列组成了一个带有消息循环的线程模型。这篇中我们通过继承上一篇说的类,来实现一个服务器程序常用的组件,日志模块。不论是服务器程序还是客户端程序,详细的日志输出都是定位问题的有利工具,一个好的日志模块对服务器程序来说尤为重要,我们需要在书写日志的时候保证不影响或者最小的影响服务器的性能。这里我通过建立一个新的线程来书写日志,用内存池来管理投递消息所需要占用的内存,其他线程只需投递任务而避免了磁盘IO。从而避免了逻辑线程的性能损耗。
首先我们先定义日志的输出级别,这个早有先例:
enum LogLevel {
LOG_DEBUG_LEVEL = 1,
LOG_INFO_LEVEL = 2,
LOG_WARN_LEVEL = 3,
LOG_ERROR_LEVEL = 4,
LOG_FATAL_LEVEL = 5,
};
在消息队列中投递需要写的char*字符串,这里为了更好的支持消息格式,需要用的C的多参数传递:
void LogDebug(const char* file, int line, const char* log...);
void LogInfo(const char* file, int line, const char* log...);
void LogWarn(const char* file, int line, const char* log...);
void LogError(const char* file, int line, const char* log...);
void LogFatal(const char* file, int line, const char* log...);
在其他线程投递日志的时候调用类似与print函数,还是相当友好的API。下面这个函数解析传进来的消息内容,将日志格式化到一个从内存池中申请的连续地址中,投递到消息队列中。这里有点问题就是这些操作都是在投递日志的线程中执行的,也可以将这个步骤投递到消息队列中让日志线程去执行这个过程。究竟是将这个过程集中到日志线程中还是分摊到逻辑线程中这个可能需要考虑实际的应用的情况。为了更 好的定位问题,我们日志输出的时候需要带上文件和打印时间。_timer是对C++11的时间封装,下一篇会讲。
void CLog::_PushFormatLog(const char* file, int line, char* level, const char* log, va_list list) {
_time.Now();
char* time = _pool.PoolMalloc<char>(32);
_time.GetFormatTime(time, 32);
char* log_str =_pool.PoolLargeMalloc<char>();
int curlen = snprintf(log_str, __log_buf_size, "[%s:%s-%s:%d] ", time, level, file, line);
_pool.PoolFree(time, 32);
if (curlen < 0) {
strcpy(log_str, "...Log format error!");
} else {
vsnprintf(log_str + curlen, __log_buf_size - curlen, log, list);
}
Push(log_str);
}
此外我们还需要一个机制来检测日期,将日志分开日期的打印存储到磁盘上。
void CLog::_CheckDateFile() {
if (_cur_date != _time.GetDate()) {
_cur_date = _time.GetDate();
if (_log_file.is_open()) {
_log_file.close();
}
std::string file_name = _file_name.append(".");
file_name.append(_time.GetDateStr());
file_name.append(".log");
_log_file.open(file_name.c_str(), std::ios::app | std::ios::out);
}
}
我们一个程序中最多需要一个日志线程,所以日志对象最好是一个单例,这样也极大的方便了其他线程投递时的调用,这里我们再写一个辅助的类来实现单例:
#ifndef HEADER_SINGLE
#define HEADER_SINGLE
template<typename T>
class CSingle
{
private:
CSingle(const CSingle&);
CSingle& operator = (const CSingle&);
public:
CSingle() {}
virtual ~CSingle() {}
static T& Instance() {
static T instance;
return instance;
}
};
#endif
这样其他线程调用的时候类似这样:
CLog::Instance().LogFatal(__FILE__, __LINE__, "%s", "there is a error");
还是不够友好,我们再对结构封装一次,从而让调用者只关心和自己有关的日志内容,其他的一概不管:
#define LOG_DEBUG(log, ...) CLog::Instance().LogDebug(__FILE__, __LINE__, log, ##__VA_ARGS__);
#define LOG_INFO(log, ...) CLog::Instance().LogInfo(__FILE__, __LINE__, log, ##__VA_ARGS__);
#define LOG_WARN(log, ...) CLog::Instance().LogWarn(__FILE__, __LINE__, log, ##__VA_ARGS__);
#define LOG_ERROR(log, ...) CLog::Instance().LogError(__FILE__, __LINE__, log, ##__VA_ARGS__);
#define LOG_FATAL(log, ...) CLog::Instance().LogFatal(__FILE__, __LINE__, log, ##__VA_ARGS__);
这样一来就干净干练了很多~~
下面是测试使用代码:
#include "Time.h"
#include "Log.h"
int main() {
CLog::Instance().Start();
CLog::Instance().SetLogName("test");
CLog::Instance().SetLogLevel(LOG_DEBUG_LEVEL);
LOG_DEBUG("%s", "it is a debug log");
CRunnable::Sleep(1000);
LOG_INFO("%s", "it is a info log");
CRunnable::Sleep(1000);
LOG_WARN("%s", "it is a warn log");
CRunnable::Sleep(1000);
LOG_ERROR("%s", "it is a error log");
CRunnable::Sleep(1000);
LOG_FATAL("%s", "it is a fatal log");
CRunnable::Sleep(1000);
CLog::Instance().Stop();
CLog::Instance().Join();
int a = 0;
a++;
}
贴点测试时的日志打印:
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:271] modify a event to epoll, event flag: 2, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 2, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:271] modify a event to epoll, event flag: 1, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 1, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:ERROR-/root/projects/LinuxCppNet/net/linux/Socket.cpp:251] event->_event_flag_set : 1
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/NetObject.cpp:204] err: 257
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 2, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 1, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:ERROR-/root/projects/LinuxCppNet/net/linux/Socket.cpp:251] event->_event_flag_set : 1
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/NetObject.cpp:204] err: 257
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 2, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 1, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:ERROR-/root/projects/LinuxCppNet/net/linux/Socket.cpp:251] event->_event_flag_set : 1
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/NetObject.cpp:204] err: 257
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 2, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 1, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:ERROR-/root/projects/LinuxCppNet/net/linux/Socket.cpp:251] event->_event_flag_set : 1
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/NetObject.cpp:204] err: 257
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 2, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:288] reset one shot, event flag: 1, sock : 9
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/linux/CEpoll.cpp:199] epoll_wait get events! num :1, TheadId : 1323493120
[2018 07 05-07:15:05:ERROR-/root/projects/LinuxCppNet/net/linux/Socket.cpp:251] event->_event_flag_set : 1
[2018 07 05-07:15:05:DEBUG-/root/projects/LinuxCppNet/net/NetObject.cpp:204] err: 257
最后是源码地址:
GitHub:https://github.com/caozhiyi/Base