一个基于Qt的C++日志类

已于 2023-08-02 10:53:12 修改
阅读量223 收藏
点赞数
文章标签： qt c++
于 2023-08-01 18:57:39 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_41649821/article/details/132048441
版权

项目地址

https://gitee.com/cnleika/cpp-log

一、准备工作

一个日志类可以拆分成两个步骤

  1. 打开文件
  2. 写入内容

1. 打开文件

QFile * mfile=new QFile("mylog.log");
mfile->open();

这样就打开一个mylog.log文件了。

2.写入内容

QTextStream * mtextstream =new QTextStream(mfile);
*mtextstream << "hello world";

这样就可以往mylog.log文件中写入一条hello world内容了。

至此，准备工作结束。

二、设计

按照我的设计，一个基础的日志应该包含以下功能：

  1. 配置文件
  2. 日志存储方式：日期.log
  3. 日志内容：时间、级别、文件、行号、内容
  4. 日志存储级别：error > warn > info > debug
  5. 日志更新方式：覆写、追加
  6. 多线程
  7. 限制日志大小

三、读写配置文件

Qt提供了一个QSettings类用于读写ini文件。
logCfg.ini

[LEVEL]
;0:ERROR
;1:ERROR+WARNING
;2:ERROR+WARNING+INFO
;3:ERROR+WARNING+INFO+DEBUG
level=2

[SIZE]
;MB
size=200

[OPTION]
;0覆盖，1追加
option=1


void LogUtils::ReadConfig()
{
    QSettings *config=new QSettings("./logCfg.ini",QSettings::IniFormat);
    mlevel=config->value("/LEVEL/level").toInt();
    qDebug()<< "日志等级:" << QString::number(mlevel);
    msize=config->value("/SIZE/size").toInt()*1000000;
    qDebug()<< "日志大小:" << QString::number(msize);
    moption=config->value("/OPTION/option").toInt();
    qDebug()<<"日志选项:"<<(moption==0?"覆盖":(moption==1?"追加":"未知"));
}

四、日志打印


            enum Level{
                LOG_ERROR,
                LOG_WARNING,
                LOG_INFO,
                LOG_DEBUG
            };
            const QStringList mLevel={
                "ERROR",
                "WARNING",
                "INFO",
                "DEBUG"
            };

void LogUtils::log(LogUtils::Level level, QString str,QString file, uintmax_t line)
{
    QString text=
            "["+mLevel[level]+"]"
            +"["+QTime::currentTime().toString("hh:mm:ss")+"]"
            +"["+file+"]"
            +"["+QString::number(line)+"]"
            +":"
            +str
            ;
    if(mlevel>=level){
        *mtextstream<<text<<endl;
        mtextstream->flush();
    }
}

到这一步日志大体框架就做好了。
现在我们遇到了第一个问题，如果程序在2023年7月31日运行，在8月1日结束，那么日志只会打印在20230731.log文件中，而没有8月1日及以后的日志。
解决方法：每次打印日志前判断一下日期有没有变动,如果有变动了，就关闭当前的日志，打开新的日志。

    if(mfile->fileName()!=getMfilename())
    {
        close();
        open();
    }

第二个问题：日志打印频率过快的话，日志文件很容易过大，如何限制日志文件大小。
解决方法：每次打印日志前判断一下日志大小是否高于配置文件设定，若大于设定，则关闭该文件并改名为old，打开新的日志文件。

    if(mfile->size()>=msize)
    {
        mfile->rename(mfile->fileName().insert(mfile->fileName().lastIndexOf("."),"_old"));
    }

五、多线程

日志要在子线程中打印，这一点没什么疑问的。在主线程大量读写文件io很容易让程序卡死，及其耗费资源。

LogUtils *LogUtils::GetInstance()
{
    if(mLogUtils==NULL)
    {
        std::thread t([=](){
            SetInstance(new LogUtils);
        });
        t.join();
    }
    return mLogUtils;
}

六、全部代码

logutils.h

#ifndef LOGUTILS_H
#define LOGUTILS_H
#include <QtGlobal>

