• Qt扩展-Log4Qt 简介及配置


    一、概述

    日志是程序调试和溯源问题的一个必不可少的好手段,我们可以用系统的log像 QDebug库,但是为了更快的开发,我们可以用更好的工具,比如说,Log4Qt是基于Qt写的一个日志库。也是使用Qt框架的Apache Software Foundation Log4j包的c++移植版。它的目的是供开源和商业Qt项目使用。好像有Qt4 和Qt5的版本。我用的是Qt5的版本。

    项目的地址:https://github.com/MEONMedical/Log4Qt

    版本要求

    • 最低Qt版本要求Qt5.12(为了支持Qt版本降至5.3,请使用分支1.4或最新的1.4)。如果要支持Qt 5.7以下的版本,请使用分支1.5或最新的1.5。x版本)
    • 需要c++ 11特性(最低编译器版本MSVC14, GCC 4.8或CLANG 3.3)

    基本功能

    • SimpleTimeLayout(“dd.MM。yyyy hh:mm[线程]级别日志消息")
    • ColorConsoleAppender(通过转义序列呈现彩色消息并将其放入控制台)
    • SignalAppender(当日志事件发生时发出信号)
    • DatabaseAppender(附加日志事件到sql表)
    • DatabaseLayout(将日志事件放入sql表列中)
    • Telnet附加程序(将日志事件附加到Telnet客户端)
    • LogStream (qDebug()样式的日志消息追加)
    • MainThreadAppender(通过事件循环发送日志消息的代理appender)
    • XMLLayout支持apache chainsaw
    • DailyFileAppender,每天生成一个日志文件(将当前日期添加到文件名中)
    • 二进制日志记录器
    • Windows调试控制台附加程序

    二、编译安装

    我使用的是库方式的引入

    1. 源码结构

    在这里插入图片描述
    我们可以看到源码的结构是这么几个部分构成的。

    • src 目录
      就是源码的目录,这个目录最后生成的目标就是动态库和静态库,到时候我们也需要把这个头文件给提出来使用
    • example 目录
      就是这个使用的例子目录,在这些例子里面就可以大致知道这个是怎么使用的

    2. 库引入

    1. 先把文件给拷贝到自己的项目里

    在这里插入图片描述
    在这里插入图片描述

    1. 在项目文件中引入库(我用的是静态库)
    INCLUDEPATH += $$PWD/include
    DEPENDPATH += $$PWD/include
    
    win32:!win32-g++: PRE_TARGETDEPS += $$PWD/lib/log4qt.dll
    else:win32-g++: PRE_TARGETDEPS += $$PWD/lib/liblog4qt.a
    
    • 1
    • 2
    • 3
    • 4
    • 5

    三、简单的使用

    我参考的一个博主的,我们实际使用的时候就是可以去修改这个 QLog4.properties 就能达到我们的目标啦

    1. 日志工具类

    QLog4.properties

    #############
    # 输出到控制台
    #############
    ###############################################################################################
    # 配置INFO CONSOLE输出到控制台
    # log4j.rootLogger日志输出类别和级别:只输出不低于该级别的日志信息DEBUG < INFO < WARN < ERROR < FATAL
    log4j.logger.all=ALL,all
    log4j.appender.all=org.apache.log4j.ConsoleAppender
    # 配置CONSOLE设置为自定义布局模式
    log4j.appender.all.layout=org.apache.log4j.PatternLayout
    # 配置CONSOLE日志的输出格式: %r耗费毫秒数 %p日志的优先级 %t线程名 %C所属类名通常为全类名 %L代码中的行号 %x线程相关联的NDC %m日志 %n换行
    log4j.appender.all.layout.ConversionPattern=[ %d ] [ %p ] [ %C %t ] [ %l ] --> %m %n
    ###############################################################################################
     
    ################
    # 输出到日志文件中
    ################
     
    ###############################################################################################
    log4j.logger.info=INFO,info
    # 配置logfile输出到文件中 文件大小到达指定尺寸的时候产生新的日志文件
    log4j.appender.info=org.apache.log4j.RollingFileAppender
    # 输出文件位置此为项目根目录下的logs文件夹中
    log4j.appender.info.File=logs/INFO.log
    #true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是false
    log4j.appender.info.appendFile=true
    # 后缀可以是KB,MB,GB达到该大小后创建新的日志文件
    log4j.appender.info.MaxFileSize=10MB
    # 设置滚定文件的最大值5
    log4j.appender.info.MaxBackupIndex=5
    # 配置logfile为自定义布局模式
    log4j.appender.info.layout=org.apache.log4j.PatternLayout
    log4j.appender.info.layout.ConversionPattern=[ %d ] [ %p ] [ %C %t ] [ %l ] --> %m %n
    ###############################################################################################
     
    ###############################################################################################
    log4j.logger.warn=WARN,warn
    # 配置logfile输出到文件中 文件大小到达指定尺寸的时候产生新的日志文件
    log4j.appender.warn=org.apache.log4j.RollingFileAppender
    # 输出文件位置此为项目根目录下的logs文件夹中
    log4j.appender.warn.File=logs/WARN.log
    #true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是false
    log4j.appender.warn.appendFile=true
    # 后缀可以是KB,MB,GB达到该大小后创建新的日志文件
    log4j.appender.warn.MaxFileSize=10MB
    # 设置滚定文件的最大值5
    log4j.appender.warn.MaxBackupIndex=5
    # 配置logfile为自定义布局模式
    log4j.appender.warn.layout=org.apache.log4j.PatternLayout
    log4j.appender.warn.layout.ConversionPattern=[ %d ] [ %p ] [ %C %t ] [ %l ] --> %m %n
    ###############################################################################################
     
    ###############################################################################################
    log4j.logger.debug=DEBUG,debug
    # 配置logfile输出到文件中 文件大小到达指定尺寸的时候产生新的日志文件
    log4j.appender.debug=org.apache.log4j.RollingFileAppender
    # 输出文件位置此为项目根目录下的logs文件夹中
    log4j.appender.debug.File=logs/DEBUG.log
    #true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是false
    log4j.appender.debug.appendFile=true
    # 后缀可以是KB,MB,GB达到该大小后创建新的日志文件
    log4j.appender.debug.MaxFileSize=10MB
    # 设置滚定文件的最大值5
    log4j.appender.debug.MaxBackupIndex=5
    # 配置logfile为自定义布局模式
    log4j.appender.debug.layout=org.apache.log4j.PatternLayout
    log4j.appender.debug.layout.ConversionPattern=[ %d ] [ %p ] [ %C %t ] [ %l ] --> %m %n
    ###############################################################################################
     
    ###############################################################################################
    log4j.logger.error=ERROR,error
    # 配置logfile输出到文件中 文件大小到达指定尺寸的时候产生新的日志文件
    log4j.appender.error=org.apache.log4j.RollingFileAppender
    # 输出文件位置此为项目根目录下的logs文件夹中
    log4j.appender.error.File=logs/ERROR.log
    #true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是false
    log4j.appender.error.appendFile=true
    # 后缀可以是KB,MB,GB达到该大小后创建新的日志文件
    log4j.appender.error.MaxFileSize=10MB
    # 设置滚定文件的最大值5
    log4j.appender.error.MaxBackupIndex=5
    # 配置logfile为自定义布局模式
    log4j.appender.error.layout=org.apache.log4j.PatternLayout
    log4j.appender.error.layout.ConversionPattern=[ %d ] [ %p ] [ %C %t ] [ %l ] --> %m %n
    ###############################################################################################
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85

    QLogHelper.h

    #ifndef QLOGHELPER_H
    #define QLOGHELPER_H
     
    #include 
    #include 
    #include 
    #include 
    #include 
    #include 
    #include 
    #include 
    
    class QLogHelper : public QObject
    {
        Q_OBJECT
    public:
        explicit QLogHelper(QObject *parent = nullptr);
        QLogHelper(QString configpath, QObject *parent = nullptr);
    
        ~QLogHelper();
        static QLogHelper *Instance();
        void Init();
        Log4Qt::Logger* GetLogInfo();
        Log4Qt::Logger* GetLogWarn();
        Log4Qt::Logger* GetLogDebug();
        Log4Qt::Logger* GetLogError();
        Log4Qt::Logger* GetLogConsole();
        void LogInfo(QString);
        void LogWarn(QString);
        void LogDebug(QString);
        void LogError(QString);
    signals:
     
    public slots:
     
    private:
        Log4Qt::Logger *logInfo=NULL;
        Log4Qt::Logger *logWarn=NULL;
        Log4Qt::Logger *logDebug=NULL;
        Log4Qt::Logger *logError=NULL;
        Log4Qt::Logger *logConsole=NULL;
        QString confFilePath=NULL;
    
        static QLogHelper *m_Instance;
    };
     
    #endif // QLOGHELPER_H
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47

    QLogHelper.cpp

    #include "QLogHelper.h"
     
    using namespace Log4Qt;
    
    QLogHelper * QLogHelper::m_Instance = nullptr;
    
    QLogHelper::QLogHelper(QObject *parent) : QObject(parent)
    {
        if(confFilePath.isEmpty()){confFilePath=QApplication::applicationDirPath()+"/config/QLog4.properties";}
        this->Init();
        m_Instance = this;
    }
    
    QLogHelper::QLogHelper(QString configpath, QObject *parent)
    {
        confFilePath = configpath;
        if(confFilePath.isEmpty()){confFilePath=QApplication::applicationDirPath()+"/config/QLog4.properties";}
        this->Init();
    
        m_Instance = this;
    }
    QLogHelper::~QLogHelper(){
    }
    
    QLogHelper *QLogHelper::Instance(){
        if(m_Instance == nullptr){
            m_Instance = new QLogHelper();
        }
        return m_Instance;
    }
    void QLogHelper::Init(){
        //判断文件是否存在
        QFileInfo configFile(this->confFilePath);
        if(!this->confFilePath.isEmpty()&&configFile.exists()){
            PropertyConfigurator::configure(this->confFilePath);
            //实例化节点对象
            if(logInfo==NULL){ logInfo = Log4Qt::Logger::logger("info");}
            if(logWarn==NULL){ logWarn = Log4Qt::Logger::logger("warn");}
            if(logDebug==NULL){ logDebug = Log4Qt::Logger::logger("debug");}
            if(logError==NULL){ logError = Log4Qt::Logger::logger("error");}
            if(logConsole==NULL){ logConsole = Log4Qt::Logger::logger("all");}
        }
    }
    /**
     * @brief QLogHelper::GetLogInfo
     * @return
     */
    Logger* QLogHelper::GetLogInfo(){
        return this->logInfo;
    }
    /**
     * @brief QLogHelper::GetLogWarn
     * @return
     */
    Logger* QLogHelper::GetLogWarn(){
        return this->logWarn;
    }
    /**
     * @brief QLogHelper::GetLogDebug
     * @return
     */
    Logger* QLogHelper::GetLogDebug(){
        return this->logDebug;
    }
    /**
     * @brief QLogHelper::GetLogError
     * @return
     */
    Logger* QLogHelper::GetLogError(){
        return this->logError;
    }
    /**
     * @brief QLogHelper::GetLogConsole
     * @return
     */
    Logger* QLogHelper::GetLogConsole(){
        return this->logConsole;
    }
    /**
     * @brief QLogHelper::LogInfo
     * @param txt
     */
    void QLogHelper::LogInfo(QString txt){
        this->logConsole->info(txt);
        this->logInfo->info(txt);
    }
    /**
     * @brief QLogHelper::LogWarn
     * @param txt
     */
    void QLogHelper::LogWarn(QString txt){
        this->logConsole->warn(txt);
        this->logWarn->warn(txt);
    }
    /**
     * @brief QLogHelper::LogDebug
     * @param txt
     */
    void QLogHelper::LogDebug(QString txt){
        this->logConsole->debug(txt);
        this->logDebug->debug(txt);
    }
    /**
     * @brief QLogHelper::LogError
     * @param txt
     */
    void QLogHelper::LogError(QString txt){
        this->logConsole->error(txt);
        this->logError->error(txt);
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90
    • 91
    • 92
    • 93
    • 94
    • 95
    • 96
    • 97
    • 98
    • 99
    • 100
    • 101
    • 102
    • 103
    • 104
    • 105
    • 106
    • 107
    • 108
    • 109
    • 110

    2. 使用工具类

    #include "MainWindow.h"
    
    #include 
    #include 
    
    int main(int argc, char *argv[])
    {
        QApplication a(argc, argv);
        //日志系统初始化
        QLogHelper *p=  new QLogHelper(a.applicationDirPath() + "/configs/QLog4.properties");
        p->LogInfo("Logger Init Successful!");
    
        MainWindow w;
        w.show();
        return a.exec();
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16

    在这里插入图片描述

  • 相关阅读:
    【JAVA程序设计】(C00087)基于Servlet+jsp的学生成绩管理系统
    【Linux】/proc/stat解析
    三维模型3DTile格式轻量化压缩的遇到常见问题与处理方法分析
    vim-操作
    2024042期传足14场胜负前瞻
    教你六步拆解 DDD领域驱动设计落地实践
    线性表之栈和队列(数据结构)(VS)(C语言)(stack and Queue)
    Metis安装(5.0.1与4.0.3)
    1015: 【C1】【循环】【for】整数序列的元素最大跨度值
    c++中的cin和getline()函数
  • 原文地址:https://blog.csdn.net/qq_43680827/article/details/133751738