Qt 日志重定向并缓存到文件

已于 2022-08-01 16:24:36 修改
阅读量490 收藏 1
点赞数
分类专栏： Qt与GTK 文章标签： qt 缓存 c++
于 2022-07-28 11:50:24 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_24423085/article/details/126031582
版权

logUtils.h

#ifndef LOGUTILS_H
#define LOGUTILS_H

#include <QString>
#include <QDateTime>

class LogUtils final
{
public:
    explicit LogUtils() = delete;
    static void checkAppCacheLogDir(const QString &subDirName = "");
    static QString appCacheLogPath();
    static QString localDateTime();
    static QString localDate();
    static QString localDataTimeCSV();
    static uint lastTimeStamp(const QDateTime &dateTime, uint dayCount);
    static QDateTime lastDateTime(const QDateTime &dateTime, uint dayCount);
    static bool containLastDay(const QDateTime &src, const QDateTime &dst, uint dayCount);
    static QDateTime toDayZero();
};

#endif // LOGUTILS_H

logUtils.cpp

#include "logutils.h"

#include <QDateTime>
#include <QMutex>
#include <QDebug>
#include <QStandardPaths>
#include <QCoreApplication>
#include <QFileInfo>
#include <QDir>

namespace GlobalPrivate
{
    const QString cachePath = QStandardPaths::locate(QStandardPaths::CacheLocation,
                                                     "",
                                                     QStandardPaths::LocateDirectory);
    const QString deepinCachePath = cachePath + "deepin" + QDir::separator();
}

/**
 * @brief checkAppCacheLogDir
 *  检查应用程序缓存日志的文件夹
 * @param subDirName 日志目录下的子目录
 *  默认为空，则检查顶层目录
 */
void LogUtils::checkAppCacheLogDir(const QString &subDirName)
{
    if (!QFileInfo::exists(GlobalPrivate::deepinCachePath))
        QDir().mkdir(appCacheLogPath());

    if (!QFileInfo::exists(appCacheLogPath()))
        QDir().mkdir(appCacheLogPath());

    if (subDirName.isEmpty()) return;

    if (!QFileInfo::exists(appCacheLogPath() + QDir::separator() + subDirName))
        QDir().mkdir(appCacheLogPath() + QDir::separator() + subDirName);
}

/**
 * @brief appCacheLogPath
 *  获取当前应用程序的缓存日志路径，
 * @return QString 返回的结果总是一个Dir类型的字符路径
 */
QString LogUtils::appCacheLogPath()
{
    return GlobalPrivate::deepinCachePath + QCoreApplication::applicationName();
}

/**
 * @brief localDateTime 获取年/月/日/时间
 * @return QString 格式化字符串后的时间
 */
QString LogUtils::localDateTime()
{
    return QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss.zzz");
}

/**
 * @brief localDate 获取年/月/日
 * @return QString 格式化字符串后的时间
 */
QString LogUtils::localDate()
{
    return QDate::currentDate().toString("yyyy-MM-dd");
}

/**
 * @brief localDate 获取年/月/日/时间，
 *  年/月/日/与时间之间以逗号分割
 * @return QString 格式化字符串后的时间
 */
QString LogUtils::localDataTimeCSV()
{
    return QDateTime::currentDateTime().toString("yyyy-MM-dd,hh:mm:ss,zzz");
}

/**
 * @brief lastTimeStamp 获取输入时间之前指定天数时间戳，
 * 最小单位s
 * @param dateTime 时间
 * @param dayCount 向前的天数
 * @return uint 时间戳
 */
uint LogUtils::lastTimeStamp(const QDateTime &dateTime, uint dayCount)
{
    return dateTime.toTime_t() - (86400 * dayCount);
}

/**
 * @brief lastDateTime 获取输入时间之前指定天数时间，
 * 最小单位s
 * @param dateTime 时间
 * @param dayCount 向前的天数
 * @return QDateTime 时间
 */
QDateTime LogUtils::lastDateTime(const QDateTime &dateTime, uint dayCount)
{
    return QDateTime::fromTime_t(lastTimeStamp(dateTime,dayCount));
}

