利用单例模式与阻塞队列实现异步的日志系统,记录服务器运行状态
Log 类是一个用于日志记录的C++类,其设计具有以下特点和功能:
类结构概述
-
类成员变量:
path_: 日志文件存储路径。suffix_: 日志文件后缀名。MAX_LINES_: 每个日志文件允许的最大行数。lineCount_: 当前日志文件已写的行数。toDay_: 当前日志文件对应的日期。isOpen_: 表示日志系统是否已开启。buff_: 缓冲区,用于暂存待写入文件的日志内容。level_: 当前日志级别。isAsync_: 标记是否启用异步写入。fp_: 指向日志文件的FILE指针。deque_: 一个阻塞队列,用于在异步模式下存放待写入日志的字符串。writeThread_: 异步写入线程的智能指针。mtx_: 互斥锁,用于保证多线程环境下的日志写入操作线程安全。
-
构造函数:
- 私有的构造函数,确保类只能通过单例模式访问。
-
初始化方法:
init方法接收日志级别、日志路径、文件后缀名和最大队列容量参数,用于初始化日志系统,包括创建文件、设置日志级别以及开启异步写入线程(如果需要的话)。
-
静态方法:
Instance()方法提供单例模式访问,返回唯一实例。FlushLogThread()方法启动一个线程用于异步写入日志。
-
日志写入与管理方法:
write方法接受日志级别和格式化的日志内容,并负责将日志写入缓冲区或者直接写入文件,或者放入异步队列中。flush方法用于将缓冲区中的日志内容强制写入文件,并刷新文件流。AsyncWrite_是异步写入线程内部调用的方法,用于从队列中取出日志内容并写入文件。GetLevel和SetLevel方法分别用于获取和设置日志级别。IsOpen方法检查日志系统是否已开启。
-
日志文件切分:
- 类还包含了处理日志文件按天切分的逻辑,当日历日期改变时,会自动创建新的日志文件。
-
宏定义:
- 定义了
LOG_DEBUG、LOG_INFO、LOG_WARN和LOG_ERROR四个宏,方便快捷地记录不同级别的日志信息。
- 定义了
主要特性总结
- 日志级别控制:可以通过设置日志级别来控制输出的日志内容。
- 异步写入支持:可以选择启用异步写入,提高日志记录效率,降低日志写入对主线程性能的影响。
- 日志文件管理:能够按天自动切分日志文件,并保证日志文件大小在一定范围内。
- 线程安全:通过互斥锁保护共享资源,使得多线程环境下日志记录依然有序和可靠。
- 单例模式:采用单例模式保证在整个程序生命周期内只存在一个全局的日志对象,便于统一管理和资源控制。
Do not communicate by sharing memory; instead, share memory by communicating.

浙公网安备 33010602011771号