Qt实现QDebug重定向输出到日志文件（支持多线程安全）

本文主要是介绍Qt实现QDebug重定向输出到日志文件（支持多线程安全），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

在Qt中，qDebug()，qInfo()，qWarning()，qCritical()，qFatal()常用于打印信息到终端控制台，我们可以将其重定向输出到文件中。

我们创建一个单例类“LogOutput”封装重定向到文件操作：

logoutput.h

#ifndef LOGOUTPUT_H
#define LOGOUTPUT_H
/*** @brief QDebug的日志输出重定向到文件* @author wjp* @date 2024.3.8 modify by wjp** */#include <QObject>
#include <QtMessageHandler>
#include <QDebug>
#include <QFile>
#include <QMutex>
#include <QMutexLocker>#define LOG_MAXSIZE  5 * 1024 * 1024 //单个log文件最大值class LogOutput : public QObject
{Q_OBJECT
public:static LogOutput * getInstance();void install(); //安装信息处理函数void uninstall(); //卸载信息处理函数void deleteLog(); //删除过期日志protected:// 此函数用于注册static void customMessageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg);private://将构造函数，拷贝构造，赋值运算符都定义为私有，不允许外部类操作explicit LogOutput(QObject *parent = nullptr); //构造函数~LogOutput();  //析构LogOutput(const LogOutput &sig) = delete; //拷贝构造函数LogOutput& operator=(const LogOutput &sig) = delete ; //赋值运算符重载private:static LogOutput *ins;  //私有静态对象static QMutex m_mutex;QFile m_curLogFile;QString m_curLogFileDate;// 当前日志所属日期，防止在午夜24点刚刚过，需要更换日志输出文件//信息处理函数(重写的myMessageHandler)/*功能说明:通过调试信息保存到日志文件**参数说明:* msgType: 调试信息类型或级别（qdebug, qwarning, qfatal 。。。。）* context: 调试信息所处文本，可使用context.file和context.line获取文本所处行数及所处文件路径，以及使用context.function获取文本所处函数名* msg: 调试信息内容，自定义*/void outPutMsg(QtMsgType msgType, const QMessageLogContext &context, const QString &msg);/** 函数功能:* 1、根据调试信息以及日期，保存到相应的文件。* 2、在保存文件前需要判断文件大小是否大于自定义值,如果大于,便按照序号从小到大新建一个。*/void saveLog(QString message);// 打开日志文件void openTheLogFile();
};#endif // LOGOUTPUT_H

logoutput.cpp（注意输出日志文件的路径你可以优化一下，通过公共接口设置）