/**
 * @brief containLastDay 判断时间是否包含时间(天)范围
 * 最小单位s
 * @param src 基准时间
 * @param dst 对比时间
 * @param dayCount 往前推的天数
 * @return bool 是否包含的结果
 *
 * |------dst--------src----|
 * |------dayCount----|
 * return true;
 *
 * |-----------dst-------------src|
 *                  |-dayCount--|
 * return false
 */
bool LogUtils::containLastDay(const QDateTime &src, const QDateTime &dst, uint dayCount)
{
    uint srcStamp = src.toTime_t();
    uint dstStamp = dst.toTime_t();

    return dstStamp - (86400 * dayCount) < srcStamp && srcStamp <= dstStamp;
}

/**
 * @brief toDayZero 获取今天的00:00:00的时间
 * @return
 */
QDateTime LogUtils::toDayZero()
{
    QDateTime dateTime;
    dateTime.setDate(QDate::currentDate());
    dateTime.setTime(QTime(0,0,0));
    return dateTime;
}

frameworklog.h

#include <QDebug>
#include <QLoggingCategory>

/**
 * @brief Framework 可进行相关调用，如下
 * @code
 * qCDebug(Framework) << "hello";    //调试信息打印
 * qCInfo(Framework) << "hello";    //信息打印
 * qCDWarning(Framework) << "hello";     //警告打印
 * qCCritical(Framework) << "hello";     //关键日志打印
 * @endcode
 */
Q_DECLARE_LOGGING_CATEGORY(Framework)

/**
 * @brief FrameworkLog 宏函数，可进行相关打印调用，如下
 * @code
 * FDebug() << "hello";    //调试信息打印
 * FInfo() << "hello";    //信息打印
 * FWarning() << "hello";     //警告打印
 * FCritical() << "hello";     //关键日志打印
 * @endcode
 */
#define FDebug() qCDebug(Framework)
#define FInfo() qCInfo(Framework)
#define FWarning() qCDWarning(Framework)
#define FCritical() qCCritical(Framework)
#endif

/**
 * @brief The FrameworkLog class
 *  框架日志打印模块，内部封装输出重定向与日志格式化
 */
class FrameworkLog final
{
public:
    explicit FrameworkLog() = delete;
    static void enableFrameworkLog(bool enabled = true);
    static void setLogCacheDayCount(uint dayCount);
    static uint logCacheDayCount();
    static void initialize();
};

frameworklog.cpp

#include "frameworklog.h"
#include "logutils.h"

#include <QDir>
#include <QFile>
#include <QFileInfo>
#include <QCoreApplication>
#include <QtConcurrent>

Q_LOGGING_CATEGORY(Framework, "Framework")

namespace GlobalPrivate
{
    static QFile file;
    static uint dayCount = 7;
    static QMutex mutex;

    QString formatFrameworkLogOut(QtMsgType type, const QMessageLogContext &context, const QString &msg)
    {
        auto fileNameList = QString(context.file).split(QDir::separator());
        auto currentName = fileNameList[fileNameList.size() - 1];

        if (type == QtMsgType::QtDebugMsg)
            return "[" + QString(context.category) + "]["
                    + LogUtils::localDateTime() + "][Debug]["
                    + currentName + " "
                    + context.function + " "
                    + QString::number(context.line) + "]"
                    + msg;
        if (type == QtMsgType::QtInfoMsg)
            return "[" + QString(context.category) + "]["
                    + LogUtils::localDateTime() + "][Info]["
                    + currentName + " "
                    + context.function + " "
                    + QString::number(context.line) + "]"
                    + msg;
        if (type == QtMsgType::QtCriticalMsg)
            return "[" + QString(context.category) + "]["
                    + LogUtils::localDateTime() + "][Critical]["
                    + currentName + " "
                    + context.function + " "
                    + QString::number(context.line) + "]"
                    + msg;
        if (type == QtMsgType::QtWarningMsg)
            return "[" + QString(context.category) + "]["
                    + LogUtils::localDateTime() + "][Warning]["
                    + currentName + " "
                    + context.function + " "
                    + QString::number(context.line) + "]"
                    + msg;
        if (type == QtMsgType::QtSystemMsg)
            return "[" + QString(context.category) + "]["
                    + LogUtils::localDateTime() + "][System]["
                    + currentName + " "
                    + context.function + " "
                    + QString::number(context.line) + "]"
                    + msg;
        if (type == QtMsgType::QtFatalMsg)
            return "[" + QString(context.category) + "]["
                    + LogUtils::localDateTime() + "][Fatal]["
                    + currentName + " "
                    + context.function + " "
                    + QString::number(context.line) + "]"
                    + msg;
        return msg;
    }

