天天看點

Qt日志重定向qInstallMessageHandler,輸出Log至檔案及網絡

Qt有Debug、Warning、Info、Critical、Fatal五種級别的調試資訊。

qDebug:調試資訊

qWarning:警告資訊

qInfo:警告資訊

qCritical:嚴重錯誤

qFatal:緻命錯誤

Qt4提供了qInstallMsgHandler(Qt5:qInstallMessageHandler)對qDebug、qWarning、qCritical、qFatal等函數輸出資訊的重定向處理。

qInstallMsgHandler是一個回調函數,由qDebug、qWarnng、qCritical、qFatal函數進行觸發,qDebug、qWarnng、qCritical、qFatal函數處理的消息文本會被qInstallMsgHandler所指向的回調函數截獲,允許使用者自己來處理輸出的消息文本。

一、來看官方的例子:

void outputMessage(QtMsgType type, const QMessageLogContext &context, const QString &msg)
{
    QString text;
    switch(type) 
    {
        case QtDebugMsg:
            text = QString("Debug:");
            break;
        case QtWarningMsg:
            text = QString("Warning:");
            break;
        case QtCriticalMsg:
            text = QString("Critical:");
            break;
        case QtFatalMsg:
            text = QString("Fatal:");
    }
    QDateTime current_date_time = QDateTime::currentDateTime();
    QString current_date = current_date_time.toString("yyyy-MM-dd hh:mm:ss ddd");
    QString message = text.append(msg).append("(").append(current_date).append(")");
    QFile file("log.txt");
    file.open(QIODevice::WriteOnly | QIODevice::Append);
    QTextStream text_stream(&file);
    text_stream<<message<<"\r\n";
    file.close();
}
int main(int argc, char *argv[])
{
    QApplication app(argc, argv);
    //注冊MessageHandler
    qInstallMessageHandler(outputMessage);
    //列印日志到檔案中
    qDebug("This is a debug message");
    qWarning("This is a warning message");
    qCritical("This is a critical message");
    qFatal("This is a fatal message");
    return app.exec();
}      

Qt自帶5個向外寫警告和調試文本的方法。可以把它們使用在如下目的:

qDebug():用于寫自定調試資訊的輸出;

qWarning():用于報告程式中的警告和可恢複的錯誤;

qCritical():用于寫關鍵錯誤資訊和報告系統錯誤;

qFatal():用于退出前簡要地描述緻命錯誤消息;

qInfo():用于寫自定調試資訊的輸出。

如果包含<QtDebug>頭檔案,qDebug()可以當做輸出流來使用。例如:

qDebug() << "Widget" << widget << "at position" << widget->pos();

二、開源項目

http://www.qtcn.org/bbs/read-htm-tid-85387-page-e.html

使用了qInstallMessageHandler的機制,封裝了日志庫。

本人在它基礎之上,略微修改,封裝了更強大和易用的日志庫。

void Log(QtMsgType type, const QMessageLogContext &context, const QString &msg)
#endif
{
    //加鎖,防止多線程中qdebug太頻繁導緻崩潰
    QMutex mutex;
    QMutexLocker locker(&mutex);
    //這裡可以根據不同的類型加上不同的頭部用于區分
    //Release 版本預設不包含這些資訊:檔案名、函數名、行數,需要在.pro項目檔案加入以下代碼,加入後最好重新建構項目使之生效:
    //DEFINES += QT_MESSAGELOGCONTEXT
    //此外,在.pro檔案定義以下的宏,可以屏蔽相應的日志輸出
    //DEFINES += QT_NO_WARNING_OUTPUT
    //DEFINES += QT_NO_DEBUG_OUTPUT
    //DEFINES += QT_NO_INFO_OUTPUT
    QByteArray localMsg = msg.toLocal8Bit();
    QString content;
    switch (type)
    {
    case QtDebugMsg:
        content = QString("Debug: %1 (%2:%3, %4)\n").arg(localMsg.constData()).arg(context.file).arg(context.line).arg(context.function);
        break;
    case QtInfoMsg:
        content = QString("Info: %1 (%2:%3, %4)\n").arg(localMsg.constData()).arg(context.file).arg(context.line).arg(context.function);
        break;
    case QtWarningMsg:
        content = QString("Warning: %1 (%2:%3, %4)\n").arg(localMsg.constData()).arg(context.file).arg(context.line).arg(context.function);
        break;
    case QtCriticalMsg:
        content = QString("Critical: %1 (%2:%3, %4)\n").arg(localMsg.constData()).arg(context.file).arg(context.line).arg(context.function);
        break;
    case QtFatalMsg:
        content = QString("Fatal: %1 (%2:%3, %4)\n").arg(localMsg.constData()).arg(context.file).arg(context.line).arg(context.function);
        break;
    default:
        content = QString("Default: %1 (%2:%3, %4)\n").arg(localMsg.constData()).arg(context.file).arg(context.line).arg(context.function);
        break;
    }
    content = QDateTime::currentDateTime().toString("yyyy-MM-dd hh.mm.ss.zzz ") + content;
    SaveLog::Instance()->save(content);
}      

完整的工程源碼請下載下傳:

https://download.csdn.net/download/libaineu2004/11058474

三、注意事項:

1、Release 版本預設不包含這些資訊:檔案名、函數名、行數,需要在.pro項目檔案加入以下代碼,加入後最好重新建構項目使之生效:

DEFINES += QT_MESSAGELOGCONTEXT

2、此外,在.pro檔案定義以下的宏,可以屏蔽相應的日志輸出

DEFINES += QT_NO_WARNING_OUTPUT

DEFINES += QT_NO_DEBUG_OUTPUT

DEFINES += QT_NO_INFO_OUTPUT

記得把工程清除之後,再重新建構。

也可以靈活一點:

在.pro檔案中加入

release:DEFINES += QT_NO_WARNING_OUTPUT \

                  QT_NO_DEBUG_OUTPUT

這樣一來,編譯debug不受影響,繼續有輸出,release的時候停止輸出。

3、如果使用的IDE是Visual Studio,那麼

在VC項目配置裡C/C++ /Preprocessor /Preprocessor Definitions屬性裡面加入宏定義:

QT_MESSAGELOGCONTEXT

QT_NO_DEBUG_OUTPUT

QT_NO_WARNING_OUTPUT

四、另一個開源項目

https://github.com/francescmm/QLogger https://www.francescmm.com/

繼續閱讀