Qt/C++ - Урок 050. Реєстрація подій програми Qt у текстовий файл

log, qDebug, Логирование, qInfo, Logger, file, qWarning, qFatal

Всі Qt-розробники використовують qDebug(), коли налагоджують програму, написану на Qt, але також є макроси qInfo(), qWarning(), qCritical() і qFatal() (який на момент написання статті був помилково і не працював).

За допомогою цих подій, ви можете розділити помилки за рівнями значущості та застосувати фільтри, для поділу того, які помилки потрібно виводити, а які ні.

Для перенаправлення повідомлень про помилки в текстовий файл, вам необхідно встановити CallBack-функцію обробник у програму. Для цього використовується функція qInstalMessageHandler .

Сигнатура обробника має виглядати так:

void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg);

Через цю функцію ми будемо отримувати такі дані:

1. QtMsgType type - Тип повідомлення
2. QtInfoMsg
3. QtDebugMsg
4. QtWarningMsg
5. QtCriticalMsg
6. QtFatalMsg
7. QMessageLogContext &context - контекст повідомлення, найкорисніше в якому це категорія повідомлення. Це може бути корисним, коли необхідно визначити розташування повідомлення в коді, тобто з яких компонентів ми отримуємо дані або до якого типу взаємодії відноситься повідомлення.
8. QString &msg - повідомлення про помилку, що передається.

Додаткові категорії - QLoggingCategory

Додаткові категорії є об'єктами класу QLoggingCategory. Може бути кілька підходів до роботи з категоріями, наприклад, ми можемо створити категорію об'єкта в якомусь класі та передати його до повідомлення про помилку:

QLoggingCategory  m_category("Test");
qDebug(m_category) << "Check it";

Отримаємо наступний висновок:

Test: Check it

Незручність даного підходу у тому, що кілька класів може мати одні й самі категорії помилок, але у кожному класі необхідно створювати одні й самі категорії. Тому скористаємося іншим підходом. А саме реєстрацією категорії через макрос.

LoggingCategories.h

Ми оголосимо чотири категорії в даному заголовному класі.

#ifndef LOGGER_H
#define LOGGER_H

#include <QLoggingCategory>

Q_DECLARE_LOGGING_CATEGORY(logDebug)
Q_DECLARE_LOGGING_CATEGORY(logInfo)
Q_DECLARE_LOGGING_CATEGORY(logWarning)
Q_DECLARE_LOGGING_CATEGORY(logCritical)

#endif // LOGGER_H

LoggingCategories.cpp

І надамо імена даним категоріям

#include "LoggingCategories.h"

Q_LOGGING_CATEGORY(logDebug,    "Debug")
Q_LOGGING_CATEGORY(logInfo,     "Info")
Q_LOGGING_CATEGORY(logWarning,  "Warning")
Q_LOGGING_CATEGORY(logCritical, "Critical")

Використання LoggingCategories

Для того, щоб застосувати дані категорії, ви повинні підключити заголовний файл до файлу, де будуть використовуватися дані категорії. І потім використовувати їх:

qDebug(logDebug()) << "Check it";

Отримаємо наступний висновок:

Debug: Check it

Установка обробника

Для демонстрації роботи обробника скористаємося графічним додатком, де буде чотири кнопки.

• Відлагоджувати
• Інформація
• Увага
• Критично

В обробнику кожної з кнопок будуть викликатись відповідні макроси логування подій та застосовуватись відповідні категорії, перераховані вище. Вікно програма створена через графічний дизайнер і виглядає наступним чином.

mainwindow.h

#ifndef MAINWINDOW_H
#define MAINWINDOW_H

#include <QMainWindow>

namespace Ui {
class MainWindow;
}

class MainWindow : public QMainWindow
{
    Q_OBJECT

public:
    explicit MainWindow(QWidget *parent = 0);
    ~MainWindow();

private slots:
    void on_debugButton_clicked();
    void on_infoButton_clicked();
    void on_warningButton_clicked();
    void on_criticalButton_clicked();

private:
    Ui::MainWindow *ui;
};

#endif // MAINWINDOW_H

mainwindow.cpp

#include "mainwindow.h"
#include "ui_mainwindow.h"
#include <QDebug>

#include "LoggingCategories.h"

MainWindow::MainWindow(QWidget *parent) :
    QMainWindow(parent),
    ui(new Ui::MainWindow)
{
    ui->setupUi(this);
}

MainWindow::~MainWindow()
{
    delete ui;
}

void MainWindow::on_debugButton_clicked()
{
    qDebug(logDebug()) << "Debug Button";
}

void MainWindow::on_infoButton_clicked()
{
    qInfo(logInfo()) << "Info Button";
}

void MainWindow::on_warningButton_clicked()
{
    qWarning(logWarning()) << "Warning Button";
}

void MainWindow::on_criticalButton_clicked()
{
    qCritical(logCritical()) << "Critical Button";
}

main.cpp

#include "mainwindow.h"
#include <QApplication>
#include <QFile>
#include <QDir>
#include <QScopedPointer>
#include <QTextStream>
#include <QDateTime>
#include <QLoggingCategory>

// Умный указатель на файл логирования
QScopedPointer<QFile>   m_logFile;

// Объявляение обработчика
void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg);

int main(int argc, char *argv[])
{
    QApplication a(argc, argv);

    // Устанавливаем файл логирования,
    // внимательно сверьтесь с тем, какой используете путь для файла
    m_logFile.reset(new QFile("C:/example/logFile.txt"));
    // Открываем файл логирования
    m_logFile.data()->open(QFile::Append | QFile::Text);
    // Устанавливаем обработчик
    qInstallMessageHandler(messageHandler);

    MainWindow w;
    w.show();

    return a.exec();
}

// Реализация обработчика
void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg)
{
    // Открываем поток записи в файл
    QTextStream out(m_logFile.data());
    // Записываем дату записи
    out << QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss.zzz ");
    // По типу определяем, к какому уровню относится сообщение
    switch (type)
    {
    case QtInfoMsg:     out << "INF "; break;
    case QtDebugMsg:    out << "DBG "; break;
    case QtWarningMsg:  out << "WRN "; break;
    case QtCriticalMsg: out << "CRT "; break;
    case QtFatalMsg:    out << "FTL "; break;
    }
    // Записываем в вывод категорию сообщения и само сообщение
    out << context.category << ": "
        << msg << endl;
    out.flush();    // Очищаем буферизированные данные
}

Підсумок

В результаті логування подій буде створено файл C:\example\logFile.txt (Примітка. Але якщо перед запуском програми папка C:\example вже існувала).

При натисканні кнопок у вікні програми вміст файлу буде виглядати так:

2016-06-04 17:05:57.439 DBG Debug: Debug Button
2016-06-04 17:05:57.903 INF Info: Info Button
2016-06-04 17:05:58.367 WRN Warning: Warning Button
2016-06-04 17:05:58.815 CRT Critical: Critical Button

Завантажити Qt програму з логуванням у текстовий файл

Відеоурок