Qt教程 : 自定义日志系统

Posted QtHalcon

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Qt教程 : 自定义日志系统相关的知识，希望对你有一定的参考价值。

    日志系统可以记录软件系统中硬件、软件和系统问题的信息，同时还可以监视系统中发生的事件和异常。在程序调试过程中，需要通过日志来找出问题所在。

    使用一个好的日志框架可以事半功倍，C++的日志框架有很多，常用的框架如下：

  • log4cxx：Java 社区著名的 Log4j 的 C++ 移植版，用于为 C++ 程序提供日志功能，以便开发者对目标程序进行调试和审计。

  • log4cplus：一个简单易用的 C++ 日志记录 API，它提供了对日志管理和配置的线程安全、灵活和任意粒度控制（也基于 Log4j）。

  • Log4cpp：一个 C++ 类库，可以灵活地记录到文件、syslog、IDSA 和其他目的地（也基于 Log4j）。

  • google-glog：一个 C++ 语言的应用级日志记录框架，提供了 C++ 风格的流操作和各种辅助宏。

  • Pantheios：一个类型安全、高效、泛型和可扩展性的 C++ 日志 API 库（号称 C++ 领域速度最快的日志库）。

  • POCO：还提供了一个 好的日志支持文档。

  • ACE：ACE 也有日志支持。

  • Boost.Log：设计的非常模块化，并且可扩展。

  • Easylogging++：轻量级高性能 C++ 日志库（只有一个头文件）。

  • G3log：一个开源、支持跨平台的异步 C++ 日志框架，支持自定义日志格式。基于 g2log 构建，提升了性能，支持自定义格式。

  • Plog：可移植、简单和可扩展的 C++ 日志库。

  • spdlog：一个快速的 C++ 日志库，只包含头文件，兼容 C++11。

    本文使用Log4Qt，而Log4Qt来自于Log4j，下载网址如下：

    https://github.com/MEONMedical/Log4Qt

    图像的特征描述了图像的某种属性，当通过分割、形态学处理得到一些区域后，这些区域就构成了一个集合。 常用的特征类型有边缘、角、区域和脊背。

一、Log4Qt架构

Log4Qt有三个部分：

  • loggers：负责捕获日志信息。

  • appenders：负责输出信息到不同的目的地，比如数据库，文件，控制台等等。

  • layouts：负责使用不同的样式输出日志

Log4Qt框架中有两种对象：

  • 核心对象：框架的支撑对象，是框架必不可少的组成部分。

  • 支撑对象：这些都是框架可选的对象，用于提供额外重要的工作。

Log4Qt的架构图如下所示：

  • Level对象:级别对象定义日志的粒度和优先级。

  • 过滤器对象：用于分析日志信息并决定日志信息是否输出。每个appender对象可以有几个过滤器对象协同工作，当日志信息到达特定的appender时，所有的过滤器会帮助appender在其发布到目的地之前进行过滤操作。

  • 对象渲染器：提供一段字符用于识别发送日志的不同对象，这个对象也用于layout对象准备常量信息。

  • 日志管理器：用于管理日志框架，它负责从初始化配置中读取信息，这个配置可能是文件配置，也可能是类的配置。

二、Log4Qt规则

    2.1 日志的级别

    日志级别如下：

  • ALL：所有日志的级别都包括。

  • DEBUG：指定的信息事件的粒度是DEBUG，在调试应用的时候会有帮助。

  • ERROR：指定错误事件，并且这些事件还会保证应用继续运行。

  • FATAL：指定严重的错误事件，该事件会导致应用暂停。

  • INFO：指定信息消息，强调应用粗粒度的运行情况。

  • OFF：最高等级，相当于关闭了日志。

  • TRACE：指定比DEBUG更粗粒度的调试日志。

  • WARN：输出具有潜在风险的信息。

    日志标准的排序是：

    ALL<DEBUG<INFO<WARN<ERROR<FATAL<OFF


    2.2 日志字符格式化

    日志消息的格式，通过转换说明符来表示，以百分号（%）开始，后跟转换字符。如下实例：

log4j.appender.daily.layout.ConversionPattern=%d{yyyy-MM-dd(HH:mm:ss)} %p:%m%n

  • -X号: X信息输出时左对齐；

  • %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,

  • %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

  • %r: 输出自应用启动到输出该log信息耗费的毫秒数

  • %c: 输出日志信息所属的类目，通常就是所在类的全名

  • %t: 输出产生该日志事件的线程名

  • %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main (TestLog4.java:10)

  • %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

  • %%: 输出一个"%"字符

  • %F: 输出日志消息产生时所在的文件名称

  • %L: 输出代码中的行号

  • %m: 输出代码中指定的消息,产生的日志具体信息

  • %n: 输出一个回车换行符，Windows平台为"\r\n"，Unix平台为"\n"输出日志信息换行

    如果想生成基于模式的特定格式的日志信息，那么可以使用 PatternLayout 来进行格式化。


    2.3 Layout

    Log4Qt提供了多种Layout对象，用于格式化日志输出，指定日志级别、线程名称、Logger名称、日期时间等信息。Log4Qt::Layout 继承关系图：

Qt教程(1) : 自定义日志系统

  • Layout类是Log4Qt API中的抽象类。

  • PatternLayout：根据一个模式字符串输出日志事件；

  • SimpleLayout：输出日志事件的级别和消息；

  • TTCCLayout：输出日志事件的时间、线程名称、Logger名称和嵌套的诊断上下文信息。

  • PatternLayout和TTCCLayout：通过PatternFormatter来实现格式化。当PatternFormatter解析模式字符串时，会根据发现的信息创建一个PatternConverter链，每个PatternConverter会处理LoggingEvent的某个成员。

    2.4 配置文件

    Log4qt可以通过配置文件来设置相应的参数，常用的基本配置如下：

