Qt5如何输出日志输出文件（最全最新的框架方法)

描述

最近用到了Qt5的日志输出功能模块，现记录一下，途中还遇见一些release版本日志输出不显示行号的问题。

回归正题：在Qt开发过程当中经常使用qDebug等一些输出来调试程序，但是到了正式发布的时候，都会被注释或者删除，采用日志输出来代替。

做过项目的童鞋可能都使用过日志功能，以便有异常错误能够快速跟踪、定位，Qt也提供的类似的机制。之前用Qt4做项目时使用的是Qt::qInstallMsgHandler()，到了Qt5，使用了新的Qt::qInstallMessageHandler()来替代，详情请查看Qt助手（C++ API changes）。

助手中在C++ API changes中提到：Qt::qDebug()、Qt::qWarning()、Qt::qCritical()、Qt::qFatal()被改变为宏来跟踪源代码的消息来源。被打印的信息可以被配置（用于缺省消息处理程序），通过设置该新的环境变量QT_MESSAGE_PATTERN。Qt::qInstallMsgHandler()已过时，因此建议使用Qt::qInstallMessageHandler()来代替。

日志级别

• qDebug：调试信息
• qWarning：警告信息
• qCritical：严重错误
• qFatal：致命错误

官方示例

需求（目的）：生成log.txt日志文件，记录详细日志信息（包括等级、所在文件、所在行号、描述信息、产生时间等）,以便于快速跟踪、定位。

代码实现

#define FILEName "logger.txt"
class MessageHandler: public QObject{

    Q_OBJECT
public:
    explicit MessageHandler(QObject *parent = nullptr)
    {
        Q_UNUSED(parent);
        //注册MessageHandler
        qInstallMessageHandler(MessageHandler::outputMessage);
    }
private:
    static void outputMessage(QtMsgType type, const QMessageLogContext &context, const QString &msg)
    {
        static QMutex mutex;
        mutex.lock();

        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:");
            break;

        case QtInfoMsg:
            text = QString("Info:");
            break;
        }

        QString context_info = QString("File:(%1) Line:(%2)").arg(QString(context.file)).arg(context.line);
        QString current_date_time = QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss ddd");
        QString current_date = QString("(%1)").arg(current_date_time);
        QString message = QString("%1 %2 %3 %4").arg(text).arg(context_info).arg(msg).arg(current_date);

        QString logPath ;
#if defined (Q_OS_ANDROID)

        QStringList stringList =  QStandardPaths::standardLocations(QStandardPaths::PicturesLocation);
        //   qInfo()<<"当前获取到的stringList = "<

        logPath =  stringList.at(stringList.length() - 1);

        int indexPosition = logPath.lastIndexOf("/");
        if(indexPosition != -1)
        {
            logPath = logPath.mid(0, indexPosition);

            if(!isDirExist(logPath+"/YYM"))
            {
                qInfo("Failed to create log directory.");
            }
            else
            {
                logPath = logPath+"/YYM";
            }
        }
#else
        logPath =  HelpClass::getCurrentTempDataDir()+"/Logger";

        HelpClass::isDirExist(logPath);
//        qInfo()<<"当前获取到的stringList = "<
#endif
        QString date = QDateTime::currentDateTime().toString("yyyy-MM-dd");

        logPath = logPath +QString("/logger(%1).txt").arg(date);
    //    qInfo()<<"LogPath = "<
        QFile file(logPath);
        file.open(QIODevice::WriteOnly | QIODevice::Append);
        QTextStream text_stream(&file);
        text_stream.setCodec("UTF-8");
        text_stream << message << "\r\n";
        file.flush();
        file.close();

        mutex.unlock();
    }
};
#endif // MESSAGEHANDLER_H

使用方法：
在main里面调用即可

int main(int argc, char *argv[])
{
    QApplication a(argc, argv);
 
    MessageHandler *message = new MessageHandler;

    //打印日志到文件中
        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 a.exec();
}

注意！注意！注意！(重要的事情说三遍)

Release版本的输出却没有文件信息、行数等信息，如图。

Release输出

原因是：文件信息、行数等信息在Release版本默认舍弃。我们只要在.pro文件定义一个宏

DEFINES += QT_MESSAGELOGCONTEXT

DEFINES += QT_MESSAGELOGCONTEXT
然后，重新qmake，编译（有可能要删除掉之前编译的中间文件），就可以在Release版本中正确输出日志信息，如图。