使用C++和QT實現Log自定義日誌系統

来源:https://www.cnblogs.com/kanhai1024/archive/2023/12/12/17897560.html
-Advertisement-
Play Games

從0到1，手把手帶你使用QT的qInstallMessageHandler函數結合qDebug，qInfo實現自定義的日誌系統，支持輸出日誌到文件和控制台，支持自動檢測日誌文件大小，支持自動更新日誌文件修改日期，自動備份，自動刪除一個月前的日誌文件，支持多線程程式， 支持擴展，可輸出日誌到資料庫，網... ...


MyLog

說明

image

  • 使用QT的qInstallMessageHandler函數結合qDebug，qInfo實現自定義的日誌系統
  • 輸出日誌到文件和控制台
  • 自動檢測日誌文件大小
  • 自動更新日誌文件修改日期
  • 自動備份
  • 自動刪除一個月前的日誌文件
  • 支持多線程程式
  • 支持擴展，可輸出日誌到資料庫，網路，或伺服器
  • 支持擴展，可使用config文件進行配置

警告

  • 註：博主所有資源永久免費，若有幫助，請點贊轉發是對我莫大的幫助
  • 註：博主本人學習過程的分享，引用他人的文章皆會標註原作者
  • 註：本人文章非盈利性質，若有侵權請聯繫我刪除
  • 註：獲取資源或者咨詢問題請聯繫Q：2950319782
  • 註：博主本人很菜，文章基本是二次創作，大佬請忽略我的隨筆
  • 註：我會一步步分享實現的細節，若仍有問題聯繫我

開發環境

  • win10系統
  • qtcreator4.11.1
  • C++11
  • QT5.14.2

GitHub

  • GitHub下 的Log文件
  • 若不能訪問GitHub，源碼的資源包會隨文章同步發佈，免費下載
  • 資源包較GitHub更新不及時，請諒解

問題解決

需求

  • 輸出日誌信息到日誌文件
  • 更新日誌的修改日期
  • 日誌文件超過一定大小備份老的創建新的
  • 刪除一個月前的日誌文件

結構

image

image

思路

  • 隨便創建一個widget程式，放個測試按鈕
  • 主要思路是使用 qInstallMessageHandler()接管qDebug(), qWarning()等調試信息，然後將信息流存儲至本地日誌文件，並管理日誌文件
  • 先創建一個MyLog的類，在這裡面我們實現自定義的日誌系統
  • 這裡依然是使用單例實現，整個程式的日誌應該只能有一個
  • 首先實現單例getInstance獲取MyLog的實例
  • 下麵處理MyLog的構造函數，每一次啟動日誌系統，都要先設置日誌文件的路徑，然後更新修改日期，然後打開並備份老的日誌文件，打開之後，每10分鐘刷新日誌文件，每1秒都將信息輸出到日誌，
  • 下麵實現這個打開並備份老的日誌文件的功能openAndBackupLogFile,這裡我們的日誌文件以天為單位，先處理一天內多次啟動日誌系統的情況，以追加的方式寫入到日誌文件里即可；如果程式運行的時候，日誌系統的日期和程式運行日期不統一，同步日誌日期為程式運行日期，生成新的日期日誌，並且備份老的日誌
  • 然後實現處理日誌文件過大的問題，只要日誌文件超限，備份老的，創建新的即可
  • 然後實現自動刪除超時的日誌文件，每次啟動日誌系統的時候，以當前時間為基準，計算出1個月前的時間，遍歷日誌目錄下的所有日誌文件，因為日誌文件都以時間命名，刪除超過1個月的日誌文件即可
  • 最後，我們只需要處理信息函數即可，捕獲系統中的各種輸出信息，輸出到文件即可

關鍵代碼

MyLog.h

#ifndef MYLOG_H
#define MYLOG_H

#include <iostream>
#include <QDateTime>
#include <QMutexLocker>
#include <QDir>
#include <QTimer>
#include <QTextStream>


//最大保存文件大小
const int g_logLimitSize = 5;

class MyLog
{
public:
    MyLog();
    ~MyLog();

