qt 如何区分日志的级别

原创已于 2025-02-13 15:05:26 修改 · 639 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#qt #数据库 #开发语言

于 2024-12-20 16:27:47 首次发布

QT基础专栏收录该内容

106 篇文章

订阅专栏

1.概要

qt 如何区分日志的级别

2.内容

在 Qt 中，日志记录通常通过使用 QLoggingCategory 类来实现。QLoggingCategory 提供了对日志消息进行分类和过滤的功能，允许你根据日志级别（例如：调试、信息、警告、错误等）来控制日志的输出。

以下是如何在 Qt 中区分和使用日志级别的步骤：

包含必要的头文件：

#include <QLoggingCategory>
定义一个日志类别：
日志类别用于对日志消息进行分组，这样可以更方便地控制和过滤日志。

Q_LOGGING_CATEGORY(myCategory, "my.category.name")

记录不同级别的日志消息：
使用 qCDebug、qCInfo、qCWarning 和 qCCritical 宏来记录不同级别的日志消息。

qCDebug(myCategory) << "This is a debug message";
qCInfo(myCategory) << "This is an informational message";
qCWarning(myCategory) << "This is a warning message";
qCCritical(myCategory) << "This is a critical error message";

设置日志级别过滤器：
你可以通过设置环境变量 QT_LOGGING_CONF 或在代码中配置日志过滤器来控制哪些级别的日志消息应该被输出。例如，通过环境变量设置日志级别：

QT_LOGGING_CONF=my.category.name.level=info

这样，只会输出 info 级别及以上的日志消息（即 info、warning 和 critical）。
在代码中配置日志过滤器（可选）：
你也可以在代码中配置日志过滤器。例如：

QLoggingCategory::setFilterRules("my.category.name.level=info");

示例代码

以下是一个完整的示例，展示了如何在 Qt 应用程序中使用和过滤日志消息：

#include <QCoreApplication>
#include <QLoggingCategory>

Q_LOGGING_CATEGORY(myCategory, "my.category.name")

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

    // 设置日志过滤器（可选）
    QLoggingCategory::setFilterRules("my.category.name.level=info");

    // 记录不同级别的日志消息
    qCDebug(myCategory) << "This is a debug message";
    qCInfo(myCategory) << "This is an informational message";
    qCWarning(myCategory) << "This is a warning message";
    qCCritical(myCategory) << "This is a critical error message";

    return a.exec();
}

在这个示例中，由于日志级别过滤器设置为 info，因此只有 info、warning 和 critical 级别的日志消息会被输出到控制台。debug 级别的消息将被忽略。

通过这种方式，你可以灵活地在 Qt 应用程序中管理和过滤日志消息，提高调试和维护的效率。

3.关联链接

qt 如何区分日志的级别-优快云博客

qt开发一个简单但的志系统-优快云博客

qt 的日志级别-优快云博客

qt 添加日志有多少种可选方案-优快云博客

Log4Qt常用方法举例-优快云博客

4.关联知识

1.QLoggingCategory

QLoggingCategory 是 Qt 框架中用于日志管理的一个强大工具，它允许开发者在运行时动态地控制日志的输出级别和类别。以下是关于 QLoggingCategory 的详细介绍：

一、基本概念

定义：QLoggingCategory 表示日志基础架构中的一个类别或“区域”。每个类别由一个字符串标识，用于区分不同的日志来源。
功能：通过 QLoggingCategory，开发者可以灵活地启用或禁用特定类别和级别的日志输出，从而帮助调试和监控应用程序的行为。

二、使用方法

声明和定义日志类别
- 在头文件中，使用 Q_DECLARE_LOGGING_CATEGORY 宏声明日志类别。例如：
```
#include <QLoggingCategory>


Q_DECLARE_LOGGING_CATEGORY(myLogCategory)
```
- 在源文件中，使用 Q_LOGGING_CATEGORY 宏定义日志类别，并指定其名称。例如：
```
#include <QLoggingCategory>


Q_LOGGING_CATEGORY(myLogCategory, "my.category.name")
```
- 还可以指定日志的初始级别，例如：
  Q_LOGGING_CATEGORY(myLogCategory, "my.category.name", QtWarningMsg)
  
  这表示 myLogCategory 初始时仅启用 QtWarningMsg 及以上级别的日志输出。
配置日志输出
- 使用 QLoggingCategory::setFilterRules 函数设置日志过滤规则。规则字符串的格式为：
  
  <category>[.<type>] = true|false
  - <category> 是日志类别的名称，可以使用通配符 *。
  - <type> 是日志级别，如 debug、info、warning、critical 等。
  - true 表示启用该类别和级别的日志输出，false 表示禁用。
  例如：
  
  QLoggingCategory::setFilterRules("my.category.name.debug=false");
  
  这表示禁用 my.category.name 类别中 debug 级别的日志输出。
- 可以通过环境变量 QT_LOGGING_RULES 设置日志过滤规则，多个规则用分号分隔。例如：
  
  export QT_LOGGING_RULES="*.debug=false;my.category.name.info=true"
