Проект iMpos. Часть 003. Настройка логирования. Создание, чтение базы настроек приложения

database, QSQLITE, Qt, Logs

Настройка логирования

Поддержка логирования в приложении позволяет как минимум решать следующие задачи:

  • фиксирование действий пользователя в приложении;
  • фиксирование выполнения операций с данными;
  • фиксирование критических событий при работе программы.

И вообще чтение логов волнующий и захватывающий процесс при обеспечении поддержки работы программного обеспечения.

Организацию логирования событий приложения я позаимствовал из этой статьи . Немного модифицировав Реализацию обработчика для того чтобы сообщения дублировались в окно консоли.

Добавляем в проект регистрацию категорий логирования через макрос.

loggingcategories.h

#ifndef LOGGINGCATEGORIES_H
#define LOGGINGCATEGORIES_H

#include <QLoggingCategory>

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

#endif // LOGGINGCATEGORIES_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")

Изменяем main.cpp.

main.cpp

#include "mainwindow.h"
#include "LoggingCategories/loggingcategories.h"
#include <QApplication>
#include <QFile>
#include <QDateTime>

// Умный указатель на файл логирования
static 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("iMpos.log"));
   // Открываем файл логирования
   m_logFile.data()->open(QFile::Append | QFile::Text);
   // Устанавливаем обработчик
   qInstallMessageHandler(messageHandler);
   qInfo(logInfo()) << "Запуск программы.";


   MainWindow w;
   w.show();

   return a.exec();
}

void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg)
{
   // Открываем поток записи в файл
   QTextStream out(m_logFile.data());
   QTextStream console(stdout);


   // Записываем дату записи
   out << QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss.zzz ");
   // По типу определяем, к какому уровню относится сообщение
   switch (type)
   {
#ifdef QT_DEBUG
   case QtInfoMsg:     out << "[INF] "; console << "Info:     " << msg << endl; break;
   case QtDebugMsg:    out << "[DBG] "; console << "Debug:    " << msg << endl; break;
   case QtWarningMsg:  out << "[WRN] "; console << "Warning:  " << msg << endl; break;
   case QtCriticalMsg: out << "[CRT] "; console << "Critical: " << msg << endl; break;
   case QtFatalMsg:    out << "[FTL] "; console << "Fatality: " << msg << endl; break;
#else
   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;
#endif

   }
   // Записываем в вывод категорию сообщения и само сообщение
   out << context.category << ": " << msg << endl;
   // Очищаем буферизированные данные
   out.flush();
   console.flush();
}

Запускаем программу. В консоли отображаются сообщения логирования.

В папке собрки проекта создался файл iMpos.log

Создание, чтение базы данных настроек приложение

Для хранения настроек приложения и прочих данных будем использовать базу данных SQLite. Как только начинаем использовать базы данных необходимо добавить в файл проекта параметр qmake QT += sql.

QT       += core gui sql

Добавляем в проект класс DataBases
databases.h

#ifndef DATABASES_H
#define DATABASES_H

#include <QObject>

class DataBases : public QObject
{
    Q_OBJECT
public:
    explicit DataBases(QObject *parent = nullptr);
    bool connectOptions(); //Подключение к базе данный опций приложения

signals:

public slots:
};

#endif // DATABASES_H

databases.cpp

#include "databases.h"
#include "LoggingCategories/loggingcategories.h"

#include <QFile>
#include <QSqlQuery>
#include <QSqlError>

#define DATABASE_NAME "iMpos.opt"
#define DATABASE_HOSTNAME "iMpos"

DataBases::DataBases(QObject *parent) : QObject(parent)
{

}

bool DataBases::connectOptions()
{
    bool result;

    //Проверяемналичие файла базы данных
    if(QFile(DATABASE_NAME).exists()){
        //Файл существует создаем подключение к базе данных
        qInfo(logInfo()) << "Открываем файл настроек приложения.";

        QSqlDatabase db = QSqlDatabase::addDatabase("QSQLITE","options");
        db.setHostName(DATABASE_HOSTNAME);
        db.setDatabaseName(DATABASE_NAME);
        if(db.open()){
            qInfo(logInfo()) << "Файл настроек открыт успешно";
            result = true;
        } else {
            qCritical(logCritical()) << "Не удалось открыть файл настроек приложения.";
            result = false;
        }
    } else {
        //Файл отсутсвует, создем базу данных
        QSqlDatabase db = QSqlDatabase::addDatabase("QSQLITE","options");
        db.setHostName(DATABASE_HOSTNAME);
        db.setDatabaseName(DATABASE_NAME);
        if(db.open()){
            QStringList listSQL;  //Список запросов
            QSqlQuery q = QSqlQuery(db);
            //Создаем таблицу OPTIONS и добавлем в нее записи
            listSQL << "CREATE TABLE `options` (`option_id` INTEGER NOT NULL, `value` TEXT NOT NULL, `comment` TEXT, PRIMARY KEY(`option_id`))";
            listSQL << "INSERT INTO `options`(`option_id`,`value`,`comment`) VALUES (1000, 'false', 'Использовать аутентификацию')";
            listSQL << "INSERT INTO `options`(`option_id`,`value`,`comment`) VALUES (1010, 'false', 'Использовать привязку по региону')";
            //Создаем таблицу пользователей приложения и добавляем в нее запись
            listSQL << "CREATE TABLE `users` ( `user_id` INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT, `fio` TEXT NOT NULL, `password` TEXT, `isactive` TEXT NOT NULL DEFAULT 'true' )";
            listSQL << "INSERT INTO `users`(`fio`,`password`) VALUES ('Администратор','masterkey')";

            //Выполняем запросы
            for (int i =0;i<listSQL.size();++i) {
                if(!q.exec(listSQL.at(i)))
                    qCritical(logCritical()) << Q_FUNC_INFO << "Не удалось выполнить запрос." << listSQL.at(i) << q.lastError().text();
            }
            qInfo(logInfo()) << "Создан файл настроек приложения.";
            result = true;
        } else {
            qCritical(logCritical()) << "Не удалось создать файл настроек приложения.";
            result = false;
        }

    }

    return result;
}

