Log4Qt 基本介绍

来源:互联网 发布:几个树莓派能玩lol知乎 编辑:程序博客网 时间:2024/06/18 11:59

简述

在项目开发过程中,离不开代码的调试、Bug 的追踪,这时日志便显得尤为重要。

在 C++ 中,主流的日志组件有 Log4cpp、log4cplus、log4cxx。。。很神奇吧,全都以 log4 开头,这是因为它们均移植自 Java 中著名的日志处理跟踪项目 - log4j,并保持了 API 上的一致。

值得庆祝的是,在 Qt 中也有这么一个衍生品 - Log4Qt。

  • 简述
  • Log4Qt 简介
  • Log4Qt 基本组成
  • 编译 Log4Qt
  • 配置 Log4Qt
    • 将 Log4Qt 源码添加至项目中
    • 将 Log4Qt 作为第三方库使用

版权所有:一去丶二三里,转载请注明出处:http://blog.csdn.net/liang19890820

Log4Qt 简介

Log4Qt 是 Apache Log4j 的 Qt 移植版,主要用于记录日志。通过使用 Log4Qt,我们可以:

  • 控制日志的输出格式
  • 通过定义日志信息的级别,来更加细致地控制日志的生成过程。
  • 控制日志信息的输出位置,例如:文件、控制台、数据库等。
  • ……

最不可思议的是,这些都可以通过配置文件来灵活地进行控制,而无需修改代码。但有一点很不好,缺少示例和文档(文档基本上是由 Log4J 代码移植的)。

  • 主页:http://log4qt.sourceforge.net/
  • 文档:http://log4qt.sourceforge.net/html/index.html

由于 Log4Qt 的开发在 2009 年就终止了,所以其官网提供的源码仅支持 Qt4:

  • for Qt4:https://sourceforge.net/projects/log4qt/

为了兼容 Qt5,我们不得不对其进行一些列的更改。而且如果要将其当做第三方库使用的话,还需要对每个类进行导出。。。好吧,工作量的确不小!值得庆祝的是,有人已经将轮子完善了,这里提供一个升级版:

  • for Qt5:https://github.com/MEONMedical/Log4Qt

这个升级版很棒,不但可以将 Log4Qt 源码添加至项目中,而且还可以将其编译为库。如果你对 Log4Qt 的使用不熟悉,没关系,它里面还提供了相应的示例。

Log4Qt 基本组成

  • Logger
    提供日志记录服务。
    Log4Qt 允许定义多个 Logger,每个 Logger 拥有自己的名字,Logger 之间通过名字来表明隶属关系。有一个 Logger 称为 rootLogger,它永远存在,是其它 Logger 的 parentLogger,可以通过 Log4Qt::Logger::rootLogger() 方法获得,其它 Logger 则通过 Log4Qt::LogManager::logger(const QString &rName) 方法获得(这是最常用的方法)。

  • Appender
    指定日志的存放位置,例如:控制台、文件、数据库等。

  • Layout
    控制输出消息的格式,也就是格式化输出的信息。

编译 Log4Qt

下载 Log4Qt(for Qt5),解压缩,目录结构如下所示:

Log4Qt

可以看到,同时支持 CMake 和 qmake。其中,src 是需要特别关注的目录,里面包含了 Log4Qt 的所有源码。

由于代码结构已经组织好了,所以编译 Log4Qt 非常简单:

  • 使用 Qt Creator 打开 log4qt.pro
  • 执行 qmake -> 构建

成功之后,在构建目录下会生成 log4qt.lib、log4qt.dll 以及相应的示例程序。

配置 Log4Qt

要使用 Log4Qt,有两种方式:

  • 将 Log4Qt 源码添加至项目中
  • 将 Log4Qt 作为第三方库使用

将 Log4Qt 源码添加至项目中

Log4Qt-master/src/log4qt 目录中,有一个很重要的文件 - log4qt.pri,通过它可以很容易地将 Log4Qt 的源码添加至项目中。

仅需在 myProject.pro(自己的工程文件)添加如下配置:

# 定义 Log4Qt 源码路径LOG4QT_SRC_PATH = $$PWD/../Log4Qt-master/src# 定义所需的宏DEFINES += LOG4QT_LIBRARY# 指定编译项目时应该被搜索的 #include 目录INCLUDEPATH += $$LOG4QT_SRC_PATH \               $$LOG4QT_SRC_PATH/log4qt \               $$LOG4QT_SRC_PATH/log4qt/helpers \               $$LOG4QT_SRC_PATH/log4qt/spi \               $$LOG4QT_SRC_PATH/log4qt/varia# 将 Log4Qt 源代码添加至项目中include($$LOG4QT_SRC_PATH/log4qt/Log4Qt.pri)include($$LOG4QT_SRC_PATH/../build.pri)include($$LOG4QT_SRC_PATH/../g++.pri)

将 Log4Qt 作为第三方库使用

上面说过,编译 Log4Qt 后,会生成相应的库。所以如果想将其作为第三方库来使用的话,也很方便。

仅需在 myProject.pro(自己的工程文件)添加如下配置:

# 定义 Log4Qt 源码路径LOG4QT_SRC_PATH = $$PWD/../Log4Qt-master/src# 指定链接到项目中的库列表LIBS += -L$$PWD/Libs -llog4qt# 指定编译项目时应该被搜索的 #include 目录INCLUDEPATH += $$LOG4QT_SRC_PATH