#设置储存log文件的根目录logpath=./log
log4j.reset=truelog4j.Debug=WARNlog4j.threshold=NULL#设置是否监听QDebug输出的字符串log4j.handleQtMessages=true#在运行中，是否监视此文件配置的变化log4j.watchThisFile=false
#设置根Logger的输出log等级为All#设置Log输出的几种输出源（appender）：console, daily#log4j.rootLogger=ALL, console, dailylog4j.rootLogger=ALL, daily
#设置终端打印记录器log4j.appender.console=org.apache.log4j.ConsoleAppenderlog4j.appender.console.target=STDOUT_TARGETlog4j.appender.console.layout=org.apache.log4j.PatternLayoutlog4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd(HH:mm:ss)} %p:%m%n
#设置一个每日储存一个log文件的记录器log4j.appender.daily=org.apache.log4j.DailyFileAppenderlog4j.appender.daily.file=${logpath}/.loglog4j.appender.daily.appendFile=truelog4j.appender.daily.datePattern=yyyy-MM-ddlog4j.appender.daily.keepDays=30log4j.appender.daily.layout=org.apache.log4j.PatternLayoutlog4j.appender.daily.layout.ConversionPattern=%d{yyyy-MM-dd(HH:mm:ss)} %p:%m%n
# 给“LoggerObjectPrio”这个类的Logger定义log输出等级为Error，# 给“LoggerObjectPrio”这个类的Logger定义log输出源：daily, consolelog4j.logger.LoggerObjectPrio=ERROR, daily, console#设置为false，表示“LoggerObjectPrio”这个类的logger不继承的rootLogger输出源（appender）log4j.additivity.LoggerObjectPrio=false

    配置文件调用方式：

//配置文件路径 Log4Qt::PropertyConfigurator::configure(a.applicationDirPath()  + "/log4qt.conf");

三、使用Log4Qt

    3.1 生成log4qt库

    源码下载后，直接打开工程文件编译即可，

Qt教程(1) : 自定义日志系统


    3.2 将log4qt源码融入自己的项目中

    在工程文件中添加以下配置：

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


    3.3 简单使用实例

#include "logger.h"#include "basicconfigurator.h" Log4Qt::BasicConfigurator::configure();Log4Qt::Logger * log = Log4Qt::Logger::rootLogger();log->debug("debug!");log->info("information!");log->warn("warn");

四、重定向到窗口

    4.1 继承QTextEdit

class JLogWin : public QTextEdit{ Q_OBJECT
public: explicit JLogWin(QWidget *parent = nullptr); ~JLogWin();
private slots: void AppendLog_Slot(int level, const QString& log);
private: QMutex Log_Mutex;};
JLogWin::JLogWin(QWidget *parent) : QTextEdit(parent){ moveCursor(QTextCursor::End); document()->setMaximumBlockCount(100);}
JLogWin::~JLogWin(){
}
void JLogWin::AppendLog_Slot(int level, const QString &log){ QMutexLocker lock(&Log_Mutex); if (level == 96) { setTextColor(QColor(0x0000ff)); }else if (level == 128) { setTextColor(QColor(0x00aa00)); }else{ setTextColor(QColor(0xff0000)); } this->append(log);}


    4.2 继承Log4Qt::AppenderSkeleton

class JLogWinAppender : public Log4Qt::AppenderSkeleton{ Q_OBJECT
public: JLogWinAppender(QObject *parent = NULL); ~JLogWinAppender();
 //设置日志信息输出的QWidget组件 void Set_LogWidget(QWidget *P_Widget);
protected: virtual bool requiresLayout() const; virtual void append(const Log4Qt::LoggingEvent &rEvent);
signals: //新增加一条日志信息的信号 void AppendLog_Signal(int level, const QString& msg);
private: QWidget *P_LogWidget;};JLogWinAppender::JLogWinAppender(QObject *parent): AppenderSkeleton(parent){ P_LogWidget = nullptr;}
JLogWinAppender::~JLogWinAppender(){}
void JLogWinAppender::Set_LogWidget(QWidget *P_Widget){ P_LogWidget = const_cast<QWidget*>(P_Widget); connect(this, SIGNAL(AppendLog_Signal(int, const QString&)), P_LogWidget, SLOT(AppendLog_Slot(int, const QString&)));}
bool JLogWinAppender::requiresLayout() const{ return true;}


    4.3 实现效果

    窗口效果如下：

Qt教程(1) : 自定义日志系统

    日志文件效果如下：

Qt教程(1) : 自定义日志系统

        测试全部源码放到了CSDN上面，有需要可以下载：

https://download.csdn.net/download/qq_40732350/19000039



Qt教程(1) : 自定义日志系统




扫描二维码

获取更多精彩

QtHalcon

CSDN博客：

https://blog.csdn.net/qq_40732350


觉得不错，请点个赞


以上是关于Qt教程 : 自定义日志系统的主要内容，如果未能解决你的问题，请参考以下文章

Qt自定义控件之日志控件

Python3自定义日志类教程

Qt入门系列开发教程QSSqss的实例

qt creator源码全方面分析(2-0)

找到我的自定义代码片段 Xcode 6？

Qt教程4-使用用户自定义的窗口部件