    static void rmExpiredLogs()
    {
        QtConcurrent::run([=](){
            QDirIterator itera(LogUtils::appCacheLogPath(),QDir::Files);
            while(itera.hasNext()) {
                itera.next();
                auto list = itera.fileName().split("_");
                if (itera.fileInfo().suffix() == "log"
                        && list.count() == 2
                        && !LogUtils::containLastDay(
                            QDateTime(QDate::fromString(list[0],"yyyy-MM-dd"),
                                      QTime(0,0,0,0)),
                            LogUtils::toDayZero(),
                            GlobalPrivate::dayCount))
                {

                    auto outMsg = formatFrameworkLogOut(QtMsgType::QtInfoMsg,
                                                        QMessageLogContext{
                                                            __FILE__,
                                                            __LINE__,
                                                            __FUNCTION__,
                                                            Framework().categoryName()
                                                        },
                                                        QString("remove true(%0) not last week log: %1")
                                                        .arg(QDir().remove(itera.path() + QDir::separator() + itera.fileName()))
                                                        .arg(itera.fileName().toLocal8Bit().data())
                                                        );

                    fprintf(stderr, "%s\n", outMsg.toUtf8().data());
                }
            }
        });
    }

    void redirectGlobalDebug(QtMsgType type,
                             const QMessageLogContext &context,
                             const QString &msg)
    {
        QMutexLocker locker(&mutex);
        QString logMsg = GlobalPrivate::formatFrameworkLogOut(type,context,msg);
        if (type == QtMsgType::QtDebugMsg)
            fprintf(stdin,"%s\n",logMsg.toUtf8().data());
        if (type == QtMsgType::QtInfoMsg)
            fprintf(stderr,"%s\n",logMsg.toUtf8().data());
        if (type == QtMsgType::QtSystemMsg)
            fprintf(stdin,"%s\n",logMsg.toUtf8().data());
        if (type == QtMsgType::QtCriticalMsg)
            fprintf(stderr,"%s\n",logMsg.toUtf8().data());
        if (type == QtMsgType::QtWarningMsg)
            fprintf(stderr,"%s\n",logMsg.toUtf8().data());
        if (type == QtMsgType::QtFatalMsg)
            fprintf(stderr,"%s\n",logMsg.toUtf8().data());

        // cache/deepin/qApp->applicationName()
        LogUtils::checkAppCacheLogDir();

        if (GlobalPrivate::file.fileName().isEmpty()) {
            GlobalPrivate::file.setFileName(LogUtils::appCacheLogPath()
                                            + QDir::separator()
                                            + LogUtils::localDate()
                                            + "_" + QCoreApplication::applicationName()
                                            + ".log");

            auto outMsg = GlobalPrivate::formatFrameworkLogOut(QtMsgType::QtInfoMsg,
                                                               QMessageLogContext{
                                                                   __FILE__,
                                                                   __LINE__,
                                                                   __FUNCTION__,
                                                                   Framework().categoryName()
                                                               },
                                                               "Current redirect log file path: "
                                                               + GlobalPrivate::file.fileName()
                                                               );

            fprintf(stderr, "%s\n", outMsg.toUtf8().data());

            //清除超出时间段的日志
            GlobalPrivate::rmExpiredLogs();
        }

        if (!GlobalPrivate::file.open(QFile::Append|QFile::ReadOnly)) {

            auto outMsg = GlobalPrivate::formatFrameworkLogOut(QtMsgType::QtInfoMsg,
                                                               QMessageLogContext{
                                                                   __FILE__,
                                                                   __LINE__,
                                                                   __FUNCTION__,
                                                                   Framework().categoryName()
                                                               },
                                                               "Failed, open redirect log file"
                                                               + GlobalPrivate::file.fileName()
                                                               + " "
                                                               + GlobalPrivate::file.errorString()
                                                               );

            fprintf(stderr, "%s\n", outMsg.toUtf8().data());

            return;
        }

        GlobalPrivate::file.write((logMsg + ("\n")).toLocal8Bit().data());
        GlobalPrivate::file.flush();
        GlobalPrivate::file.close();
    }

} // namespace GlobalPrivate