    static MyLog* getInstance();

    //消息處理函數
    static void messageHandler(QtMsgType type,
                                   const QMessageLogContext& context,
                                   const QString& msg);
public:
    //打開並備份之前的日誌文件
    void openAndBackupLogFile();
    void checkLogFiles();
    void autoDeleteLog();
    //安裝消息處理函數
    void installMessageHandler();

    //卸載消息處理函數，並釋放資源
    void uninstallMessageHandler();
private:
    //日誌文件夾目錄
    QDir logDir;
    //重命名日誌文件使用的定時器
    QTimer renameLogFileTimer;
    //刷新輸出到日誌文件的定時器
    QTimer flushLogFileTimer;
    //日誌文件的創建時間
    QDate logFileCreateDate;

    //日誌文件
    static QFile* logFile;
    //輸出日誌
    static QTextStream* logOut;
    //日誌鎖
    static QMutex logMutex;
    static QScopedPointer<MyLog> self;
};

#endif // MYLOG_H

MyLog.cpp

#include "mylog.h"
#include<QDebug>
#include<QTextCodec>

#define LOG 1
//初始化靜態變數
QMutex MyLog::logMutex;
QFile* MyLog::logFile = NULL;
QTextStream* MyLog::logOut = NULL;
QScopedPointer<MyLog> MyLog::self;

//定義單例模式
MyLog* MyLog::getInstance()
{
    //還沒有創建實例
    if(self.isNull())
    {
        //加把鎖,只能有一個線程訪問
        static QMutex mutex;
        //自動加解鎖
        QMutexLocker locker(&mutex);
        //再次判斷有沒有實例，防止等待的時間中有線程獲取到實例了
        if(self.isNull())
        {
            self.reset(new MyLog);
        }
    }
    return self.data();

}

MyLog::MyLog()
{
    //設置日誌文件夾的路徑，./exe
    logDir.setPath("log");
    //獲取日誌的絕對路徑
    QString logPath = logDir.absoluteFilePath("today.log");

    //獲取日誌文件創建的時間
    //保存日誌文件最後的修改時間
    logFileCreateDate = QFileInfo(logPath).lastModified().date();

    //打開並備份日誌文件
    openAndBackupLogFile();

    //每10分鐘檢查一次日誌文件創建的時間
    renameLogFileTimer.setInterval(1000 * 60 *1000);
    renameLogFileTimer.start();

    //處理超時事件，10分鐘重覆一次
    QObject::connect(&renameLogFileTimer,&QTimer::timeout,[this](){
        QMutexLocker locker(&MyLog::logMutex);
        openAndBackupLogFile();
        checkLogFiles();
        autoDeleteLog();
    });

    //定時刷新日誌輸出到日誌文件，1秒1刷新
    flushLogFileTimer.setInterval(1000);
    flushLogFileTimer.start();

    QObject::connect(&flushLogFileTimer,&QTimer::timeout,[](){
#if LOG
        // 測試不停地寫入當前時間到日誌文件
        qDebug() << QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss");
#endif
        //刷新
        QMutexLocker locker(&MyLog::logMutex);
        if(NULL != logOut)
        {
            logOut->flush();
        }
    });
}

MyLog::~MyLog()
{
    if(NULL != logFile)
    {
        logFile->flush();
        logFile->close();
        logOut = NULL;
        logFile = NULL;
    }
}

