概述
日志类主要用于在程序运行过程中记录信息、错误、警告以及其他需要跟踪的数据,这对于调试、监控应用状态及后期问题分析至关重要。一个高效且灵活的日志类应该满足以下几个核心需求。
日志级别管理:可定义多个日志级别,比如:DEBUG、INFO、WARN、ERROR、FATAL等,以便根据情况筛选日志的详细程度。同时,还允许运行时动态调整日志输出级别,便于在生产环境中减少不需要的日志输出,或增加更详细的日志输出。
多线程安全:在多线程的环境下,可确保日志写入操作是线程安全的,避免日志内容混乱或程序崩溃。通常情况下,这可以通过互斥锁、原子操作或线程局部存储等机制来实现。
灵活的输出点:支持将日志输出到控制台、本地文件、网络套接字、数据库等多种目的地,并可配置输出目标,允许同时或选择性地输出到多个地方。
自动文件管理:可自动创建和管理日志文件,并按时间、大小滚动日志文件。同时,文件名应包含日期等信息,便于归档和查询。
日志格式化:支持格式化字符串,允许在日志中内嵌变量、时间戳、进程ID、线程ID等信息。另外,支持自定义日志格式,以满足不同场景下的需求。
高性能与低延迟:采用缓冲机制减少I/O操作次数,提高日志写入效率。支持异步写入日志,避免阻塞主线程,减少对应用性能的影响。
可以看到,封装一个高效且灵活的日志类,需要考虑的东西非常多。目前有很多第三方开源日志库,比如:glog、spdlog或EasyLogger等,但这些库用起来相对比较复杂,特别是在底层模块中使用,耦合比较严重。为了简化底层模块中日志类的使用,我们封装了下面的CHP_Logger类。
CHP_Logger类
CHP_Logger是一个简单、易于集成和使用的日志类,可在各个底层库中使用。应用层可使用glog、spdlog或EasyLogger等第三方日志库,并配合该日志类记录底层库日志。CHP_Logger类的头文件,可参考下面的示例代码。
#pragma once #include <stdarg.h> #include "HP_Types.h" #include "HP_Mutex.h" enum IHPLoggerLevel { HPLoggerLevel_None, HPLoggerLevel_Error, HPLoggerLevel_Warn, HPLoggerLevel_Info, HPLoggerLevel_Debug, HPLoggerLevel_Trace, HPLoggerLevel_Count }; typedef void(*CALLBACK_LOGGER_OUTPUT)(IHPLoggerLevel level, const char *pszLog, void *pContext); class CHP_Logger { public: static void Open(); static CHP_Logger *&Singleton(); static void Close(); void SetLevel(IHPLoggerLevel level); bool IsLogEnabled(IHPLoggerLevel level); void SetLogOutputListener(CALLBACK_LOGGER_OUTPUT pCbOutput, void *pContext); void SetMaxLogLen(unsigned int uiLen); void Error(const char *pszFormat, ...); void Warn(const char *pszFormat, ...); void Info(const char *pszFormat, ...); void Debug(const char *pszFormat, ...); void Trace(const char *pszFormat, ...); static void Error(CHP_Logger *pLogger, const char *pszFormat, ...); static void Warn(CHP_Logger *pLogger, const char *pszFormat, ...); static void Info(CHP_Logger *pLogger, const char *pszFormat, ...); static void Debug(CHP_Logger *pLogger, const char *pszFormat, ...); static void Trace(CHP_Logger *pLogger, const char *pszFormat, ...); protected: CHP_Logger(); ~CHP_Logger(); private: void Log(const char *pszFormat, va_list &argList, IHPLoggerLevel level); private: static CHP_Logger *m_pThis; IHPLoggerLevel m_level; CALLBACK_LOGGER_OUTPUT m_pCbOutput; void *m_pContext; char *m_pszLog; unsigned int m_uiMaxLogLen; CHP_Mutex m_mutexLog; };
在上面的示例代码中,我们声明了一个枚举类型IHPLoggerLevel,用于指定日志输出级别。CHP_Logger类是一个接口类,不需要实例化。因此,我们将构造函数和析构函数声明成了私有的。下面,我们将分别介绍其导出的公共实例接口。
SetLevel:设置日志输出级别。参数level为日志输出级别,用于控制日志输出的详细程度。
IsLogEnabled:用于判断指定级别的日志是否使能。参数level为指定的日志级别,返回值为true表示该级别的日志使能,否则不使能。
SetLogOutputListener:设置日志输出监听器。参数pCbOutput为日志输出的回调函数,参数pContext为回调函数上下文。应用层需要设置日志输出监听器,以对回调函数中的日志进行自定义操作,比如:写本地文件、输出到控制台、传输到网络等。
SetMaxLogLen:设置单条日志的最大长度。参数uiLen为单条日志的最大长度,单位为字节,传0时,默认为16KB。
Error:输出错误日志。pszFormat为日志格式字符串,支持可变参数。
Warn:输出警告日志。pszFormat为日志格式字符串,支持可变参数。
Info:输出信息日志。pszFormat为日志格式字符串,支持可变参数。
Debug:输出调试日志。pszFormat为日志格式字符串,支持可变参数。
Trace:输出详尽日志。pszFormat为日志格式字符串,支持可变参数。
除了上面的实例接口外,我们还导出了5个同名的静态接口,分别为:Error、Warn、Info、Debug、Trace。这几个静态接口一般用于底层动态链接库中输出日志,这样底层和应用层可以共用一个日志单实例对象。
总结
日志类是编程中用于生成、管理、保存应用程序运行时信息的核心组件,对于故障排查、系统监控、性能分析、合规审计至关重要。日志类更是开发、运维团队的重要工具,能帮助我们快速定位问题,优化系统性能,保障系统稳定运行。