- 还可以将日志过滤规则写入配置文件（如 qtlogging.ini），然后在程序中指定配置文件的位置。例如：
  
  QLoggingCategory::setFilterRules("@path/to/qtlogging.ini");
输出日志消息
- 使用 qCDebug、qCInfo、qCWarning、qCCritical 等宏输出不同级别的日志消息。例如：
```
qCDebug(myLogCategory) << "This is a debug message";
qCInfo(myLogCategory) << "This is an informational message";
qCWarning(myLogCategory) << "This is a warning message";
qCCritical(myLogCategory) << "This is a critical error message";
```
- 这些宏会检查当前日志类别和级别的启用状态，如果未启用，则不会输出日志消息，也不会评估消息参数。

三、注意事项

类别名称规范
- 类别名称只能使用字母和数字，可以使用点 . 将类别进一步划分为子区域。
- 避免使用 debug、info、warning、critical 等作为类别名称，以免与日志级别混淆。
- 带有 qt 前缀的类别名称保留给 Qt 模块使用。
日志级别
- Qt 支持的日志级别包括 QtDebugMsg、QtInfoMsg、QtWarningMsg、QtCriticalMsg、QtFatalMsg 和 QtSystemMsg。
- 其中，QtFatalMsg 级别的日志消息会终止程序的执行。
线程安全
- QLoggingCategory 的对象是线程安全的，可以在多线程环境中安全地使用。

四、高级用法

安装自定义消息处理程序
- 通过 qInstallMessageHandler 函数，可以自定义日志消息的处理方式，例如将日志输出到文件或发送到远程服务器。
动态调整日志级别
- 可以在程序运行期间动态地调整日志级别，而无需重启程序。例如，根据用户的配置或程序的状态调整日志输出的详细程度。

五、总结

QLoggingCategory 是 Qt 框架中用于日志管理的一个强大工具，它允许开发者在运行时动态地控制日志的输出级别和类别。通过合理的配置和使用，QLoggingCategory 可以帮助开发者更有效地调试和监控应用程序的行为。

2.QLoggingCategory应用举例

以下是一个关于 QLoggingCategory 的应用举例，展示了如何定义日志类别、设置日志级别和规则，以及如何在代码中使用这些类别输出日志消息。

示例场景

假设我们开发了一个包含多个模块（如网络模块和数据库模块）的 Qt 应用程序。我们希望为每个模块定义独立的日志类别，并根据需要输出不同级别的日志消息。

示例代码

1. 定义日志类别

首先，在头文件中声明日志类别。例如，为网络模块和数据库模块分别声明日志类别：

// networkmodule.h
#include <QLoggingCategory>

Q_DECLARE_LOGGING_CATEGORY(networkModule)

// databasemodule.h
#include <QLoggingCategory>

Q_DECLARE_LOGGING_CATEGORY(databaseModule)

然后，在对应的源文件中定义日志类别的实例：

// networkmodule.cpp
#include "networkmodule.h"

Q_LOGGING_CATEGORY(networkModule, "networkmodule")

// databasemodule.cpp
#include "databasemodule.h"

Q_LOGGING_CATEGORY(databaseModule, "databasemodule")

2. 设置日志级别和规则

在应用程序的入口点（如 main 函数）设置日志级别和规则。例如，我们希望网络模块的日志消息输出到控制台，并只保留警告级别以上的消息；而数据库模块的日志消息则同时输出到控制台和日志文件中。可以这样配置：

#include <QCoreApplication>
#include <QLoggingCategory>
#include <QDebug>

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

    // 设置日志级别和规则
    QLoggingCategory::setFilterRules("networkmodule.debug=false\n"
                                     "networkmodule.warning=true\n"
                                     "databasemodule.debug=true\n"
                                     "databasemodule.warning=true");

    // 使用日志类别输出日志消息
    qCDebug(networkModule) << "This is a network debug message"; // 不会被输出
    qCWarning(networkModule) << "This is a network warning message"; // 会被输出

    qCDebug(databaseModule) << "This is a database debug message"; // 会被输出
    qCWarning(databaseModule) << "This is a database warning message"; // 会被输出

    return a.exec();
}

3. 自定义日志输出（可选）

如果需要更复杂的日志输出处理，例如将日志消息写入文件，可以自定义日志消息处理程序：

#include <QFile>
#include <QTextStream>

void customMessageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg)
{
    static QFile logFile("log.txt");
    if (!logFile.isOpen()) {
        logFile.open(QIODevice::WriteOnly | QIODevice::Append);
    }

    QTextStream textStream(&logFile);
    textStream << qPrintable(QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss.zzz "))
               << context.file << "(" << context.line << "): "
               << msg << "\n";

    logFile.flush();
}

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

    // 设置日志级别和规则
    QLoggingCategory::setFilterRules("networkmodule.debug=false\n"
                                     "networkmodule.warning=true\n"
                                     "databasemodule.debug=true\n"
                                     "databasemodule.warning=true");

    // 安装自定义消息处理函数
    qInstallMessageHandler(customMessageHandler);

    // 使用日志类别输出日志消息
    qCDebug(networkModule) << "This is a network debug message"; // 不会被输出
    qCWarning(networkModule) << "This is a network warning message"; // 会被输出

    qCDebug(databaseModule) << "This is a database debug message"; // 会被输出
    qCWarning(databaseModule) << "This is a database warning message"; // 会被输出

    return a.exec();
}