В main.cpp перед вывозом гланого окна добавляем

    DataBases *db = new DataBases();
    if(!db->connectOptions()){
        qInfo(logInfo()) << "Аварийное завершение работы.";
        return 1;
    }

В папке сборки проекта при первом запуске появляется файл iMpos.opt

При следующем запуске происходит подключение к существующей базе SQLite.

Текущее состояние проекта на GitHub здесь.

Архив проекта.
iMpos_ch003.zip iMpos_ch003.zip

We recommend hosting TIMEWEB
We recommend hosting TIMEWEB
Stable hosting, on which the social network EVILEG is located. For projects on Django we recommend VDS hosting.

Я с некоторых пор перестал использовать вот такие дефайны (знаю, что в моих статьях попадаются, но это в старых статьях)

#define DATABASE_NAME "iMpos.opt"
#define DATABASE_HOSTNAME "iMpos"

Сейчас пишу так

Header

class DataBaseSettings
{
public:
    static const QString NAME;
    static const QString HOSTNAME;
}

CPP

#include "DataBaseSettings.h"

const QString DataBaseSettings::NAME = "iMpos.opt";
const QString DataBaseSettings::HOSTNAME = "iMpos";

Дело в том, что если изменить этот дефайн

#define DATABASE_NAME "iMpos.opt"

То будут перекомпилироваться абсолютно все места в проекте, где он использовался. А в случае со статическими константными переменными будет перекомпилироваться только DataBaseSettings. Это даёт очень большой выигрыш по времени перекомпиляции в очень крупных проектах при частом использовании тех или иных переменных подобного рода.

Спасибо. Возьму на заметку.

Comments

Only authorized users can post comments.
Please, Log in or Sign up
AS
July 22, 2019, 4:32 p.m.
Aleksandr Spiridonov

C++ - Test 001. The first program and data types

  • Result:46points,
  • Rating points-6
AS
July 22, 2019, 4:21 p.m.
Aleksandr Spiridonov

Qt - Test 001. Signals and slots

  • Result:73points,
  • Rating points1
July 22, 2019, 10 a.m.
Pavel K.

C++ - Test 006. Enumerations

  • Result:50points,
  • Rating points-4
Last comments
July 21, 2019, 6:03 a.m.
Evgenij Legotskoj

да, наверное, 32-х разрядную поддержку уже давно поа было выкинуть. К слову, у вас много проектов под Android? Часто много где вижу вопросы о том, пишет ли кто-то вообще на Qt под мобильные сист…
July 20, 2019, 2:41 p.m.
Andrej Jankovich

Очень полезная информация, увы уже выкинул поддержку 32 битных бедняг.
July 20, 2019, 9:31 a.m.
Mihailll

Вот так qDebug()<<"position:"<<event->scenePos();
July 20, 2019, 8:49 a.m.
Mihailll

Добрый день. Как можно узнать координату на графической сцене при отпускании клавиши мыши?
Now discuss on the forum
July 22, 2019, 10:50 a.m.
Pavel K.

Благодарю.Буду пробовать.
July 22, 2019, 10:10 a.m.
Pavel K.

Скорее всего в коде не правильно потоки используются. на форуме пишут кое что интересное - https://stackoverflow.com/questions/18112027/qt-5-1-qml-property-through-threads
July 22, 2019, 3:58 a.m.
Evgenij Legotskoj

Добрый день! Нужен совет сообщества по разработке функционала проверки орфографии. Одна из идей - добавить проверку орфографии при наборе текста статей. Полагаю, что наиболее аде…
July 22, 2019, 3:01 a.m.
Evgenij Legotskoj

Возможно, если при сохранении файла установить права доступа на файл. Что-то такое должно быть у QFile
Looking for a Job?
5,000.00 руб. - 15,000.00 руб.
Дизайнер
Moskovskiy, Moscow, Russia
25,000.00 руб. - 30,000.00 руб.
Разработчик Qt/C++
Barnaul, Altai Krai, Russia

For registered users on the site there is a minimum amount of advertising

EVILEG
About
Services
Join us
© EVILEG 2015-2019
Recommend hosting TIMEWEB