#include <QFile>
#include <QObject>
#include <QTextStream>
#include <QThread>


#define LOGCONFIG_PATH "./logCfg.ini"

#define LOGERROR(str) SimpleLog::LogUtils::GetInstance()->log(SimpleLog::LogUtils::Level::LOG_ERROR,str,__FILE__,__LINE__)

#define LOGWARNING(str) SimpleLog::LogUtils::GetInstance()->log(SimpleLog::LogUtils::Level::LOG_WARNING,str,__FILE__,__LINE__)

#define LOGINFO(str) SimpleLog::LogUtils::GetInstance()->log(SimpleLog::LogUtils::Level::LOG_INFO,str,__FILE__,__LINE__)

#define LOGDEBUG(str) SimpleLog::LogUtils::GetInstance()->log(SimpleLog::LogUtils::Level::LOG_DEBUG,str,__FILE__,__LINE__)

namespace SimpleLog {
    class LogUtils : public QObject
    {
            Q_OBJECT
        public:
            explicit LogUtils(QObject *parent = nullptr);
            ~LogUtils();

            enum Level{
                LOG_ERROR,
                LOG_WARNING,
                LOG_INFO,
                LOG_DEBUG
            };
            const QStringList mLevel={
                "ERROR",
                "WARNING",
                "INFO",
                "DEBUG"
            };

            void log(LogUtils::Level level,QString str, QString file, uintmax_t line);

            void ReadConfig();

            static LogUtils *GetInstance();
            static void SetInstance(LogUtils *logUtils);

            void getThreadId();
            void open();
            void close();

            QString getMfilename();
            void setMfilename(QString value);

        private:
            QString mfilename;
            QFile *mfile;
            QTextStream *mtextstream;

            uint8_t mlevel=3;
            uintmax_t msize=20000;
            uint8_t moption=0;


        private:
            static LogUtils *mLogUtils;
            QThread *th;

        signals:

    };

}

#endif // LOGUTILS_H

logutils.cpp

#include "logutils.h"
#include <QDate>
#include <QDebug>
#include <QSettings>
#include <thread>

using namespace SimpleLog;

LogUtils *LogUtils::mLogUtils=NULL;

void LogUtils::log(LogUtils::Level level, QString str,QString file, uintmax_t line)
{
    if(mfile->size()>=msize)
    {
        mfile->rename(mfile->fileName().insert(mfile->fileName().lastIndexOf("."),"_old"));
    }
    if(mfile->fileName()!=getMfilename())
    {
        close();
        open();
    }

    if(mfile->isOpen()==false)
    {
        open();
    }
    QString text=
            "["+mLevel[level]+"]"
            +"["+QTime::currentTime().toString("hh:mm:ss")+"]"
            +"["+file+"]"
            +"["+QString::number(line)+"]"
            +":"
            +str
            ;
    if(mlevel>=level){
        *mtextstream<<text<<endl;
        mtextstream->flush();
    }
}

void LogUtils::ReadConfig()
{
    QSettings *config=new QSettings(LOGCONFIG_PATH,QSettings::IniFormat);
    mlevel=config->value("/LEVEL/level").toInt();
    qDebug()<< "日志等级:" << QString::number(mlevel);
    msize=config->value("/SIZE/size").toInt()*1000000;
    qDebug()<< "日志大小:" << QString::number(msize);
    moption=config->value("/OPTION/option").toInt();
    qDebug()<<"日志选项:"<<(moption==0?"覆盖":(moption==1?"追加":"未知"));
}

LogUtils *LogUtils::GetInstance()
{
    if(mLogUtils==NULL)
    {
        std::thread t([=](){
            SetInstance(new LogUtils);
        });
        t.join();
    }
    return mLogUtils;
}

void LogUtils::SetInstance(LogUtils *logUtils)
{
    mLogUtils = logUtils;
}

void LogUtils::getThreadId()
{
    qDebug()<<"now LogUtils ThreadId="<<QThread::currentThreadId();
}