#include "logoutput.h"
#include <QFile>
#include <QTextStream>
#include <QApplication>
#include <QDateTime>
#include <QMutex>
#include <QFileInfo>
#include <QMetaEnum>
#include <QSettings>
#include <QDir>LogOutput * LogOutput::ins = nullptr;
QMutex LogOutput::m_mutex;LogOutput::LogOutput(QObject *parent) : QObject(parent)
{}LogOutput::~LogOutput()
{if(m_curLogFile.isOpen())m_curLogFile.close();qInfo() << "日志输出模块释放";
}//安装日志函数
void LogOutput::install()
{//创建log文件夹QString logPath = QApplication::applicationDirPath() + "/log";QDir dir(logPath);if(!dir.exists()){dir.mkdir(logPath);qDebug() << QString("运行日志文件夹创建成功：%1").arg(logPath);}// 打开日志输出文件（不存在则创建并打开）openTheLogFile();//安装消息处理函数qInstallMessageHandler(LogOutput::customMessageHandler);// 此句执行后，qDebug,qInfo等才会输出到文件qInfo() << "-------------------日志输出模块创建成功-------------------";//deleteLog(); //删除过期日志
}//卸载日志函数
void LogOutput::uninstall()
{qInstallMessageHandler(nullptr);
}//日志信息处理函数
void LogOutput::outPutMsg(QtMsgType msgType, const QMessageLogContext &context, const QString &msg)
{//判断信息类型QString type;switch (msgType){case QtDebugMsg:type = QString("Debug");break;case QtWarningMsg:type = QString("Warning");break;case QtCriticalMsg:type = QString("Critical");break;case QtFatalMsg:type = QString("Fatal");break;case QtInfoMsg:type = QString("Info");}m_mutex.lock();  //互斥关锁//文件名和行数以及函数QString contextInfo = QString("[File:(%1), Line:(%2), Funtion(%3)]:").arg(context.file).arg(context.line).arg(context.function);//获取当前时间，精确到秒QDateTime curdatetime = QDateTime::currentDateTime();QString currentDate = curdatetime.date().toString("yyyy-MM-dd");QString currentTime = curdatetime.time().toString("hh:mm:ss");if(m_curLogFile.isOpen()){bool bFileSizeLarge = (m_curLogFile.size() >= LOG_MAXSIZE) ? true : false;bool bNextDate = (currentDate.compare(m_curLogFileDate,Qt::CaseInsensitive) == 0) ? false : true;// 当系统时间过了今天的24点到达另一天,或者超过单个日志文件最大值，切换日志输出文件if(bFileSizeLarge || bNextDate){m_curLogFile.close();// 重新打开日志输出文件（不存在则创建并打开）openTheLogFile();}}//拼接信息字符串QString message = QString("[%1 %2] %3: %4 %5").arg(currentDate).arg(currentTime).arg(type).arg(contextInfo).arg(msg);//存入信息到日志文件saveLog(message);m_mutex.unlock(); //开锁}//删除过期日志
void LogOutput::deleteLog()
{//获取日志文件夹地址QString dirName =  QApplication::applicationDirPath() + "/log";QDir dir(dirName);//获取文件夹下所有文件信息列表QFileInfoList infoList = dir.entryInfoList(QDir::Files);//遍历日志文件foreach (QFileInfo fileInfo, infoList) {//将文件创建时间与过期时间作比较，如果创建时间小于过期时间，则删除（代码是一天期限，如果改月为单位可以使用addMonths）if(fileInfo.birthTime() <= QDateTime::currentDateTime().addDays(-1)){QFile::setPermissions(dirName + "/" +fileInfo.fileName(), QFileDevice::ReadOther | QFileDevice::WriteOther);if(QFile::remove(dirName + "/" +fileInfo.fileName())){qDebug() << "过期日志文件删除成功！-->" << fileInfo.fileName();}else{qDebug() << "过期日志文件删除成功！-->" << fileInfo.fileName();}}}
}//保存日志到文件
void LogOutput::saveLog(QString message)
{if(m_curLogFile.isOpen()){QTextStream write(&m_curLogFile);write << message << "\r\n";m_curLogFile.flush();// 刷新写入缓存}
}void LogOutput::openTheLogFile()
{int i = 1; //当文件大小超过最大值时，给新文件添加编号m_curLogFileDate = QDateTime::currentDateTime().toString("yyyy-MM-dd");//以天为单位给文件命名QString fileName = QApplication::applicationDirPath() + "/log/" + m_curLogFileDate + "_log";//文件名右边（后缀）QString fileNameRight;//最终要写入的文件名QString fileNameLast = fileName + ".txt";//绑定文件对象m_curLogFile.setFileName(fileNameLast);//判断文件大小while(m_curLogFile.size() >= LOG_MAXSIZE){//给新文件加入序号后缀fileNameRight = QString("_%1.txt").arg(i);//拼接最终文件名fileNameLast = fileName + fileNameRight;//修改file绑定的文件名m_curLogFile.setFileName(fileNameLast);i++;}//只写和拼接的方式打开文件bool isopen = m_curLogFile.open(QIODevice::WriteOnly | QIODevice::Append);if(isopen == true){}
}LogOutput *LogOutput::getInstance()
{QMutexLocker locker(&m_mutex);  //必须加锁if(!ins){ins = new LogOutput();}return ins;
}void LogOutput::customMessageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg)
{LogOutput::getInstance()->outPutMsg(type, context, msg); // 调用非静态成员函数处理消息
};

main.cpp中使用

int main(int argc, char *argv[])
{QApplication app(argc, argv);// 日志模块初始化(将QDebug重定向到文件)LogOutput::getInstance()->install();// 测试重定向后是否有这些日志输出到文件qDebug() << "日志输出1";qInfo() << "日志输出2";qWarning() << "日志输出3";qCritical() << "日志输出4";qFatal() << "日志输出5";MainWindow w;w.show();return app.exec();
}