Qt第三方日志库QsLog基本语法介绍

目录

    • 一、QsLog使用的基本步骤
      • 1.1 初始化
      • 1.2 设置日志输出目的地
        • 1.2.1 输出到文件:
        • 1.2.2 输出到控制台stdout:
        • 1.2.3 输出到处理函数:
        • 1.2.4 输出到Qt界面(如QTextEdit):
      • 1.3 打印日志
      • 1.4 销毁QsLog
    • 二、设置打印行号
    • 三、日志级别

一、QsLog使用的基本步骤

1.1 初始化

首先需要初始化QsLog:

Logger& logger = Logger::instance();

然后可以选择设置日志级别:

logger.setLoggingLevel(QsLogging::TraceLevel);

1.2 设置日志输出目的地

日志输出目的地一般有三个,分别是:输出到文件、输出到控制台和输出到处理函数。

1.2.1 输出到文件:

输出到文件需要首先确定文件所在路径,然后设置将其输出到文件。

const QString sLogPath(QDir(QApplication::applicationDirPath()).filePath("log.txt"));
DestinationPtr fileDestination(DestinationFactory::MakeFileDestination(
      sLogPath, EnableLogRotation, MaxSizeBytes(512*1024), MaxOldLogCount(5)));
logger.addDestination(fileDestination);

函数原型:

static DestinationPtr MakeFileDestination(
    const QString& filePath,
    LogRotationOption rotation = DisableLogRotation,
    const MaxSizeBytes &sizeInBytesToRotateAfter = MaxSizeBytes(),
    const MaxOldLogCount &oldLogsToKeep = MaxOldLogCount());
  • filePath: 日志文件名;
  • rotation: 取值DisableLogRotation和EnableLogRotation,前者表示禁止日志文件分割,即日志始终往一个文件中写入;后者表示启用日志文件分割,此时sizeInBytesToRotateAfter和oldLogsToKeep参数才有意义;
  • sizeInBytesToRotateAfter: 每个日志文件的字节数大小限制,即到达此大小后,自动新建文件,在新文件中进行写入;
  • oldLogsToKeep: 旧日志文件保留(备份)个数,超过此数量,自动删除最久远文件,备份文件最多支持10个;

示例:若为2,则如下三个文件中内容,按照时间先后顺序排列为:log.txt.2->log.txt.1->log.txt,在log.txt中为最新日志,log.txt.1为次新,log.txt.2为最久远日志。若此时log.txt超过sizeInBytesToRotateAfter限制,则会发生log.txt.2被删除,log.txt.1被改名log.txt.2,log.txt被改名log.txt.1,新建log.txt。

代码示例:

    //该文件可被拆分,当大小超5M时被拆分,最多10个旧文件(超过则自动删除最旧的)
    DestinationPtr fileDestination(DestinationFactory::MakeFileDestination(sLogPath, EnableLogRotation, MaxSizeBytes(1024*1024*5), MaxOldLogCount(10)));
    logger.addDestination(fileDestination);

1.2.2 输出到控制台stdout:

DestinationPtr debugDestination(DestinationFactory::MakeDebugOutputDestination());
logger.addDestination(debugDestination);

1.2.3 输出到处理函数:

DestinationPtr functorDestination(DestinationFactory::MakeFunctorDestination(&logFunction));
logger.addDestination(functorDestination);

输出到函数,该函数需要定义为如下类型:

typedef void (*LogFunction)(const QString &message, Level level);

1.2.4 输出到Qt界面(如QTextEdit):

DestinationPtr objectDestination(DestinationFactory::MakeFunctorDestination(window, SLOT(logSlot(QString,int))));
logger.addDestination(objectDestination);

然后编写相应的槽函数:

//槽函数
void logSlot(const QString &message, int level)
{
    ui->textEdit->append(qPrintable(message));
}

1.3 打印日志

打印日志示例如下:

    QLOG_INFO() << "Program started";
    QLOG_TRACE() << "Here's a" << QString::fromUtf8("trace") << "message";
    QLOG_DEBUG() << "Here's a" << static_cast<int>(QsLogging::DebugLevel) << "message";
    QLOG_WARN()  << "Uh-oh!";
    QLOG_ERROR() << "An error has occurred";
    QLOG_FATAL() << "Fatal error!";

1.4 销毁QsLog

析构掉:

QsLogging::Logger::destroyInstance();

ok,以上四步便是QsLog的全部步骤了。

二、设置打印行号

在QsLog.pri文件中添加如下语句:

DEFINES += QS_LOG_LINE_NUMBERS

打开此宏定义,重新编译,即可打印带源文件名称和行号的日志。如下:
Qt第三方日志库QsLog基本语法介绍_第1张图片

三、日志级别

QsLog支持六个日志级别,优先级从低到高依次为:Trace、Debug、Info、Warn、Error、Fatal、Off。如下:

enum Level
{
    TraceLevel = 0,
    DebugLevel,
    InfoLevel,
    WarnLevel,
    ErrorLevel,
    FatalLevel,
    OffLevel
};
  • Trace:跟踪,最低等级的,用于打开所有日志记录;
  • Debug:调试,打印一些细粒度调试运行信息。
  • Info:信息,打印粗粒度信息,突出强调程序的运行过程。打印一些感兴趣或者重要的信息,可用于环境中输出程序运行的一些重要信息,但不能滥用,避免打印过多日志;
  • Warn:警告,表明会出现潜在错误的情形,有些信息不是错误信息,但是也要给程序员的一些提示。
  • Error:错误,指出虽然发生错误,但仍然不影响系统的继续运行。打印错误和异常信息;
  • Fatal:致命的,发生严重错误,将导致应用程序的退出。这个级别比较高,程序直接停止运行了;
  • Off:最高等级的,用于关闭所有日志记录。

可以通过setLoggingLevel()设置记录日志的级别。

void setLoggingLevel(Level newLevel)

示例:若设置为TraceLevel,则日志级别比TraceLevel高的都会输出,日志级别比其低的都会隐藏。


参考资源:https://www.freesion.com/article/3377866925

你可能感兴趣的