void LogUtils::open()
{
    mfilename=getMfilename();
    mfile=new QFile(mfilename);
    switch (moption) {
    case 0:
    {
        /* 覆盖模式 */
        mfile->open(QIODevice::Text | QIODevice::WriteOnly);
    }
        break;
    case 1:
    {
        /* 追加模式 */
        mfile->open(QIODevice::Text | QIODevice::WriteOnly | QIODevice::Append);
    }
        break;
    default:
    {
        return;
    }
        break;

    };
    if( mfile->isOpen()== true)
    {
        mtextstream=new QTextStream(mfile);
        mtextstream->setCodec("UTF-8");

        *mtextstream<<mfilename<<QString("打开成功")<<endl;
        mtextstream->flush();
        qDebug()<<mfilename<<"打开成功";
    }
    else
    {
        qDebug()<<mfilename<<"打开失败";
        return;
    }
}

void LogUtils::close()
{
    delete mtextstream;
    mfile->close();
}

QString LogUtils::getMfilename()
{
    QString filename=QDate::currentDate().toString("yyyyMMdd.log");
    setMfilename(filename);
    return mfilename;
}

void LogUtils::setMfilename(QString value)
{
    mfilename = value;
}

LogUtils::LogUtils(QObject *parent)
{
    qDebug()<<"new LogUtils";
    ReadConfig();
    open();
    getThreadId();
}

LogUtils::~LogUtils()
{

}

main.cpp

