Qt重定向QDebug，自定义一个简易的日志管理类

电玩女神 2022-11-27 15:39 241阅读 0赞

# 0.前言 #

相对于第三方的日志库，在 Qt 中使用 QDebug 打印更便捷，有时候也需要对 QDebug 输出进行重定向，如写入文件等。

在 Qt4 中使用 qInstallMsgHandler 函数设置重定向的函数指针：

typedef void (*QtMsgHandler)(QtMsgType, const char *);
    Q_CORE_EXPORT QT_DEPRECATED QtMsgHandler qInstallMsgHandler(QtMsgHandler);

在 Qt5 中应该使用 qInstallMessageHandler 来注册函数指针：

typedef void (*QtMessageHandler)(QtMsgType, const QMessageLogContext &, const QString &);
    Q_CORE_EXPORT QtMessageHandler qInstallMessageHandler(QtMessageHandler);

返回的函数指针我们可以保存起来，需要输出到控制台时进行调用。

# 1.最简单的操作 #

一个最简单的示例如下，重定向到文件：

#include <QApplication>
    #include <QMutex>
    #include <QMutexLocker>
    #include <QFile>
    #include <QTextStream>
    #include <QDebug>
    
    //重定向qdebug输出到文件
    void myMessageHandle(QtMsgType , const QMessageLogContext& , const QString& msg)
    {
        static QMutex mut; //多线程打印时需要加锁
        QMutexLocker locker(&mut);
        QFile file("log.txt");
        if(file.open(QIODevice::WriteOnly|QIODevice::Append))
        {
            QTextStream stream(&file);
            stream<<msg<<endl;
            file.close();
        }
    }
    
    int main()
    {
        //设置重定向操作的函数
        qInstallMessageHandler(myMessageHandle);
    
        qDebug()<<"Test debug111";
        qDebug()<<"Test debug222";
    
        return 0;
    }

运行结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70][]

# 2.实现一个简易的日志管理类 #

需求很简单，同时输出到界面中的编辑框、文件、控制台。

代码链接：[https://github.com/gongjianbo/SimpleQtLogger][https_github.com_gongjianbo_SimpleQtLogger]

运行效果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 3][]

输出到控制台，我是保存了调用 qInstallMessageHandler 时返回的函数指针，然后调用进行默认的输出。

输出到文件，因为函数调用发生在 qDebug() 调用的线程，所以需要加锁。

输出到界面，我使用了信号槽的方式，将文本发送给 connect 的槽。

当然，还可以添加一些细节，如日志等级的控制等。

下面是部分源码：

#include <QApplication>
    
    #include "LogManager.h"
    #include "mainwindow.h"
    
    int main(int argc, char *argv[])
    {
        LogManager::getInstance()->initManager();//初始化
    
        QApplication a(argc, argv);
    
        MainWindow w;
        w.show();
    
        return a.exec();
    }

#ifndef LOGMANAGER_H
    #define LOGMANAGER_H
    
    #include <QObject>
    #include <QFile>
    #include <QMutex>
    #include <QElapsedTimer>
    #include <QDebug>
    
    /**
     * @brief 简易的日志管理类，作为单例
     * @details
     * 初始化时调用initManager重定向
     * @note
     * 改为手动调用initManager是为了便于流程控制
     * 此外，也可以手动调用freeManager
     */
    class LogManager : public QObject
    {
        Q_OBJECT
        LogManager();
    public:
        ~LogManager();
    
        //获取单例实例
        static LogManager *getInstance();
        //重定向qdebug输出
        void outputLog(QtMsgType type, const QMessageLogContext& context, const QString& msg);
        //初始化，如重定向等
        void initManager(const QString &path=QString());
        //释放
        void freeManager();
    
    signals:
        //可以关联信号接收日志信息，如显示到ui中
        //注意，如果槽函数为lambda或者其他没有接收者的情况，需要保证槽函数中的变量有效性
        //因为static变量的生命周期更长，可能槽函数所在模块已经释放资源，最好connect加上接收者
        void newLog(int msgType, const QString &log);
    
    private:
        //保留默认handle，用于输出到控制台
        QtMessageHandler defaultOutput = nullptr;
        //输出到文件
        QFile file;
        //输出路径
        QString filePath;
        //多线程操作时需要加锁
        QMutex logMutex;
        //计算操作间隔，分时生成文件
        QElapsedTimer elapsedTimer;
    };
    
    #endif // LOGMANAGER_H

