Yayin Story Studio logo Yayin Story Studio 项目文档
回到主页 用户手册

Logger Class

class Visindigo::General::Logger

日志记录器类,用于记录和管理日志消息。. 详情...

头文件: #include <General/Logger.h>
自以下版本: Visindigo 0.13.0

公开类型

(自 Visindigo 0.13.0 引入) enum Level { Debug, Message, Info, Log, Notice, …, Error }

公开成员函数

(自 Visindigo 0.13.0 引入) Logger(const QString &nameSpace, Visindigo::General::Logger::Level threshold = Debug)
(自 Visindigo 0.13.0 引入) ~Logger()
(自 Visindigo 0.13.0 引入) Visindigo::General::LoggerMsgHandler debug()
(自 Visindigo 0.13.0 引入) Visindigo::General::LoggerMsgHandler error()
(自 Visindigo 0.13.0 引入) QString getNamespace()
(自 Visindigo 0.13.0 引入) Visindigo::General::Logger::Level getThreshold() const
(自 Visindigo 0.13.0 引入) Visindigo::General::LoggerMsgHandler info()
(自 Visindigo 0.13.0 引入) Visindigo::General::LoggerMsgHandler log()
(自 Visindigo 0.13.0 引入) Visindigo::General::LoggerMsgHandler message()
(自 Visindigo 0.13.0 引入) Visindigo::General::LoggerMsgHandler notice()
(自 Visindigo 0.13.0 引入) void setNamespace(const QString &nameSpace)
(自 Visindigo 0.13.0 引入) void setThreshold(Visindigo::General::Logger::Level threshold)
(自 Visindigo 0.13.0 引入) Visindigo::General::LoggerMsgHandler success()
(自 Visindigo 0.13.0 引入) Visindigo::General::LoggerMsgHandler warning()

静态公开成员

(自 Visindigo 0.13.0 引入) Visindigo::General::Logger *global()

详细说明

Logger 类是日志记录器的实例组件,用于管理来自不同命名空间的日志消息。 它允许设置日志级别阈值,以过滤不需要的日志消息。

Logger 不是必须创建的,可以用global()函数获取全局记录器实例。 但这等同于向带有Global命名空间的日志输出所有消息。

如果需要更细粒度的日志管理,则应该创建自己的 Logger 实例。

Note: 此类不容许拷贝或移动。

成员类型文档

[since Visindigo 0.13.0] enum Logger::Level

ConstantValueDescription
Visindigo::General::Logger::Debug1000调试级别日志消息,级别1000
Visindigo::General::Logger::Message2000普通消息级别日志消息,级别2000
Visindigo::General::Logger::InfoMessage信息级别日志消息,级别2000
Visindigo::General::Logger::LogMessage日志级别日志消息,级别2000
Visindigo::General::Logger::Notice3000通知级别日志消息,级别3000
Visindigo::General::Logger::Success4000成功级别日志消息,级别4000
Visindigo::General::Logger::Warning5000警告级别日志消息,级别5000
Visindigo::General::Logger::Error6000错误级别日志消息,级别6000

日志级别用于指示日志消息的重要性或严重性。较低的级别表示较少的重要性,而较高的级别表示更高的重要性。

用户可以自定义一个整数作为阈值,然后将其强制类型转换为Level类型传递给setThreshold()函数,以设置日志记录器的日志级别阈值。 只有级别高于或等于此阈值的日志消息才会被记录。

这个 enum 从 Visindigo 0.13.0 开始支持。

成员函数文档

[explicit, since Visindigo 0.13.0] Logger::Logger(const QString &nameSpace, Visindigo::General::Logger::Level threshold = Debug)

构造函数,使用指定的命名空间和日志级别阈值创建一个日志记录器对象。

nameSpace 日志记录器的命名空间。 threshold 日志级别阈值。只有级别高于或等于此阈值的日志消息才会被记录。

在QT_DEBUG模式下,默认阈值为Debug级别;否则默认为Message级别。

这很重要,因为在发布版本中,调试级别的日志消息通常是不需要的。

如果您在发行版本缺少日志输出,应考虑调整阈值。

这个 function 从 Visindigo 0.13.0 开始支持。

[noexcept, since Visindigo 0.13.0] Logger::~Logger()

析构函数,销毁日志记录器对象。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::LoggerMsgHandler Logger::debug()

return 用于记录调试级别日志消息的日志消息处理器。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::LoggerMsgHandler Logger::error()

return 用于记录错误级别日志消息的日志消息处理器。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QString Logger::getNamespace()

return 获取日志记录器的命名空间。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::Logger::Level Logger::getThreshold() const

return 获取日志级别阈值。

这个 function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.13.0] Visindigo::General::Logger *Logger::global()

return 全局日志记录器实例。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::LoggerMsgHandler Logger::info()

return 用于记录信息级别日志消息的日志消息处理器。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::LoggerMsgHandler Logger::log()

return 用于记录日志级别日志消息的日志消息处理器。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::LoggerMsgHandler Logger::message()

return 用于记录普通消息级别日志消息的日志消息处理器。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::LoggerMsgHandler Logger::notice()

return 用于记录通知级别日志消息的日志消息处理器。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void Logger::setNamespace(const QString &nameSpace)

nameSpace 日志记录器的命名空间。 设置日志记录器的命名空间。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void Logger::setThreshold(Visindigo::General::Logger::Level threshold)

threshold 日志级别阈值。 设置日志级别阈值。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::LoggerMsgHandler Logger::success()

return 用于记录成功级别日志消息的日志消息处理器。

这个 function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::LoggerMsgHandler Logger::warning()

return 用于记录警告级别日志消息的日志消息处理器。

这个 function 从 Visindigo 0.13.0 开始支持。