/**
 * @brief enableFrameworkLog 开启框架日志打印
 * @param enabled true为开启,false则关闭
 */
void FrameworkLog::enableFrameworkLog(bool enabled)
{
    if (enabled) {
        QLoggingCategory::setFilterRules(QLatin1String("FrameworkLog.warning=true"));
        QLoggingCategory::setFilterRules(QLatin1String("FrameworkLog.debug=true"));
        QLoggingCategory::setFilterRules(QLatin1String("FrameworkLog.info=true"));
        QLoggingCategory::setFilterRules(QLatin1String("FrameworkLog.critical=true"));

    } else {
        QLoggingCategory::setFilterRules(QLatin1String("FrameworkLog.warning=false"));
        QLoggingCategory::setFilterRules(QLatin1String("FrameworkLog.debug=false"));
        QLoggingCategory::setFilterRules(QLatin1String("FrameworkLog.info=false"));
        QLoggingCategory::setFilterRules(QLatin1String("FrameworkLog.critical=false"));
    }
}

/**
 * @brief setLogCacheDayCount 设置日志缓存时间，
 *  需要在调用其他函数之前调用
 * @param uint 缓存的天数
 */
void FrameworkLog::setLogCacheDayCount(uint dayCount)
{
    static QMutex mutex;
    mutex.lock();
    GlobalPrivate::dayCount = dayCount;
    mutex.unlock();
}

/**
 * @brief logCacheDayCount 获取设置的日志缓存时间
 * @return uint 缓存的天数,默认缓存7天
 */
uint FrameworkLog::logCacheDayCount()
{
    return GlobalPrivate::dayCount;
}

/**
 * @brief initialize 初始化框架日志打印模块
 */
void FrameworkLog::initialize()
{
    qInstallMessageHandler(&GlobalPrivate::redirectGlobalDebug);
}

调用FrameworkLog::initialize()即可重定向日志输出

