Qt调试详细日志文件输出

王宪笙

已于 2024-05-15 11:38:27 修改

阅读量747

点赞数 14

分类专栏： Qt学习总结文章标签： qt 开发语言

于 2024-04-11 14:51:25 首次发布

本文链接：https://blog.csdn.net/qq_37464701/article/details/137637669

版权

本文介绍了如何在Qt中利用qSetMessagePattern函数定制日志输出格式，包括各种占位符的使用，以及在Release版本中启用文件、函数和行号信息。同时，讲解了qInstallMessageHandle函数用于安装自定义的日志处理回调，以将日志信息重定向到文件。最后，提供了一个LogOutput类的示例，用于将调试信息写入文本文件。

摘要由CSDN通过智能技术生成

Qt调试详细日志文件输出

qSetMessagePattern函数

通过qSetMessagePattern函数，实现定制化输出。

占位符描述如下：

%{appname} : 应用名字
%{file} : 源文件路径
%{function} : 函数
%{line} : 源文件所在行
%{message} : 实际的消息
%{pid} : 应用进程号
%{threadid} : 线程ID
%{type} : 日志类型(如Debug、Warning、Critical等)
%{time} : 当前时间戳
%{time boot} : 系统启动后到当前时刻经过的时间

可以使用条件类型，%{if-debug}, %{if-info} ,%{if-warning}, %{if-critical} 或 %{if-fatal}后面跟着一个%{endif}。如果类型匹配，%{if-*} 和 %{endif}之间的内容会被打印。

注意：

qSetMessagePattern函数只会影响使用Qt的日志系统，如QDebug、qInfo、qWarning和qCritical等函数输出的日志消息。
Release 版本默认不包含文件名、函数名、行数等信息，需在.pro项目文件加入以下代码，然后重构项目：

DEFINES += QT_MESSAGELOGCONTEXT

在.pro文件定义以下的宏，可以屏蔽相应的日志输出,但要注意只能屏蔽本项目工程的日志输出，其他工程生成的lib库生成的日志输出屏蔽不了:

DEFINES += QT_NO_WARNING_OUTPUT
DEFINES += QT_NO_DEBUG_OUTPUT
DEFINES += QT_NO_INFO_OUTPUT

qSetMessagePattern函数使用举例如下：

int main(int argc, char **argv)
{
   
    QApplication app(argc, argv);
 	
    // 改变缺省消息处理程序的输出，信息：线程：功能函数(行数)：时间
    qSetMessagePattern("%{message} :id=%{threadid} %{function}(%{line}):%{time [hh:mm:ss zzz]}");
    
    // 打印信息
    qDebug("This is a debug message.");
    qInfo("This is a info message.");
    qWarning("This is a warning message.");
    qCritical("This is a critical message.");
    //qFatal("This is a fatal message.");

    ...
    return app.exec();
}

qInstallMessageHandle介绍

qInstallMessageHandle安装消息，注册回调函数，对qDebug()、qWarning()、qCritial()、qInfo()、qFatal() 等函数输出信息重定向处理。

注明：以下方法仅适用于 Qt5 及以上版本。

目的：生成log.txt日志文件，记录详细日志信息（包括等级、所在文件、所在行号、描述信息、产生时间等）,以便于快速跟踪、定位。那么在qt createor的应用程序输出窗口就不会有调试信息显示。

QtMessageHandler qInstallMessageHandler(QtMessageHandler handler)

qInstallMessageHandler安装写在main()方法中，这样全局所有类的qDebug都可以将信息直接打印到日志文件中（即安装了消息处理）。如果想恢复消息处理程序,调用qInstallMessageHandler(0)。

QtMessageHandler 回调函数处理日志信息，包括等级、所在文件、所在行号、描述信息、产生时间。并保存到本地文件。

其中等级：

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

自定义LogOutput类

LogOutput类：将qDebug、qWarning、qInfo、qCritical、qFatal等调试信息写入到text文件中
头文件如下：

#ifndef LOGOUTPUT_H
#define LOGOUTPUT_H

#include <QObject>
#include <QApplication>
#include <QDir>
#include <QMutex>
#include <QDateTime>
#include <QTextStream>
#include <QFile>


const int LOG_OPERATE_OK = 100; //操作成功
const int LOG_OPENFILE_FAILED = 101; //打开文件失败

class LogOutput : public QObject
{
   
    Q_OBJECT
public:
    enum MyMsgType
    {
   
        DebugMsg = 1,//备注：要想使用组合枚举值，枚举值的赋值最好使用2的幂次方
        WarningMsg = 2,
        CriticalMsg = 4,
        FatalMsg = 8