VC-Logger高性能 C++ 通用日志组件

联合创作 · 2023-09-30 00:43

VC-Logger 是一个简单易用的 C++ 程序通用日志组件。设计时着重考虑三个方面:功能、可用性和性能。为了让大家能更方便的学习 VC-Logger,特此精心制作了几个测试用例:TestGUILogger(GUI 版本测试用例 / 静态加载)、TestDynamicLogger(GUI 版本测试用例 / 动态加载)、TestConsoleLogger(Console 版本测试用例 / 静态加载)。

功能: 本日志组件的目的是满足大多数应用程序记录日志的需求 —— 把日志输出到文件或发送到应用程序中,并不提供一些复杂但不常用的功能。本日志组件的功能包括:

  1. 把日志信息输出到指定文件

  2. 每日生成一个日志文件

  3. 对于 GUI 程序,可以把日志信息发送到指定窗口

  4. 对于Console应用程序,可以把日志信息发往标准输出 (std::cout)

  5. 支持 MBCS / UNICODE,Console / GUI 程序

  6. 支持动态加载和静态加载日志组件 DLL

  7. 支持 DEBUG/TRACE/INFO/WARN/ERROR/FATAL 等多个日志级别

可用性: 本日志组件着重考虑了可用性,尽量让使用者用起来觉得简便、舒心:

  1. 简单纯净:不依赖任何程序库或框架

  2. 使用接口简单,不需复杂的配置或设置工作

  3. 提供 CStaticLogger 和 CDynamicLogger 包装类用于静态或动态加载以及操作日志组件,用户无 需关注加载细节

  4. 程序如果要记录多个日志文件只需为每个日志文件创建相应的 CStaticLogger 或 CDynamicLogger 对象

  5. 只需调用 Log()/Debug()/Trace()/Info()/Warn()/Error()/Fatal() 等方法记录日志

  6. 日志记录方法支持可变参数

  7. 日志输出格式:<时间> <线程ID> <日志级别> <日志内容>

性能: 性能是组件是否值得使用的硬指标,本组件从设计到编码的过程都尽量考虑到性能优化:

  1. 支持多线程同时发送写日志请求

  2. 使用单独线程在后台写日志,不影响工作线程的正常执行

  3. 采用批处理方式批量记录日志

*** 使用方法 ***
方法一:(静态加载 Logger DLL)
--------------------------------------------------------------------------------------

  1. 应用程序包含 StaticLogger.h 头文件

  2. 创建 CStaticLogger 对象(通常为全局对象)

  3. 调用 CStaticLogger->Init(...) 初始化日志组件

  4. 使用 CStaticLogger->Log()/Debug()/Trace()/Info()/Warn()/Error()/Fatal() 等方法写日志

  5. 调用 CStaticLogger->UnInit(...) 清理日志组件(CStaticLogger 对象析构时也会自动清理日志组件)

方法二:(动态加载 Logger DLL)
--------------------------------------------------------------------------------------

  1. 应用程序包含 DynamicLogger.h 头文件

  2. 创建 CDynamicLogger 对象(通常为全局对象)

  3. 调用 CDynamicLogger->Init(...) 初始化日志组件

  4. 使用 CDynamicLogger->Log()/Debug()/Trace()/Info()/Warn()/Error()/Fatal() 等方法写日志

  5. 调用 CDynamicLogger->UnInit(...) 清理日志组件(CDynamicLogger 对象析构时也会自动清理日志组件)

方法三:(直接用导出函数加载 Logger DLL)
--------------------------------------------------------------------------------------

  1. 应用程序包含 Logger.h 头文件

  2. 手工调用 ILoger_Create() 和 ILoger_Destroy() 导出函数创建和销毁 ILogger 对象 

    (注:如果是动态加载,需手工调用 ::LoadLibrary()/::FreeLibrary() 系列 API 函数加载和卸载 Logger DLL)

    [
            ***** 对于希望通过窗口接收日志信息的 GUI 程序 *****
        A. 日志组件初始化成功后调用 SetGUIWindow(HWND) 设置收日志的窗口
        B. 窗口须响应处理 LOG_MESSAGE 消息
        C. 处理完 LOG_MESSAGE 消息后,调用 ILogger::FreeLogMsg() 销毁接收到的 TLogMsg 
    ]

Environment:

  1. Windows 2000 or later (_WIN32_WINNT >= 0x0500)

  2. VC++ 2010 or later

Release:

  1. Logger_C.dll - Console/MBCS/Release

  2. Logger_CD.dll - Console/MBCS/Debug

  3. Logger_CU.dll - Console/Unicode/Release

  4. Logger_CUD.dll - Console/Unicode/Debug

  5. Logger.dll - GUI/MBCS/Release

  6. Logger_D.dll - GUI/MBCS/Debug

  7. Logger_U.dll - GUI/Unicode/Release

  8. Logger_UD.dll - GUI/Unicode/Debug

Examples:

  1. TestGUILogger         (GUI / 静态加载)

  2. TestDynamicLogger  (GUI / 动态加载)

  3. TestConsoleLogger   (Console / 静态加载)

浏览 10
点赞
评论
收藏
分享

手机扫一扫分享

编辑 分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

编辑 分享
举报