//打開並備份之前的日誌文件
void MyLog::openAndBackupLogFile()
{
    //有可能一天多次打開日誌文件，使用追加的方式打開
    //目錄不存在，創建目錄
    if(!logDir.exists())
    {
        logDir.mkpath(".");
    }
    //log.txt的路徑
    QString logPath = logDir.absoluteFilePath("today.log");

    //程式啟動的時候，logfile為空
    if(logFile == NULL)
    {
        //創建新的
        logFile = new QFile(logPath);
        //只寫，追加的方式打開日誌文件
        //成功，創建文本流對象與日誌文件關聯，嚮日志文件寫內容
        logOut = (logFile->open(QIODevice::WriteOnly | QIODevice::Text |QIODevice::Append)) ? new QTextStream(logFile) : NULL;

        if(logOut != NULL)
        {
            //設置編碼格式
            logOut->setCodec("UTF-8");
        }

        //日誌文件第一次創建，創建日期無效，設置為修改日期
        if(logFileCreateDate.isNull())
        {
            logFileCreateDate = QDate::currentDate();
        }
    }

    //程式運行的時候，創建日期不是當前日期，更新日期，重命名，備份老的並生成新的log.txt
    if(logFileCreateDate != QDate::currentDate())
    {
        //先刷新緩衝區，確保內容先輸出到文件里
        logFile->flush();
        logFile->close();

        //更新日期到備份文件
        QString backUpLogPath = logDir.absoluteFilePath(logFileCreateDate.toString("yyyy-MM-dd.log"));;
        //備份原來的日誌
        QFile::copy(logPath,backUpLogPath);
        //刪除原來的日誌文件
        QFile::remove(logPath);

        //創建新的log.txt，進行更新
        //只寫，截斷的方式打開日誌
        logFile = new QFile(logPath);
        logOut = (logFile->open(QIODevice::WriteOnly | QIODevice::Text | QIODevice::Truncate)) ? new QTextStream(logFile) : NULL;
        //更新為修改時間
        logFileCreateDate = QDate::currentDate();
        if(logOut != NULL)
        {
            logOut->setCodec("UTF-8");
        }
    }
}

//檢查文件大小
void MyLog::checkLogFiles()
{
    //日誌文件大小超過5m，備份並重新創建日誌文件
    if(logFile->size() > 1024* g_logLimitSize)
    {
        //清空緩衝
        logFile->flush();
        logFile->close();

        QString logPath = logDir.absoluteFilePath("today.log");
        //備份老的日誌文件
        QString backUplogPath = logDir.absoluteFilePath(logFileCreateDate.toString("yyyy-MM-dd.log"));
        QFile::copy(logPath,backUplogPath);
        QFile::remove(logPath);

        //創建新的日誌文件
        logFile = new QFile(logPath);
        logOut = (logFile->open(QIODevice::WriteOnly | QIODevice::Text | QIODevice::Truncate)) ? new QTextStream(logFile) :NULL;
        logFileCreateDate = QDate::currentDate();
        if(logOut != NULL)
        {
            logOut->setCodec("UTF-8");
        }
    }
}

//自動刪除超過時間的日誌文件
void MyLog::autoDeleteLog()
{
    //當前時間
    QDateTime now = QDateTime::currentDateTime();

    //基準，30天前
    QDateTime dateTime1 = now.addDays(-30);
    QDateTime dateTime2;

    QString logPath = logDir.absoluteFilePath("today.log");
    //打開日誌目錄
    QDir dir(logPath);
    //獲取目錄下的所有文件信息列表
    QFileInfoList fileList = dir.entryInfoList();
    foreach(QFileInfo f, fileList)
    {
        //跳過文件名為空的文件
        if(f.baseName() == "")
        {
            continue;
        }

        //將文件名解析為日期對象
        dateTime2 = QDateTime::fromString(f.baseName(),"yyyy-MM-dd");
        //大於30天，刪除
        if(dateTime2 < dateTime1)
        {
            dir.remove(f.absoluteFilePath());
        }
    }
}