QT文件上传带进度条实例（含源码）
啊渊的专栏
04-28 854
QT文件上传带进度条实例（含源码）
qt实现日志系统功能
qq_31412239的博客
03-09 2059
功能特点： 1.基于qt本身的日志系统实现。 2.使用线程进行写文件操作。 3.记录当前时间、文件、函数等信息。 4.每天0点自动写入新的日志文件。 使用方式： qInstallMessageHandler(SysMessage::SysMessageOutput); 头文件： #ifndef QTLOG_H #define QTLOG_H #include <QThread> class QMutex; class QFile; class QString;
QT重定向日志到文件
05-07
qt日志重定向到文件，打印日志所在文件、行、级别、时间，并支持调整日志级别打印不同级别日志，支持日志文件达到一定大小另存入新文件，支持设置文件最大数量
QT的输出日志保存到文件内
qq92542的博客
09-10 1238
QT日志写入文件 将qt文件一些qDebug，qWarning，qError输出的信息保存到指定文件内 #include "basiclogging.h" #include <QDebug> #include <QDir> QString BasicLogging::logFilePath = "LogFile_Printer";//指定文件路径 当前目录下的 BasicLogging::BasicLogging() { } void BasicLogging::s
Qt 日志输出(重定向)
@杭大大
03-27 572
Qt框架提供了灵活的日志系统，支持从简单的控制台输出到复杂的自定义日志处理。本文将详细介绍Qt中五种常用的日志输出和重定向方法，并附上完整代码示例。
Qt保存日志调试信息输出文件
hanxiaoyong_的博客
01-26 1497
在项目中需将日志打印消息保存到文件中，用来定位出现的问题。 直接上代码： #include <QDebug> #include <QTextStream> #define _TIME_ qPrintable (QTime::currentTime ().toString ("hh:mm:ss:zzz"))//时间记录 void myLogput(QtMsgType type, const QMessageLogContext &context, const QStrin
QT 保存日志数据，根据条件自动创建日志文件
06-10
源码实现了QT平台下的日志记录功能，可以设置日志路径，设置日志文件存储大小
Qt 日志重定向
QIUCHUNHUIGE的博客
07-29 628
Qt自带的日志重定向机制非常简单好用，自从用了以后再也不用什么断点调试啥的了，在需要的地方支持qdebug输出对应的信息，而且发布程序以后也可以开启调试日志将其输出查看等
Qt实现QDebug重定向输出到日志文件（支持多线程安全）
wu10188的博客
04-02 2700
在Qt中，qDebug()，qInfo()，qWarning()，qCritical()，qFatal()常用于打印信息到终端控制台，我们可以将其重定向输出到文件中。方法如下：
QT的qWarning怎么输出日志文件
最新发布
04-17
在 QT 中，可以通过自定义消息处理器来捕获 `qWarning` 的输出，并将其重定向到指定的日志文件中。以下是详细的实现方式及其相关说明。 --- #### 1. 自定义消息处理器 QT 提供了 `qInstallMessageHandler` 函数...
【跨平台Qt日志管理】：在不同操作系统中优化日志应用的策略
本文综述了跨平台Qt日志管理的基本原理和框架，探讨了日志配置、存储、分析以及高级应用如多线程环境和远程管理的实现技巧。同时，对日志的安全性和隐私保护进行了详细讨论，并通过桌面、移动和服务器端应用的日志
Qt日志重定向qInstallMessageHandler，输出至文件及网络
03-25
Qt日志重定向qInstallMessageHandler，输出至文件及网络
QT运行日志保存和对日志大小进行监控
weixin_45054387的博客
08-11 1069
最近在做qt的时候遇到一个问题，就是将qt程序在设备上运行，时间长或者是一些操作导致qt卡死或者崩溃的时候，无法判断qt问题出在哪里，没有的UI程序的日志进行打印保存，后面定位错误的时候会比较麻烦，于是查找了一个对qt打印进行定向输出到日志文件的方法。在QT中对日志定向输出比较好的方法是使用ofstream的方法，向流输出数据；还有一个问题就是如果加锁和解锁的过频繁可能会带来的问题。......
Qt日志重定向（将qDebug信息输出到界面控件）
热门推荐
Wanggj的博客
12-28 1万+
Qt日志重定向 程序日志对于输出程序运行信息有着非常重要的作用，它可以帮助程序员定位问题所在，输出程序运转状态等 在使用QtCreator编写程序时，我们可以使用qDebug方便的将自己需要的信息输出，但是如果想将其显示到程序的控件上，又该怎样做呢？ 经过一番搜索，我找到了将qDebug重定向的方法，可以将其输出的信息自由的存放到ui控件或文件中（搜到的大部分教程都是将日志信息重定向到文件中，容易让人误以为它只能重定向到文件） qInstallMessageHandler 由于本人开发环境为Qt5，因此本文
【QT】日志重定向机制
u013307195的博客
07-12 437
日志重定向机制
Qt：日志重定向窗口
OceanStar的博客
01-29 2108
日志重定向到窗口 封装类 1、logbrowser.h #ifndef LOG_BROWSER_H #define LOG_BROWSER_H #include <QWidget> #include <QVBoxLayout> #include <QTextBrowser> #include <QPushButton> #include <QCoreApplication> #include <QDebug> #include &lt
Qt实现输出日志到指定文件
intwei的博客
07-25 798
Qt实现输出日志到指定文件
(Qt) 重定向内置日志
cuber-lotus的博客
04-18 932
在Qt中，我们平常用的就是Qt自带的日志的一部分，平常我们最常用的就是在控制台进行输出。而本文通过自定义重定向，来将信息打到日志文件中。 #include qInstallMessageHandler(QtMessageHandler) qDebug(); qWarning(); qCritical(); qInfo();
Qt日志重定向处理（回调函数方法）
weixin_42887343的博客
11-30 717
qDebug()日志重定向处理 使用函数原型（qt库所有） typedef void (*QtMsgHandler)(QtMsgType, const char *); Q_CORE_EXPORT QtMsgHandler qInstallMsgHandler(QtMsgHandler); （1）使用方法，首先依据上面void (*QtMsgHandler)(QtMsgType, const char *);函数格式，定义一个自己的函数，函数内部就是自己处理日志的方法（如输出到终端、或是保存到文件）。定义
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值