关键点解析

日志类别声明和定义：使用 Q_DECLARE_LOGGING_CATEGORY 声明日志类别，使用 Q_LOGGING_CATEGORY 定义日志类别的实例。
日志级别和规则设置：使用 QLoggingCategory::setFilterRules 函数设置日志级别和规则，控制哪些日志消息被输出。
日志消息输出：使用 qCDebug、qCInfo、qCWarning、qCCritical 等宏输出日志消息。
自定义消息处理：使用 qInstallMessageHandler 函数安装自定义消息处理函数，将日志消息写入文件或其他目标。

通过以上步骤，您可以灵活地使用 QLoggingCategory 管理 Qt 应用程序中的日志输出。

3.QLoggingCategory接口说明

QLoggingCategory 是 Qt 框架中用于日志管理的强大工具，它允许开发者在运行时动态设置日志级别和规则，从而控制哪些级别的日志可以被输出。以下是 QLoggingCategory 接口的详细说明：

一、基本概念

QLoggingCategory 表示日志基础结构中的类别或“区域”。在运行时，它代表一个由字符串标识的特定日志记录类别。开发者可以将类别配置为启用或禁用每种消息类型的消息日志记录。

二、主要接口

1. 构造函数和析构函数

QLoggingCategory(const char *category)：使用给定的类别名称创建一个 QLoggingCategory 实例。
QLoggingCategory(const char *category, QtMsgType enableForLevel)：使用给定的类别名称和最低启用级别创建一个 QLoggingCategory 实例。低于该级别的消息类型将被忽略。
~QLoggingCategory()：销毁 QLoggingCategory 实例。

2. 静态函数

QLoggingCategory *defaultCategory()：返回默认的日志类别实例。
void setFilterRules(const QString &rules)：设置日志过滤规则。规则字符串可以包含多条规则，每条规则以换行符分隔。规则语法为 <category>.debug|info|warning|critical|fatal=true|false，用于启用或禁用特定类别和级别的日志输出。
void installFilter(CategoryFilter filter)：安装一个自定义的日志过滤器。

3. 成员函数

const char *categoryName() const：返回日志类别的名称。
bool isDebugEnabled() const：检查调试级别的日志是否已启用。
bool isInfoEnabled() const：检查信息级别的日志是否已启用。
bool isWarningEnabled() const：检查警告级别的日志是否已启用。
bool isCriticalEnabled() const：检查严重错误级别的日志是否已启用。
bool isEnabled(QtMsgType msgType) const：检查指定消息类型的日志是否已启用。
void setEnabled(QtMsgType type, bool enable)：启用或禁用指定消息类型的日志输出。
QLoggingCategory &operator()() const：返回当前日志类别的引用，方便在宏中使用。

三、使用宏

为了方便使用，Qt 提供了一组与 QLoggingCategory 相关的宏：

Q_DECLARE_LOGGING_CATEGORY(name)：在头文件中声明一个日志类别。
Q_LOGGING_CATEGORY(name, string)：在源文件中定义日志类别的实例。
Q_LOGGING_CATEGORY(name, string, msgType)：在源文件中定义日志类别的实例，并指定最低启用级别。
qCDebug(category, ...)：输出调试级别的日志消息。
qCInfo(category, ...)：输出信息级别的日志消息。
qCWarning(category, ...)：输出警告级别的日志消息。
qCCritical(category, ...)：输出严重错误级别的日志消息。

四、使用示例

以下是一个简单的使用示例：

#include <QCoreApplication>
#include <QLoggingCategory>
#include <QDebug>

Q_DECLARE_LOGGING_CATEGORY(appLog)

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

    // 定义日志类别
    Q_LOGGING_CATEGORY(appLog, "app.log")

    // 设置日志过滤规则
    QLoggingCategory::setFilterRules("app.log.debug=true\napp.log.warning=true");

    // 输出日志消息
    qCDebug(appLog) << "This is a debug message.";
    qCWarning(appLog) << "This is a warning message.";

    return a.exec();
}

五、注意事项

类别名称：类别名称应遵循一些规则，如只使用字母和数字，避免使用 debug、info、warning 和 critical 等保留字。
日志规则：日志规则按文本顺序从头到尾进行评估。如果两条规则适用于一个类别/类型，则将应用后出现的规则。
性能考虑：虽然 QLoggingCategory 提供了灵活的日志控制功能，但在高性能要求的场景中，过多的日志输出可能会影响性能。因此，应合理设置日志级别和规则，避免输出不必要的日志消息。

通过以上接口和宏的使用，开发者可以方便地管理 Qt 应用程序中的日志输出，提高调试和运维的效率。