//定義消息處理函數
void MyLog::messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg)
{
    QMutexLocker locker(&MyLog::logMutex);
        QString level;

        switch (type) {
        case QtDebugMsg:
            level = "DEBUG";
            break;
        case QtInfoMsg:
            level = "INFO";
            break;
        case QtWarningMsg:
            level = "WARN";
            break;
        case QtCriticalMsg:
            level = "ERROR";
            break;
        case QtFatalMsg:
            level = "FATAL";
            break;
        default:
            break;
        }

#if defined (Q_OS_WIN)
        QByteArray localMsg = QTextCodec::codecForName("GB2312")->fromUnicode(msg);
#else
        QByteArray localMsg = msg.toLocal8Bit();
#endif

        //輸出到控制台
        std::cout << std::string(localMsg) << std::endl;
        if(NULL == MyLog::logOut)
        {
            return;
        }

        //輸出到日誌文件
        //獲取文件名，去掉路徑
        QString fileName = context.file;
        int index = fileName.lastIndexOf(QDir::separator());
        fileName = fileName.mid(index + 1);

        //寫入日誌信息
        (*MyLog::logOut) << QString("%1 - [%2] (%3:%4, %5): %6\n")
                                        .arg(QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss"))
                                        .arg(level)
                                        .arg(fileName)
                                        .arg(context.line)
                                        .arg(context.function)
                                        .arg(msg);
}

//安裝
void MyLog::installMessageHandler()
{
    qInstallMessageHandler(MyLog::messageHandler);
}

//卸載
void MyLog::uninstallMessageHandler()
{
    qInstallMessageHandler(NULL);
}
If you need inspiring words,don't do it
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • React Hooks 鉤子特性
    人在身處逆境時，適應環境的能力實在驚人。人可以忍受不幸，也可以戰勝不幸，因為人有著驚人的潛力，只要立志發揮它，就一定能渡過難關。 Hooks 是 React 16.8 的新增特性。它可以讓你在不編寫 class 組件的情況下使用 state 以及其他的 React 特性。 React Hooks 表 ...
  • PWA 離線方案研究報告
    本文並不是介紹如何將一個網頁配置成離線應用並支持安裝下載的。研究PWA的目的僅僅是為了保證用戶的資源可以直接從本地載入，來忽略全國或者全球網路質量對頁面載入速度造成影響。當然，如果頁面上所需的資源，除了資源文件外並不需要任何的網路請求，那它除了不支持**安裝到桌面**，已經算是一個離線應用了。 ...
  • 元素定位position
    static：靜態定位（預設）。依據文檔流定位。 relative：相對定位。以自身為基準，設置坐標（left、top、right、bottom），不脫離文檔流。 absolute：絕對定位。以父元素為基準，設置坐標（left、top、right、bottom），脫離文檔流。 fixed：固定定位。... ...
  • NestJs系列之使用Vite搭建項目
    介紹 在使用nest創建項目時,預設使用webpack進行打包,有時候啟動項目需要1-2分鐘。所以希望採用vite進行快速啟動項目進行開發。 本文主要使用NestJs、Vite和swc進行配置。文章實操較多，概念性的東西可訪問對應的官方文檔進行瞭解。tips: 個人認為概念性的東西,在文章中指出。對 ...
  • 面向對象編程，看這篇就夠了
    面向對象編程是一種強大而靈活的編程範式，它可以幫助我們更好地組織和管理代碼，提高代碼的可讀性和可維護性，這使得它特別適合用在大型工程項目中。然而，我們也需要註意其可能帶來的問題，尤其是在併發和複雜系統中。 ...
  • Windows下獲取設備管理器列表信息-setupAPI
    背景及問題： 在與硬體打交道時，經常需要知道當前設備連接的硬體信息，以便連接正確的硬體，比如串口通訊查詢連接的硬體及埠，一般手工的方式就是去設備管理器查看相應的信息，應用程式如何讀取這一部分信息呢，Windows下的SetupAPI系列就可以解決這個問題 示常式序 #include<Windows ...
  • C 語言函數：入門指南
    C 語言中的函數聲明和定義 您可以通過以下方式創建並調用函數： // 創建一個函數 void myFunction() { printf("我剛被執行了!"); } int main() { myFunction(); // 調用函數 return 0; } 一個函數包括兩個部分： 聲明：函數名稱、 ...
  • Django學習(三) 之 模板中標簽的使用
    寫在前面 最近看到稀土掘金在搞2023年終總結徵文活動，一直想嘗試投稿試試，周末我就花了近一下午時間寫完初稿，然後周一、周二完成精讀再改稿，感覺OK，昨晚凌晨第一時間在稀土掘金投稿。 結果，又發生了同樣的事情。 同樣的文章，在博客園上、公號上閱讀量很OK，在稀土掘金上就上不來。 這應該是我博客園第四 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類