#include <QCoreApplication>
#include <QDate>
#include <QThread>
#include <QDebug>
#include "logutils.h"
#include <thread>
int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);
    qDebug()<<"Main ThreadId:"<<QThread::currentThreadId();
    while(1){
        LOGERROR(QTime::currentTime().toString("hhmmss"));
        LOGWARNING(QTime::currentTime().toString("hhmmss"));
        LOGINFO(QTime::currentTime().toString("hhmmss"));
        LOGDEBUG(QTime::currentTime().toString("hhmmss"));
//        QThread::sleep(1);
    }
    return a.exec();
}
虚拟内存会梦见进程调度嘛？
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
C++11多线程异步日志系代码统最佳实现
QtCompany的博客
04-26 492
这个代码可以作为一个基础框架，根据实际需求进行进一步的优化和修改。例如，可以添加更多的日志级别、写入不同的日志文件等。支持不同级别的日志记录，包括 TRACE、DEBUG、INFO、ERROR 和 FATAL；使用C++11标准库的线程、互斥锁、条件变量等多线程编程工具实现异步日志；写入日志文件的操作在独立的日志线程中执行，避免阻塞主线程；日志记录器和异步日志器分离，可扩展性更强。支持多个线程同时写入日志文件；
【Qt 学习笔记】如何在Qt中打印日志 | qDebug的使用 | Assistant的使用
小黄鸭的博客
04-03 1020
QDebug类提供了一个方便的打印日志的方法，可以将日志输出到控制台、文件或其他输出设备。qDebug()函数类似于printf()函数，可以接受多个参数，并按照指定的格式打印日志。除了使用qDebug函数输出调试信息之外，还可以使用qWarning、qCritical、qFatal等函数输出不同级别的错误信息。上面的代码中，我们包含了QDebug的头文件，并在主函数中使用了qDebug函数输出了一个字符串和一个整数。中提到Qt中出现乱码的情况，在使用C++的方式打印时会出现乱码的情况，
Qt5.14.2 揭秘Qt日志神器高效诊断程序潜在隐疾
w风雨无阻w的专栏
04-03 1143
通过QLoggingCategory::installMessageHandler函数，可以自定义日志输出的处理回调函数，将日志信息重定向写入到文件中，而不是直接输出到控制台。通过这种方式，我们就可以将Qt程序的日志信息持久化存储到文件中，不再依赖于控制台输出，从而方便了日志的收集和管理。总之，在开发Qt应用的过程中，我们需要时刻保持对代码"内疾外馁"的警惕，及时发现并排查问题。这个函数会在Qt输出日志时被调用，我们在函数内部打开了一个名为log.txt的文件，并将日志信息以特定的格式写入到文件中。
Qt之qInstallMessageHandler（输出详细日志）
weixin_34306593的博客
07-06 1416
简述 安装之前已定义的消息处理程序，返回一个指向前一个消息处理程序。 消息处理程序是一个函数，用于打印调试信息、警告信息、严重错误和致命的错误的消息。Qt库（debug模式）包含成百上千的警告信息打印，当发生内部错误时（通常是无效的函数参数）。Qt在release模式下构建还包含这些警告，除非在编译时设置QT_NO_WARNING_...
Qt5.9学习笔记-事件(三) 多线程和事件处理
忆_恒心的博客
05-06 745
多线程和事件处理是Qt框架中非常重要的概念，能够帮助我们更好地实现复杂的功能，并提高应用程序的性能。本文将从理解多线程和事件处理、跨线程事件的发送和处理两个方面进行介绍。
Qt中第三方日志库QsLog的基本配置和使用详解
Wendy的博客
03-22 6981
目录一、QsLog基本介绍二、QsLog的使用方法2.1 方法一——在Mingw编译器中的编译和使用2.2 方法二——在Visual Studio编译器中的使用三、项目基本配置四、UI界面设计五、主程序实现5.1 widget.h5.2 widget.cpp六、效果演示 一、QsLog基本介绍 qslog的下载地址：https://github.com/victronenergy/QsLog。 QsLog是一个基于Qt的QDebug类的易于使用的记录器。QsLog是在麻省理工学院许可下以开源形式发布的。 Q
Qt的简易日志库实现及封装
pegasusliuyong的专栏
11-29 369
Qt的简易日志库实现及封装用于QT的一个简易日志功能模块封装。算不上强大和多高的性能，但是足够简单小巧。用于记录日志到文件够用了。单独的一个文件模块，使用时直接引入源码。想要其他功能，直接改代码即可。C++的下的日志库有很多，如log4cpp、Easylogging++，eplog,g3log,Qt下也有log4qt。还有简单小巧的QsLog，它是一个基于Qt的轻量级开源日志库。
qt中使用日志系统，自定义日志彩色输出，qt日志写入文件，自定义qt日志格式，同时提供Qt日志重定向功能（将qDebug信息输出到界面控件）
IT_CREATE的博客
08-13 3307
一、介绍 在qt中要使用qt自带的日志系统我们都知道实现回调函数QtMessageHandler，再用qInstallMessageHandler函数进行注册： // 注册日志处理 qInstallMessageHandler(); 同时在pro文件中加入： DEFINES += QT_MESSAGELOGCONTEXT # 日志 题外话：一般在商业项目中，我们可能不会使用qt的日志系统，而是会采用第三方的日志系统，比如常用语java后端的log4j，在qt中有Log4Qt，这篇文章很详
基于Qt和C++实现的日志重定向输出+源码
最新发布
04-15
基于Qt和C++实现的日志重定向输出+源码 日志重定向输出，包含如下功能： 支持动态启动和停止。 支持日志存储的目录。 支持网络发出打印日志。 支持输出日志上下文信息比如所在代码文件、行号、函数名等。 支持设置...
基于Qt C++ 的控制系统软件
11-09
现成控制软件，使用QT开发。用于工业控制，稍加改动就可以使用过。通讯，配置，曲线显示，log日志，json解析，UI使用qss加载等。
一个C++基于Qt编写的写日志文件的工具类源码.zip
10-27
一个C++基于Qt编写的写日志文件的工具类源码.zip
QT写日志类实现实例
01-30
//写日志，并缩进n个空格(默认2) int WriteLog(const char *sLog,int Retract_n=Retract_L1); //写通信日志 int WriteTransmitLog(int transmit_way,const unsigned char *Data_in, int in_Len); //写头 int WriteCall(const char * szApiName); //写输入参数 int WriteInParam(const char *szInParamList); //写输出参数 int WriteOutParam(const char *szOutParamList); //写尾 int WriteReturn(const char *szApiName,int iReturn); //写尾并把缓存写入文件 int WriteReturn_And_ToFile(const char *szApiName,int iReturn); //清空缓冲区日志 int ClearBuff(); //缓冲区日志写入文件后清空 int BuffToFile(); //直接写入文件 int WriteFile(const char *szText,bool bIfTempFile); //发动删除过期文件进程 int DelOldFile(); //配置（默认配置请查看宏定义） //设置目录 int SetDir(const char *szDir); //设置文件名 int SetFileName(const char *szFileName); //设置至少磁盘空间 int SetDiskFreeSpace(unsigned long long lDiskFreeSpace); //设置最大文件大小 int SetFileSizeMax(unsigned int uiFileSizeMax); //设置最大保存天数 int SetBackupDays(unsigned int uiBackupDays);
QT4.8 创建线程及日志定期删除
12-13
简单的线程创建，可据此实现多线程任务，以及定期日志删除
自己实现的Qt日志记录系统
03-05
原理：重定向qDebug、qInfo、qWarning、qCritical、qFatal等宏，输出到txt文件。如果需要输出到Qt控件上，则需要使用Qt提供的反射机制。
基于c++/qt的日志测试程序
05-22
基于c++/qt的日志测试程序
毕设项目：基于C++和Qt实现的简易好看的日志系统.zip
08-27
本资源中的源码都是经过本地编译过可运行的，下载后按照文档配置好环境就可以运行。资源项目源码系统完整，内容都是经过专业老师审定过的，能够满足基本的学习、使用参考需求，如果有需要的话可以放心下载使用。
Qt 自定义日志类
萧海的博客
04-29 1978
一、前言 C++ 中比较不错的日志工具有 log4cxx，log4qt 等，但是它们都不能和 qDebug(), qInfo() 等有机的结合在一起，所以在 Qt 中使用总觉得不够舒服，感谢 Qt 提供了 qInstallMessageHandler() 这个函数，使用这个函数可以安装自定义的日志输出处理函数，把日志输出到文件，控制台等，具体的使用可以查看 Qt 的帮助文档。 本文主要是介绍使用 qInstallMessageHandler() 实现一个简单的日志工具，例如调用 qDebug() <&
使用C++和QT实现日志系统
KanHai8080的博客
12-12 1184
从0到1，手把手带你使用QT的qInstallMessageHandler函数结合qDebug，qInfo实现自定义的日志系统，支持输出日志到文件和控制台，支持自动检测日志文件大小，支持自动更新日志文件修改日期，自动备份，自动删除一个月前的日志文件，支持多线程程序， 支持扩展，可输出日志到数据库，网络，或服务器，支持扩展，可使用config文件进行配置
QT C++ 显示不同颜色标志日志信息和保存日志信息本地(.txt)
进入一个二进制世界
02-22 584
Q_OBJECTpublic:Warning,Critical//显示日志接口。
c++设计模式 基于qt
02-06
C 设计模式在基于qt的应用中起着重要作用。Qt是一个跨平台的C++图形用户界面应用程序开发框架，通过其强大的功能和丰富的类库，能够帮助开发人员快速开发出高质量的应用程序。 在Qt中，设计模式可以帮助我们更好地组织和管理代码结构，提高代码的可重用性和可维护性。常用的设计模式包括但不限于工厂模式、观察者模式、单例模式等。 工厂模式可以帮助我们封装对象的创建过程，降低耦合度，提高代码的可扩展性。在Qt中，通过工厂模式可以创建各种各样的对象，比如窗口、对话框、控件等。 观察者模式可以帮助我们实现对象之间的松耦合关系，当被观察对象发生变化时，观察者可以及时更新。在Qt中，观察者模式被广泛应用于信号与槽的机制，使得各个对象之间能够有效地进行通信与交互。 单例模式可以确保一个类只有一个实例对象，并提供一个全局访问点。在Qt中，通过单例模式可以实现全局共享的对象，比如应用程序配置、日志记录器等。 总之，C设计模式在基于Qt的应用中，可以帮助我们更好地组织代码，提高代码的质量和可维护性，是开发高质量应用的重要利器。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

虚拟内存会梦见进程调度嘛？

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值