日志模型

上一篇中我们将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

/****************************************************************************** Module: VC-Logger Purpose: 记录程序日志。 1. 把日志信息输出到指定文件 2. 对于 GUI 程序,可以把日志信息发送到指定窗口 3. 对于Console应用程序,可以把日志信息发往标准输出 (std::cout) Desc: 1、功能: -------------------------------------------------------------------------------------- a) 把日志信息输出到指定文件 b) 每日生成一个日志文件 c) 对于 GUI 程序,可以把日志信息发送到指定窗口 d) 对于Console应用程序,可以把日志信息发往标准输出 (std::cout) e) 支持 MBCS / UNICODE,Console / GUI,win32 / x64 程序 f) 支持动态加载和静态加载日志组件 DLL g) 支持 DEBUG/TRACE/INFO/WARN/ERROR/FATAL 等多个日志级别 2、可用性: -------------------------------------------------------------------------------------- a) 简单纯净:不依赖任何程序库或框架 b) 使用接口简单,不需复杂的配置或设置工作 c) 提供 CStaticLogger 和 CDynamicLogger 包装类用于静态或动态加载以及操作日志组件,用户无需关注加载细节 d) 程序如果要记录多个日志文件只需为每个日志文件创建相应的 CStaticLogger 或 CDynamicLogger 对象 e) 只需调用 Log()/Debug()/Trace()/Info()/Warn()/Error()/Fatal() 等方法记录日志 f) 日志记录方法支持可变参数 g) 日志输出格式: 3、性能: -------------------------------------------------------------------------------------- a) 支持多线程同时发送写日志请求 b) 使用单独线程在后台写日志,不影响工作线程的正常执行 c) 采用批处理方式批量记录日志 Usage: 方法一:(静态加载 Logger DLL) -------------------------------------------------------------------------------------- 0. 应用程序包含 StaticLogger.h 头文件 1. 创建 CStaticLogger 对象(通常为全局对象) 2. 调用 CStaticLogger->Init(...) 初始化日志组件 3. 使用 CStaticLogger->Log()/Debug()/Trace()/Info()/Warn()/Error()/Fatal() 等方法写日志 4. 调用 CStaticLogger->UnInit(...) 清理日志组件(CStaticLogger 对象析构时也会自动清理日志组件) 方法二:(动态加载 Logger DLL) -------------------------------------------------------------------------------------- 0. 应用程序包含 DynamicLogger.h 头文件 1. 创建 CDynamicLogger 对象(通常为全局对象) 2. 调用 CDynamicLogger->Init(...) 初始化日志组件 3. 使用 CDynamicLogger->Log()/Debug()/Trace()/Info()/Warn()/Error()/Fatal() 等方法写日志 4. 调用 CDynamicLogger->UnInit(...) 清理日志组件(CDynamicLogger 对象析构时也会自动清理日志组件) 方法三:(直接用导出函数加载 Logger DLL) -------------------------------------------------------------------------
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值