log4cpp 使用指南
log4cpp 使用指南
1. 引入 log4cpp
首先，确保将 log4cpp 安装到你的项目中。假设你已经通过源代码或包管理工具安装了 log4cpp，并且已经正确设置了包含路径和库路径。
1.1 安装 log4cpp
你可以通过源码安装 log4cpp，或者使用包管理工具（如 pkg-config）来进行配置。
如果你使用的是 pkg-config，可以在 CMake 文件中进行设置：
find_package(PkgConfig REQUIRED)
pkg_check_modules(LOG4CPP REQUIRED IMPORTED_TARGET log4cpp)
1.2 在 CMake 中配置 log4cpp
如果你希望手动配置 log4cpp，可以添加以下 CMake 设置来包含头文件和链接库：
# 添加 log4cpp 头文件和库路径
include_directories(${CMAKE_SOURCE_DIR}/External/log4cpp-master/include)
link_directories(${CMAKE_SOURCE_DIR}/External/log4cpp-master/lib)# 将 log4cpp 链接到项目
target_link_libraries(QtGuiApp PRIVATE log4cpp)
2. 基本使用
在使用 log4cpp 之前，你需要创建一个 Category 对象，并指定日志输出的方式（Appender）。常见的 Appender 包括控制台输出、文件输出等。
2.1 代码示例
#include <log4cpp/Category.hh>
#include <log4cpp/PatternLayout.hh>
#include <log4cpp/FileAppender.hh>int main() {// 创建一个文件 appender，并设置日志格式log4cpp::FileAppender* fileAppender = new log4cpp::FileAppender("FileAppender", "logs/mylog.log");log4cpp::PatternLayout* layout = new log4cpp::PatternLayout();layout->setConversionPattern("[%d{%Y-%m-%d %H:%M:%S}] [%p] %c: %m%n");fileAppender->setLayout(layout);// 获取根目录 Category 对象，并设置日志级别和 appenderlog4cpp::Category& root = log4cpp::Category::getRoot();root.setAppender(fileAppender);root.setPriority(log4cpp::Priority::INFO);// 使用日志root.info("This is an info message.");root.error("This is an error message.");// 关闭日志系统log4cpp::Category::shutdown();return 0;
}
3. 配置文件支持
3.1 配置文件格式
log4cpp 支持通过配置文件来管理日志设置。常见的配置文件格式为 INI-style 格式，类似于 Java 的 log4j 配置文件。一个典型的配置文件可能如下所示：
# 设置日志根目录和默认日志级别
log4cpp.rootCategory=DEBUG, RollingFileAppender# 设置 RollingFileAppender，控制文件大小、备份数量等
log4cpp.appender.RollingFileAppender=log4cpp::RollingFileAppender
log4cpp.appender.RollingFileAppender.fileName=logs/mylog.log
log4cpp.appender.RollingFileAppender.maxFileSize=5MB
log4cpp.appender.RollingFileAppender.maxBackupIndex=5
log4cpp.appender.RollingFileAppender.layout=log4cpp::PatternLayout
log4cpp.appender.RollingFileAppender.layout.ConversionPattern=[%d{%Y-%m-%d %H:%M:%S}] [%p] %c: %m%n# 设置 ConsoleAppender（可以输出到控制台）
log4cpp.appender.ConsoleAppender=log4cpp::ConsoleAppender
log4cpp.appender.ConsoleAppender.layout=log4cpp::PatternLayout
log4cpp.appender.ConsoleAppender.layout.ConversionPattern=[%d{%Y-%m-%d %H:%M:%S}] [%p] %c: %m%n# 定义 Category（日志类别）
log4cpp.category.category1=DEBUG, ConsoleAppender
log4cpp.category.category2=INFO, RollingFileAppender
3.2 读取配置文件
在 C++ 代码中，你可以使用 log4cpp::PropertyConfigurator 来加载和初始化配置文件：
#include <log4cpp/PropertyConfigurator.hh>
#include <log4cpp/Category.hh>int main() {// 读取配置文件log4cpp::PropertyConfigurator::configure("log4cpp.conf");// 获取日志根目录log4cpp::Category& root = log4cpp::Category::getRoot();// 使用日志root.info("This is an info message.");root.error("This is an error message.");// 自定义 Category 使用配置文件中的设置log4cpp::Category& category1 = log4cpp::Category::getCategory("category1");category1.debug("This is a debug message in category1.");log4cpp::Category::shutdown();return 0;
}
4. 配置选项
4.1 配置多个 Appender
你可以配置多个 Appender，例如 RollingFileAppender 输出到文件，ConsoleAppender 输出到控制台，并为不同的日志类别分配不同的 appender：
log4cpp.appender.FileAppender=log4cpp::RollingFileAppender
log4cpp.appender.FileAppender.fileName=logs/app.log
log4cpp.appender.FileAppender.maxFileSize=10MB
log4cpp.appender.FileAppender.maxBackupIndex=10
log4cpp.appender.FileAppender.layout=log4cpp::PatternLayout
log4cpp.appender.FileAppender.layout.ConversionPattern=[%d{%Y-%m-%d %H:%M:%S}] [%p] %c: %m%nlog4cpp.appender.ConsoleAppender=log4cpp::ConsoleAppender
log4cpp.appender.ConsoleAppender.layout=log4cpp::PatternLayout
log4cpp.appender.ConsoleAppender.layout.ConversionPattern=[%d{%Y-%m-%d %H:%M:%S}] [%p] %m%nlog4cpp.category.category1=DEBUG, FileAppender
log4cpp.category.category2=INFO, ConsoleAppender
4.2 配置日志级别
你可以在配置文件中为不同的日志类别设置不同的日志级别（例如 DEBUG, INFO, WARN 等）：
log4cpp.rootCategory=DEBUG, RollingFileAppender
log4cpp.category.category1=INFO, ConsoleAppender
log4cpp.category.category2=ERROR, RollingFileAppender
4.3 配置 PatternLayout
PatternLayout 可以定义日志输出的格式，支持多种占位符：
log4cpp.appender.ConsoleAppender.layout.ConversionPattern=[%d{%Y-%m-%d %H:%M:%S}] [%p] %c: %m%n
4.4 配置日志文件的最大备份数
log4cpp.appender.RollingFileAppender.maxBackupIndex=7 # 保留7个备份文件
5. 高级功能
5.1 按时间或大小切割日志
你可以配置 RollingFileAppender 使日志文件按大小或按时间进行切割：
log4cpp.appender.RollingFileAppender.maxFileSize=5MB
log4cpp.appender.RollingFileAppender.maxBackupIndex=5
5.2 按日志类别管理多个模块的日志
你可以为不同的模块或功能区分不同的日志类别，以便于管理和过滤日志：
log4cpp.category.module1=DEBUG, ConsoleAppender
log4cpp.category.module2=ERROR, RollingFileAppender
6. 总结
通过配置文件管理 log4cpp 的日志系统使得日志的配置更加灵活且易于调整。你可以根据需求动态修改日志输出格式、日志级别以及日志存储策略。
- 支持按时间、按大小切割日志：通过
RollingFileAppender控制日志文件的大小和备份数量。 - 支持多种输出方式：同时输出到文件和控制台等多个地方。
- 灵活的日志级别控制：通过配置文件控制不同模块或类别的日志级别。
如果有任何疑问或需要进一步帮助，请随时提出！