简单易用的Qt日志模块
- 引言
- 一日志实现方法
- 代码实现
- LogHandlercpp
- 代码实现
- 二崩溃处理
- 代码实现
- LogHandlercpp
- 代码实现
- 小结
- 参考
引言
项目中需求一日志模块，主要实现两大功能：1.自动打印信息至日志文件；2.软件意外退出时保留信息以便跟踪问题。
本文结合了 Qt 自定义日志工具 和 让程序在崩溃时体面的退出之CallStack 提供的方法，补充实现了文章中未具体给出的管理日志文件大小和数量的功能。
环境：vs2012+Qt5.2(注：Qt5.5之后引入qInfo()，影响不大)
一、日志实现方法
基本原理是使用 qInstallMessageHandler()接管qDebug(), qWarning()等调试信息，然后将信息流存储至本地日志文件，管理日志文件。
代码在原作者基础上做了部分调整：
1.更改日志存储名称格式，用QDateTime取代QDate，以避免当日记录多条日志时的覆盖问题；
2.增加日志文件个数的判断；
3.增加日志文件大小的检测；
4.屏蔽根据修改日期保存日志机制，以免在不同日期开启软件后冲掉以前的有用log，仅凭文件大小另存log文件，然后控制文件数量。
代码实现
LogHandler.cpp
#include "LogHandler.h"
#include fileDates;
// for (int i = 0; i < logFiles.length(); ++i)
// {
// QString name = logFiles[i].baseName();
// QDateTime fileDateTime = QDateTime::fromString(name, "yyyy-MM-dd");
//
// if (fileDateTime.isValid())
// fileDates.insert(fileDateTime, logFiles[i].absoluteFilePath());
// }
// QList fileDateNames = fileDates.values();
// for (int i = 0; i < fileDateNames.length() - LOGFILESLIMIT; ++i)
// QFile::remove(fileDateNames[i]);
}
// 如果日志所在目录不存在，则创建
void LogHandlerPrivate::makeSureLogDirectory() const {
if (!logDir.exists()) {
logDir.mkpath("."); // 可以递归的创建文件夹
}
}
// 检测当前日志文件大小
void LogHandlerPrivate::checkLogFiles() {
// 如果 protocal.log 文件大小超过5M，重新创建一个日志文件，原文件存档为yyyy-MM-dd_hhmmss.log
if (logFile->size() > 1024*LOGLIMIT_SIZE) {
logFile->flush();
logFile->close();
delete logOut;
delete logFile;
QString logPath = logDir.absoluteFilePath("protocal.log"); // 日志的路径
QString newLogPath = logDir.absoluteFilePath(logFileCreatedDate.toString("yyyy-MM-dd_hhmmss.log"));;
QFile::copy(logPath, newLogPath); // Bug: 按理说 rename 会更合适，但是 rename 时最后一个文件总是显示不出来，需要 killall Finder 后才出现
QFile::remove(logPath); // 删除重新创建，改变创建时间
logFile = new QFile(logPath);
logOut = (logFile->open(QIODevice::WriteOnly | QIODevice::Text | QIODevice::Truncate)) ? new QTextStream(logFile) : NULL;
logFileCreatedDate = QDateTime::currentDateTime();
if (NULL != logOut) {
logOut->setCodec("UTF-8");
}
}
}
// 消息处理函数
void LogHandlerPrivate::messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg) {
QMutexLocker locker(&LogHandlerPrivate::logMutex);
QString level;
switch (type) {
case QtDebugMsg:
level = "Debug";
break;
// case QtInfoMsg://This function was introduced in Qt 5.5.
// level = "Info ";
// break;
case QtWarningMsg:
level = "Warning";
break;
case QtCriticalMsg:
level = "Error";
break;
case QtFatalMsg:
level = "Fatal";
break;
default:;
}
// 输出到标准输出
QByteArray localMsg = msg.toLocal8Bit();
//std::cout << std::string(localMsg) << std::endl;
if (NULL == LogHandlerPrivate::logOut) {
return;
}
// 输出到日志文件, 格式: 时间 - [Level] (文件名:行数, 函数): 消息
QString fileName = context.file;
int index = fileName.lastIndexOf(QDir::separator());
fileName = fileName.mid(index + 1);
(*LogHandlerPrivate::logOut) << QString("%1 - [%2] (%3:%4): %5\n")
.arg(QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss")).arg(level)
.arg(fileName).arg(context.line)/*.arg(context.function)*/.arg(msg);
logOut->flush();//直接刷新到文件
}
/************************************************************************************************************
* *
* LogHandler *
* *
***********************************************************************************************************/
LogHandler::LogHandler() : d(NULL) {
}
LogHandler::~LogHandler() {
}
void LogHandler::installMessageHandler() {
QMutexLocker locker(&LogHandlerPrivate::logMutex);
if (NULL == d) {
d = new LogHandlerPrivate();
qInstallMessageHandler(LogHandlerPrivate::messageHandler); // 给 Qt 安装自定义消息处理函数
}
}
void LogHandler::release() {
QMutexLocker locker(&LogHandlerPrivate::logMutex);
qInstallMessageHandler(0);
delete d;
d = NULL;
}二、崩溃处理
让程序在崩溃时体面的退出之总结博主在系列文章中做了详尽的说明。
我的应用目的是在程序崩溃时能体面退出，然后记录基本的CallStack信息到日志文件，所以只用到了前面两部分内容。在上文的基础上，用qCritical()或其他方法输出Crash信息和CallStack信息即可。
代码实现
LogHandler.cpp
//程式异常捕获
LONG ApplicationCrashHandler(EXCEPTION_POINTERS *pException){
/*
***保存数据代码***
*/
// 创建Dump文件目录
QDir DumpDir;
DumpDir.setPath("Log");
LPCWSTR DumpPath = (const wchar_t*) DumpDir.absoluteFilePath("ProtocolTester.dmp").utf16();// Dump文件的路径
CreateDumpFile(DumpPath, pException);
// 确保有足够的栈空间
#ifdef _M_IX86
if (pException->ExceptionRecord->ExceptionCode == EXCEPTION_STACK_OVERFLOW)
{
static char TempStack[1024 * 128];
__asm mov eax,offset TempStack[1024 * 128];
__asm mov esp,eax;
}
#endif
CrashInfo crashinfo = GetCrashInfo(pException->ExceptionRecord);
// 输出Crash信息
qCritical() << "ErrorCode: " << crashinfo.ErrorCode << endl;
qCritical() << "Address: " << crashinfo.Address << endl;
qCritical() << "Flags: " << crashinfo.Flags << endl;
vector
")+
QStringLiteral("错误代码：%1错误地址：%2").arg(errCode).arg(errAdr),
QMessageBox::Ok);
return EXCEPTION_EXECUTE_HANDLER;
}小结
本文实现了一个轻量的Qt日志模块，功能肯定是没有log4qt或log4cxx等强大，但也基本满足了项目应用需求，想了解log4qt也可以查看DevBean豆子大神的github
最后附上相关源码：一个轻量的Qt日志模块
参考
Qt 自定义日志工具
让程序在崩溃时体面的退出之CallStack
Qt 日志模块的使用
Qt5 中使用 log4qt 输出日志