• Qt的简易日志库实现及封装

    用于QT的一个简易日志功能模块封装。算不上强大和多高的性能，但是足够简单小巧。用于记录日志到文件够用了。单独的一个文件模块，使用时直接引入源码。想要其他功能，直接改代码即可。

    C++的下的日志库有很多，如log4cpp、Easylogging++，eplog,g3log,Qt下也有log4qt。

    还有简单小巧的QsLog，它是一个基于Qt的轻量级开源日志库。

    QsLog的git地址：https://github.com/victronenergy/QsLog

    log4qt的git地址：https://github.com/devbean/log4qt

    如果这些都不想用，还想更简单小巧的，可以看以下这个简易模块封装。

    查看日志推荐用baretailpro工具。

     使用方法

    使用时只需工程文件.pro中包含模块源码即可。 

    include(Logger/MessageLogger.pri)
    C++开发工具之-QT浅谈 QT集成开发环境 QT IDE
    docx 5星 超过95%的资源 20KB
    下载

    MessageLogger.pri文件内容：

    1. HEADERS  += $$PWD/MessageLogger.h
    2. SOURCES += $$PWD/MessageLogger.cpp
    3.  
    4. INCLUDEPATH += $$PWD

    简易封装 

    1. #ifndef MESSAGELOGGER_H
    2. #define MESSAGELOGGER_H
    3.  
    4. /** @description 用于Qt项目的一个简单的日志库，将日志存入日志文件（文本文件）中。
    5.  *   典型用法示例：
    6.  *   第一个 FileLogger 将日志输出到 stderr 上。
    7.  *   第二个 FileLogger 将日志输出到文件。
    8.  *   建议将这段代码放到 main 函数的开头处，但是要在 QCoreApplication 或 QApplication 之后。
    9.  *     LoggerController logger;
    10.  *     logger.attach(new FileLogger("stderr",
    11.  *                               FileLogger::E_DEBUG |
    12.  *                               FileLogger::E_INFO |
    13.  *                               FileLogger::E_WARNING |
    14.  *                               FileLogger::E_CRITICAL |
    15.  *                               FileLogger::E_FATAL));
    16.  *  logger.attach(new FileLogger("d:/log2.txt"));
    17.  *  logger.startLogging();
    18. */
    19.  
    20. #include 
    21. #include 
    22. #include 
    23. #include 
    24. #include 
    25. #include 
    26.  
    27. class FileLogger
    28. {
    29. public:
    30.     enum LEVEL{E_DEBUG = 1, E_INFO = 2, E_WARNING = 4, E_CRITICAL = 8, E_FATAL = 16};
    31.     FileLogger(QString name, LEVEL level);
    32.     FileLogger(QString name = "stderr", bool debug=false, bool info=true, bool warning=true, bool critical=true, bool fatal=true);
    33.     virtual ~FileLogger();
    34.     /**
    35.      * @brief setFileName 设置日志存储的文件名
    36.      * @param name 日志存储的文件名，如果为 "stderr" 则输出到 stderr
    37.      * @return
    38.      */
    39.     bool setFileName(QString name = "stderr");
    40.     /**
    41.      * @brief setLogLevel 设置哪些级别的信息要输出到文件
    42.      * @param level 可以为 E_DEBUG、E_INFO、E_WARNING、E_CRITICAL、E_FATAL 或者这些项的组合（bit or）
    43.      *              没有设置的 level 则不输出日志
    44.      */
    45.     void setLogLevel(LEVEL level);
    46.     /**
    47.      * @brief setLogLevel 设置哪些级别的信息要输出到文件
    48.      * @param debug  true 表示 qDebug 信息输出到日志
    49.      * @param info   true 表示 qInfo 信息输出到日志
    50.      * @param warning  true 表示 qWarning 信息输出到日志
    51.      * @param critical true 表示 qCritical 信息输出到日志
    52.      * @param fatal    true 表示 qFatal 信息输出到日志
    53.      */
    54.     void setLogLevel(bool debug = false, bool info = true, bool warning = true, bool critical= true, bool fatal = true);
    55.     virtual void writeLog(QtMsgType type, const QMessageLogContext &context, const QString &msg);
    56. private:
    57.     QString messageType(QtMsgType type);
    58.     FileLogger(FileLogger &f) {Q_UNUSED(f);} // 不能被拷贝
    59.     FileLogger& operator=( FileLogger &f) {Q_UNUSED(f);} // 不能被拷贝
    60. private:
    61.     QFile m_file;
    62.     QMapbool> m_level;
    63.     bool m_where;
    64. };
    65.  
    66. class LoggerController
    67. {
    68. public:
    69.     LoggerController(){}
    70.     ~LoggerController();
    71.     /**
    72.      * @brief startLogging 启动日志系统，在这之后所有的调试信息发送到对应的 FileLogger
    73.      */
    74.     void startLogging();
    75.     /**
    76.      * @brief attach 在日志系统中注册一个新的 FileLogger
    77.      * @param m_currentLogger
    78.      */
    79.     void attach(FileLogger *m_currentLogger);
    80.     void detach(FileLogger *m_currentLogger);
    81. private:
    82.     static void writeLog(QtMsgType type, const QMessageLogContext &context, const QString &msg);
    83.     static LoggerController * m_currentLogger;
    84.     QList m_list;
    85. };
    86.  
    87. #endif // MESSAGELOGGER_H
    1. #include "MessageLogger.h"
    2. #include 
    3. #include 
    4.  
    5. FileLogger::FileLogger(QString name, bool debug, bool info, bool warning, bool critical, bool fatal)
    6.     :m_where(true)
    7. {
    8.     setFileName(name);
    9.     setLogLevel(debug, info, warning, critical, fatal);
    10. }
    11.  
    12. FileLogger::FileLogger(QString name, LEVEL level)
    13. :m_where(false)
    14. {
    15.     setFileName(name);
    16.     setLogLevel(level);
    17. }
    18.  
    19. FileLogger::~FileLogger()
    20. {
    21.     m_file.close();
    22. }
    23.  
    24. bool FileLogger::setFileName(QString name)
    25. {
    26.     m_file.close();
    27.     if(name == "stderr")
    28.     {
    29.         return m_file.open(stderr, QIODevice::WriteOnly);
    30.     }
    31.     else
    32.     {
    33.         m_file.setFileName(name);
    34.         return m_file.open(QIODevice::WriteOnly | QIODevice::Append | QIODevice::Text);
    35.     }
    36. }
    37.  
    38. void FileLogger::setLogLevel(LEVEL level)
    39. {
    40.     m_level[QtDebugMsg] = static_cast<bool> (level & E_DEBUG);
    41.     m_level[QtInfoMsg] = static_cast<bool> (level & E_INFO);
    42.     m_level[QtWarningMsg] = static_cast<bool> (level & E_WARNING);
    43.     m_level[QtCriticalMsg] = static_cast<bool> (level & E_CRITICAL);
    44.     m_level[QtFatalMsg] = static_cast<bool> (level & E_FATAL);
    45. }
    46.  
    47. void FileLogger::setLogLevel(bool debug, bool info, bool warning, bool critical, bool fatal)
    48. {
    49.     m_level[QtDebugMsg] = debug;
    50.     m_level[QtInfoMsg] = info;
    51.     m_level[QtWarningMsg] = warning;
    52.     m_level[QtCriticalMsg] = critical;
    53.     m_level[QtFatalMsg] = fatal;
    54. }
    55.  
    56. void FileLogger::writeLog(QtMsgType type, const QMessageLogContext &context, const QString &msg)
    57. {
    58.     if(!m_level[type])
    59.     {
    60.         return;
    61.     }
    62.     QString strTime = QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss");
    63.     QTextStream logfile(&m_file);
    64.  
    65.     logfile << strTime << ", ";
    66.     logfile << messageType(type) << ", ";
    67.     logfile << msg;
    68.     if(context.file && m_where)
    69.     {
    70.         logfile <<  ", (" << context.file << ":" << context.line << ", " << context.function << ")\n";
    71.     }
    72.     else
    73.     {
    74.         logfile << endl;
    75.     }
    76.  
    77.     if(type == QtFatalMsg)
    78.     {
    79.         abort();
    80.     }
    81. }
    82.  
    83. QString FileLogger::messageType(QtMsgType type)
    84. {
    85.     QString str;
    86.     switch (type)
    87.     {
    88.     case QtDebugMsg:
    89.         str = "[D]";
    90.         break;
    91.     case QtInfoMsg:
    92.         str = "[I]";
    93.         break;
    94.     case QtWarningMsg:
    95.         str = "[W]";
    96.         break;
    97.     case QtCriticalMsg:
    98.         str = "[C]";
    99.         break;
    100.     case QtFatalMsg:
    101.         str = "[F]";
    102.     }
    103.     return str;
    104. }
    105.  
    106. void LoggerController::attach(FileLogger *logger)
    107. {
    108.     m_list.append(logger);
    109. }
    110.  
    111. void LoggerController::detach(FileLogger *logger)
    112. {
    113.     if(logger)
    114.     {
    115.         m_list.removeOne(logger);
    116.         delete logger;
    117.     }
    118. }
    119.  
    120. void LoggerController::startLogging()
    121. {
    122.     m_currentLogger = this;
    123.     qInstallMessageHandler(LoggerController::writeLog);
    124. }
    125.  
    126. LoggerController::~LoggerController()
    127. {
    128.     qDeleteAll(m_list);
    129. }
    130. LoggerController* LoggerController::m_currentLogger = nullptr;
    131.  
    132. void LoggerController::writeLog(QtMsgType type, const QMessageLogContext &context, const QString &msg)
    133. {
    134.     if( m_currentLogger )
    135.     {
    136.         QList &list = m_currentLogger->m_list;
    137.  
    138.         QList::const_iterator i;
    139.         for (i = list.cbegin(); i != list.cend(); ++i)
    140.         {
    141.             (*i)->writeLog(type, context, msg);
    142.         }
    143.     }
    144.  
    145. }

    简单使用

    1. #include "mainwindow.h"
    2.  
    3. #include 
    4.  
    5. #include 
    6. #include 
    7. #include 
    8. #include 
    9. #include 
    10. #include "cglobal.h"
    11. #include "MessageLogger.h"
    12. #include "utils.h"
    13.  
    14. int main(int argc, char *argv[])
    15. {
    16.      //自适应高分辨率（DPI）,不确定是否管用
    17.      #if (QT_VERSION >= QT_VERSION_CHECK(5,9,0))
    18.          QApplication::setAttribute(Qt::AA_UseHighDpiPixmaps);
    19.          QApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
    20.      #endif
    21.     QApplication a(argc, argv);
    22.     a.setFont(QFont("Microsoft Yahei", 9));//设置应用程序字体
    23.     a.setWindowIcon(QIcon(":/main.ico"));//设置应用程序图标
    24.  
    25.     mkDirIfNotExist();
    26.  
    27.     //打印日志到文件中
    28.     LoggerController logger;
    29.     logger.attach(new FileLogger("stderr",
    30.                                FileLogger::E_DEBUG,
    31.                                FileLogger::E_INFO ,
    32.                                FileLogger::E_WARNING ,
    33.                                FileLogger::E_CRITICAL,
    34.                                FileLogger::E_FATAL));
    35.     QString dateTime = QDateTime::currentDateTime().toString("yyyy-MM-dd_hhmmss");
    36.     QString logName = LOG_PATH+dateTime+"_log.txt";
    37.     //日志文件输入以下级别的日志
    38.     FileLogger::LEVEL level =  (FileLogger::LEVEL)(FileLogger::E_INFO | FileLogger::E_WARNING);
    39.     FileLogger *lg = new FileLogger(logName,level);
    40.     logger.attach(lg);
    41.     logger.startLogging();
    42.     qInfo("程序启动...");
    43.     qInfo(APP_VERION);
    44.  
    45.  
    46.     MainWindow w;
    47.     w.show();
    48.     return a.exec();
    49. }
    50.  
    51. void mkDirIfNotExist(){
    52.     QDir *folder = new QDir;
    53.     bool exist,ok = false;
    54.     exist = folder->exists(LOG_PATH);
    55.     if(!exist){
    56.         ok = folder->mkdir(LOG_PATH);
    57.         if(!ok){
    58.             qDebug("Error,创建日志文件夹失败");
    59.         }
    60.     }
    61.     exist = folder->exists(PIC_PATH);
    62.     if(!exist){
    63.         ok = folder->mkdir(PIC_PATH);
    64.         if(!ok){
    65.             qDebug("Error,创建图片文件夹失败");
    66.         }
    67.     }
    68. }

    引用

    QT 轻量级的LOG日志库_Duffy_Gallagher的博客-CSDN博客_qt日志库

    Qt轻量级日志库QsLog的使用_百里杨的博客-CSDN博客_qt 日志库

  • 相关阅读:
    Java-类和对象
    【Unity】LayoutGroup自动缩放子对象大小
    RabbitMQ（六）仲裁队列、流式队列、异地容灾（联邦队列Federation Queue）
    线上答题活动小程序结合线下大屏复盘总结
    Mybatis实战练习四【单个条件（动态SQL）&添加数据】
    申请400电话的详细步骤及操作指南
    CSP2023 游记
    从零开始：使用ChatGPT快速创作引人入胜的博客内容
    C#解决MDI窗体闪屏的方法
    Docker Machine简介
  • 原文地址：https://blog.csdn.net/qq8864/article/details/126216603