#include "LogManager.h"
    
    #include <QApplication>
    #include <QDir>
    #include <QThread>
    #include <QTextStream>
    #include <QDateTime>
    
    //重定向qdebug输出
    void outputLogMessage(QtMsgType type, const QMessageLogContext& context, const QString& msg)
    {
        //转发给单例的成员函数
        LogManager::getInstance()->outputLog(type,context,msg);
    }
    
    LogManager::LogManager()
    {
        //initManager();
    }
    
    LogManager::~LogManager()
    {
        freeManager();
    }
    
    LogManager *LogManager::getInstance()
    {
        //单例，c++ 11
        static LogManager instance;
        return &instance;
    }
    
    void LogManager::outputLog(QtMsgType type, const QMessageLogContext &context, const QString &msg)
    {
        //如果要写文件需要加锁，因为函数调用在debug调用线程
        QMutexLocker locker(&logMutex);
        QString out_text;
        QTextStream stream(&out_text);
        //区分日志类型给文本加头
        switch (type) {
        case QtDebugMsg: stream<<"[Debug]"; break;
        case QtInfoMsg: stream<<"[Info]"; break;
        case QtWarningMsg: stream<<"[Warning]"; break;
        case QtCriticalMsg: stream<<"[Critical]"; break;
        case QtFatalMsg: stream<<"[Fatal]"; break;
        default: stream<<"[Unknown]"; break;
        }
    
        //加个线程id用于测试
        stream<<QDateTime::currentDateTime().toString("[yyyy-MM-dd hh:mm:ss]")
                <<msg
             <<QThread::currentThreadId();
    
        //写入文件
        if(file.isOpen()){
            //elapsed距离start的毫秒数
            //这里设置1分钟用来测试
            if(elapsedTimer.elapsed()>1000*60){
                file.close();
                //重新计时
                elapsedTimer.restart();
            }
        }
        if(!file.isOpen()){
            //新的文件
            file.setFileName(filePath+QString("/log_%1.txt")
                             .arg(QDateTime::currentDateTime().toString("yyyyMMdd_hhmm")));
            //Append追加模式，避免同一文件被清除
            if(!file.open(QIODevice::WriteOnly|QIODevice::Append)){
                emit newLog(QtWarningMsg,"Open log file error:"+file.errorString()+file.fileName());
            }
        }
        if(file.isOpen()){
            //写入文件
            stream.setDevice(&file);
            stream<<out_text<<endl;
        }
    
        //发送信号给需要的对象，如ui上显示日志
        emit newLog(type, msg);
    
        //默认的输出，控制台
        //区分日志类型给文本加颜色
        //常见格式为：\e[显示方式;前景色;背景色m输出字符串\e[0m
        //其中\e=\033
        QString cmd_text;
        stream.setString(&cmd_text);
        switch (type) {
        //debug绿色
        case QtDebugMsg: stream<<"\033[32m"; break;
            //info蓝色
        case QtInfoMsg: stream<<"\033[34m"; break;
            //warning黄色
        case QtWarningMsg: stream<<"\033[33m"; break;
            //critical黑底白字
        case QtCriticalMsg: stream<<"\033[0;37;40m"; break;
            //fatal黑底红字
            //qFatal表示致命错误，默认处理会报异常的
        case QtFatalMsg: stream<<"\033[0;31;40m"; break;
            //defualt默认颜色
        default: stream<<"\033[0m"; break;
        }
        stream<<out_text<<"\033[0m";
        defaultOutput(type,context,cmd_text);
    }
    
    void LogManager::initManager(const QString &path)
    {
        //保存路径
        filePath=path;
        if(filePath.isEmpty())
        {
            //用到了QApplication::applicationDirPath()，需要先实例化一个app
            int argc=0;
            QApplication app(argc,nullptr);
            filePath=app.applicationDirPath()+"/log";
        }
        QDir dir(filePath);
        if(!dir.exists())
        {
            //虽然QFile能够创建不存在的文件，但是它就是不会自动创建不存在的目录
            dir.mkpath(filePath);
        }
        elapsedTimer.start();
        //重定向qdebug到自定义函数
        defaultOutput=qInstallMessageHandler(outputLogMessage);
    }
    
    void LogManager::freeManager()
    {
        file.close();
        qInstallMessageHandler(nullptr);
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70]: /images/20221124/778bd8cc1f56476f8c6e6ffbece7688e.png
[https_github.com_gongjianbo_SimpleQtLogger]: https://github.com/gongjianbo/SimpleQtLogger
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 1]: /images/20221124/3d628c56f9a942c7bccecb8af57c2650.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 2]: /images/20221124/a378d4800b5e4cac87e6859e351701d6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dvbmdqaWFuYm8xOTky_size_16_color_FFFFFF_t_70 3]: /images/20221124/571e73e36ed4455ea1b7f33bf0522f9a.png