Qt spdlog日志模块的使用详解
更新时间：2025年04月12日 09:58:35 作者：sunriver2000
在Qt应用程序开发中,良好的日志系统至关重要,本文将介绍如何使用spdlog 1.5.0创建满足以下要求的日志系统,感兴趣的朋友一起看看吧
版本
spdlog版本：1.5.0
采用1.5.0版本主要基于以下考虑：兼容Qt5.9.X版本和兼容C++11。
spdlog 1.5.0下载地址：https://github.com/gabime/spdlog/releases/tag/v1.5.0
摘要
在Qt应用程序开发中，良好的日志系统至关重要。本文将介绍如何使用spdlog 1.5.0创建满足以下要求的日志系统：
- 自定义文件名格式：yyyyMMdd_hhmmss_毫秒.log，不使用spdlog提供的日志轮转功能
spdlog::sinks::rotating_file_sink_mt，采用自定义custom_rotating_file_sink；
- 保留最近10个日志文件，每个日志文件大小限制为1MB。
例子
logmanager.h文件
#ifndef LOGMANAGER_H
#define LOGMANAGER_H
#include <QObject>
#include <memory>
#include <spdlog/spdlog.h>
class LogManager : public QObject
{
Q_OBJECT
public:
static LogManager& instance();
void initialize(const QString& logDir = "logs",
const QString& appName = "app",
size_t maxFileSize = 1024 * 1024, // 1MB
size_t maxFiles = 10);
void shutdown();
template<typename... Args>
static void log(spdlog::level::level_enum level, const QString& message, Args... args)
{
if (instance().m_logger)
{
instance().m_logger->log(level, message.toStdString().c_str(), args...);
}
}
// 便捷方法
static void trace(const QString& message)
{
log(spdlog::level::trace, message);
}
static void debug(const QString& message)
{
log(spdlog::level::debug, message);
}
static void info(const QString& message)
{
log(spdlog::level::info, message);
}
static void warn(const QString& message)
{
log(spdlog::level::warn, message);
}
static void error(const QString& message)
{
log(spdlog::level::err, message);
}
static void critical(const QString& message)
{
log(spdlog::level::critical, message);
}
private:
LogManager(QObject* parent = nullptr);
~LogManager();
std::shared_ptr<spdlog::logger> createCustomLogger(const std::string& base_filename,
size_t max_size,
size_t max_files);
std::shared_ptr<spdlog::logger> m_logger;
std::atomic<bool> m_shuttingDown{false};
signals:
void aboutToShutdown();
private slots:
void onAboutToQuit();
};
// 日志宏定义
#define LOG_TRACE(...) LogManager::log(spdlog::level::trace, __VA_ARGS__)
#define LOG_DEBUG(...) LogManager::log(spdlog::level::debug, __VA_ARGS__)
#define LOG_INFO(...) LogManager::log(spdlog::level::info, __VA_ARGS__)
#define LOG_WARN(...) LogManager::log(spdlog::level::warn, __VA_ARGS__)
#define LOG_ERROR(...) LogManager::log(spdlog::level::err, __VA_ARGS__)
#define LOG_CRITICAL(...) LogManager::log(spdlog::level::critical, __VA_ARGS__)
#endif // LOGMANAGER_Hlogmanager.cpp文件
#include "logmanager.h"
#include <spdlog/sinks/base_sink.h>
#include <spdlog/details/file_helper.h>
#include <mutex>
#include <chrono>
#include <iomanip>
#include <sstream>
#include <vector>
#include <algorithm>
#include <QDir>
#include <QFileInfo>
#include <QDateTime>
#include <QCoreApplication>
#include <csignal>
#include <QDebug>
// 替换 std::filesystem 的 C++11 兼容实现
namespace spdlog
{
class custom_rotating_file_sink : public spdlog::sinks::base_sink<std::mutex>
{
public:
custom_rotating_file_sink(const std::string& base_filename,
std::size_t max_size,
std::size_t max_files)
: base_filename_(base_filename),
max_size_(max_size),
max_files_(max_files)
{
file_helper_.open(gen_filename());
}
protected:
void sink_it_(const spdlog::details::log_msg& msg) override
{
spdlog::memory_buf_t formatted;
formatter_->format(msg, formatted);
if (file_helper_.size() + formatted.size() > max_size_)
{
rotate_();
}
file_helper_.write(formatted);
}
void flush_() override
{
file_helper_.flush();
}
private:
std::string gen_filename()
{
QDateTime now = QDateTime::currentDateTime();
QString timeStr = now.toString("yyyyMMddhhmmss");
// 添加毫秒部分(3位)
int ms = now.time().msec();
timeStr += QString("_%1").arg(ms, 3, 10, QLatin1Char('0'));
return base_filename_ + "_" + timeStr.toStdString() + ".log";
}
void rotate_()
{
file_helper_.close();
cleanup_old_files();
file_helper_.open(gen_filename());
}
void cleanup_old_files()
{
if (max_files_ == 0) return;
QFileInfo base_info(QString::fromStdString(base_filename_));
QDir dir = base_info.absoluteDir();
QString base_name = base_info.fileName();
QFileInfoList files = dir.entryInfoList(QStringList() << (base_name + "_*.log"),
QDir::Files, QDir::Time);
// 删除最旧的文件
while (files.size() >= static_cast<int>(max_files_))
{
QFile::remove(files.last().absoluteFilePath());
files.removeLast();
}
}
std::string base_filename_;
std::size_t max_size_;
std::size_t max_files_;
spdlog::details::file_helper file_helper_;
};
} // namespace
LogManager::LogManager(QObject* parent) : QObject(parent)
{
// 连接Qt退出信号
connect(qApp, &QCoreApplication::aboutToQuit, this, &LogManager::onAboutToQuit);
// 处理异常信号
static auto handleSignal = [](int)
{
LogManager::instance().shutdown();
std::_Exit(1);
};
std::signal(SIGTERM, handleSignal);
std::signal(SIGSEGV, handleSignal);
std::signal(SIGINT, handleSignal);
std::signal(SIGABRT, handleSignal);
}
LogManager::~LogManager()
{
shutdown();
}
LogManager& LogManager::instance()
{
static LogManager instance;
return instance;
}
void LogManager::initialize(const QString& logDir, const QString& appName, size_t maxFileSize, size_t maxFiles)
{
if (m_logger)
{
return;
}
// 确保日志目录存在
QDir().mkpath(logDir);
std::string base_filename = QDir(logDir).absoluteFilePath(appName).toStdString();
m_logger = createCustomLogger(base_filename, maxFileSize, maxFiles);
// 设置默认日志格式
m_logger->set_pattern("[%Y-%m-%d %H:%M:%S.%e] [%l] [thread %t] %v");
m_logger->set_level(spdlog::level::trace);
spdlog::register_logger(m_logger);
spdlog::set_default_logger(m_logger);
}
void LogManager::shutdown()
{
/*
if (m_logger)
{
spdlog::drop(m_logger->name());
m_logger.reset();
}
spdlog::shutdown();
*/
if (m_shuttingDown) return;
m_shuttingDown = true;
emit aboutToShutdown();
try
{
if (m_logger)
{
m_logger->flush();
spdlog::drop(m_logger->name());
}
spdlog::shutdown();
m_logger.reset();
}
catch (const spdlog::spdlog_ex& ex)
{
qCritical() << "Log shutdown error:" << ex.what();
}
}
void LogManager::onAboutToQuit()
{
shutdown();
}
std::shared_ptr<spdlog::logger> LogManager::createCustomLogger(const std::string& base_filename,
size_t max_size,
size_t max_files)
{
auto sink = std::make_shared<spdlog::custom_rotating_file_sink>(base_filename, max_size, max_files);
auto logger = std::make_shared<spdlog::logger>("qt_logger", sink);
return logger;
}main.cpp文件
#include <QCoreApplication>
#include "logmanager.h"
#include <QTimer>
#include <QDebug>
int main(int argc, char* argv[])
{
QCoreApplication a(argc, argv);
// 初始化日志系统
LogManager::instance().initialize("logs", "MyAppTest");
// 连接关闭信号进行额外清理
QObject::connect(&LogManager::instance(), &LogManager::aboutToShutdown, []()
{
LOG_INFO("Performing final cleanup before shutdown...");
});
for (int i = 0; i < 5000; ++i)
{
LOG_INFO("This is a test message to fill up the log file. Iteration: {}", i);
}
return a.exec();
}到此这篇关于Qt spdlog日志模块的使用的文章就介绍到这了,更多相关Qt spdlog日志模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要为大家介绍了C++的原子操作，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助2021-11-11
道路交通标志用以禁止、警告、指示和限制道路使用者有秩序地使用道路, 保障出行安全.若能自动识别道路交通标志, 则将极大减少道路交通事故的发生。本文将介绍基于Matlab实现BP神经网络交通标志识别，感兴趣的可以学习一下2022-01-01
JSON是一种轻量级的数据交换格式,它是基于ECMAScript的一个子集,使用完全独立于编程语言的文本格式来存储和表示数据。这篇文章主要介绍了QT实现解析JSON文件的示例代码，需要的可以参考一下2022-01-01
这篇文章主要介绍了C语言中的memset()函数,包括其与memcpy()函数的区别,需要的朋友可以参考下2015-08-08
这篇文章主要为大家详细介绍了C++中的类与对象，使用数据库，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-02-02
throw关键字是在C语言中用来抛出异常的关键字,它通常与try和catch一起使用,用于在程序中发生错误时进行异常处理,当遇到无法处理的错误情况时,我们可以使用throw关键字主动抛出异常,所以本文给大家详细的介绍一下C++中的throw关键字,需要的朋友可以参考下2023-09-09
C++命名空间 缺省参数 const总结 引用总结 内联函数 auto关键字详解
这篇文章主要介绍了C++命名空间 缺省参数 const总结 引用总结 内联函数 auto关键字详解的相关资料,需要的朋友可以参考下2023-01-01
Linux下父进程可以使用fork 函数创建子进程，但是当父进程先退出后，子进程会不会也退出呢？通过下面这个小实验，我们能够很好的看出来2014-02-02
这篇文章主要给大家介绍了关于教你3分钟如何发布Qt程序的相关资料，文中通过实例代码结束的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧2020-08-08
这篇文章主要为大家详细介绍了C语言实现简单弹球游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2020-02-02
最新评论