Qt编写调试日志输出类带网络转发（开源） - QTCN开发网

离线liudianwu

总版主

只看楼主倒序阅读楼主发表于: 2019-03-10

— 本帖被 20091001753 从 Qt 作品展移动到本区(2020-01-14) —

用qt开发商业程序已经九年了，陆陆续续开发过至少几十个程序，除了一些算不算项目的小工具外，大部分的程序都需要有个日志的输出功能，希望可以将程序的运行状态存储到文本文件或者数据库或者做其他处理等，qt对这个日志输出也做了很好的封装，在Qt4是qInstallMsgHandler，Qt5里边是qInstallMessageHandler，有了这个神器，只要在你的项目中所有qdebug qinfo等输出的日志信息，都会重定向接收到，网上大部分人写的demo都是接收到输出打印日志存储到文本文件，其实这就带给很多人误解，容易产生以为日志只能输出到文本文件，其实安装了日志钩子以后，拿到了所有调试打印信息，你完全可以用来存储到数据库+html有颜色区分格式的文件+网络转发输出（尤其适用于嵌入式linux无界面程序，现场不方便外接调试打印的设备）。
做过的这么多项目中，Qt4和Qt5的都有，我一般保留四个版本，4.8.7，为了兼容qt4, 5.7.0，最后的支持XP的版本，最新的长期支持版本5.9.7 最高的新版本5.12。毫无疑问，我要封装的这个日志类，也要支持4+5的，而且提供友好的接口。
1：支持动态启动和停止。
2：支持日志存储的目录。
3：支持网络发出打印日志。
4：支持Qt4+Qt5。开箱即用。
5：支持多线程。
6：使用做到最简单，start即可。
完整代码下载：

savelog.zip (6 K) 下载次数:886
网络转发效果图：

完整代码：

复制代码

#ifndef SAVELOG_H
#define SAVELOG_H
#include <QObject>
class QFile;
class QTcpSocket;
class QTcpServer;
#ifdef quc
#if (QT_VERSION < QT_VERSION_CHECK(5,7,0))
#include <QtDesigner/QDesignerExportWidget>
#else
#include <QtUiPlugin/QDesignerExportWidget>
#endif
class QDESIGNER_WIDGET_EXPORT SaveLog : public QObject
#else
class SaveLog : public QObject
#endif
{
Q_OBJECT
public:
static SaveLog *Instance();
explicit SaveLog(QObject *parent = 0);
~SaveLog();
private:
static QScopedPointer<SaveLog> self;
//文件对象
QFile *file;
//是否重定向到网络
bool toNet;
//日志文件路径
QString path;
//日志文件名称
QString name;
//日志文件完整名称
QString fileName;
signals:
void send(const QString &content);
public slots:
//启动日志服务
void start();
//暂停日志服务
void stop();
//保存日志
void save(const QString &content);
//设置是否重定向到网络
void setToNet(bool toNet);
//设置日志文件存放路径
void setPath(const QString &path);
//设置日志文件名称
void setName(const QString &name);
};
class SendLog : public QObject
{
Q_OBJECT
public:
static SendLog *Instance();
explicit SendLog(QObject *parent = 0);
~SendLog();
private:
static QScopedPointer<SendLog> self;
QTcpSocket *socket;
QTcpServer *server;
private slots:
void newConnection();
public slots:
//发送日志
void send(const QString &content);
};
#endif // SAVELOG_H
#include "savelog.h"
#include "qmutex.h"
#include "qfile.h"
#include "qtcpsocket.h"
#include "qtcpserver.h"
#include "qdatetime.h"
#include "qapplication.h"
#include "qtimer.h"
#include "qstringlist.h"
#define QDATE qPrintable(QDate::currentDate().toString("yyyy-MM-dd"))
//日志重定向
#if (QT_VERSION <= QT_VERSION_CHECK(5,0,0))
void Log(QtMsgType type, const char *msg)
#else
void Log(QtMsgType type, const QMessageLogContext &, const QString &msg)
#endif
{
//加锁,防止多线程中qdebug太频繁导致崩溃
QMutex mutex;
QMutexLocker locker(&mutex);
QString content;
//这里可以根据不同的类型加上不同的头部用于区分
switch (type) {
case QtDebugMsg:
content = QString("%1").arg(msg);
break;
case QtWarningMsg:
content = QString("%1").arg(msg);
break;
case QtCriticalMsg:
content = QString("%1").arg(msg);
break;
case QtFatalMsg:
content = QString("%1").arg(msg);
break;
}
SaveLog::Instance()->save(content);
}
QScopedPointer<SaveLog> SaveLog::self;
SaveLog *SaveLog::Instance()
{
if (self.isNull()) {
QMutex mutex;
QMutexLocker locker(&mutex);
if (self.isNull()) {
self.reset(new SaveLog);
}
}
return self.data();
}
SaveLog::SaveLog(QObject *parent) : QObject(parent)
{
//必须用信号槽形式,不然提示 QSocketNotifier: Socket notifiers cannot be enabled or disabled from another thread
//估计日志钩子可能单独开了线程
connect(this, SIGNAL(send(QString)), SendLog::Instance(), SLOT(send(QString)));
file = new QFile(this);
toNet = false;
//默认取应用程序根目录
path = qApp->applicationDirPath();
//默认取应用程序可执行文件名称
QString str = qApp->applicationFilePath();
QStringList list = str.split("/");
name = list.at(list.count() - 1).split(".").at(0);
fileName = "";
}
SaveLog::~SaveLog()
{
file->close();
}
//安装日志钩子,输出调试信息到文件,便于调试
void SaveLog::start()
{
#if (QT_VERSION <= QT_VERSION_CHECK(5,0,0))
qInstallMsgHandler(Log);
#else
qInstallMessageHandler(Log);
#endif
}
//卸载日志钩子
void SaveLog::stop()
{
#if (QT_VERSION <= QT_VERSION_CHECK(5,0,0))
qInstallMsgHandler(0);
#else
qInstallMessageHandler(0);
#endif
}
void SaveLog::save(const QString &content)
{
//如果重定向输出到网络则通过网络发出去,否则输出到日志文件
if (toNet) {
emit send(content);
} else {
//方法改进:之前每次输出日志都打开文件,改成只有当日期改变时才新建和打开文件
QString fileName = QString("%1/%2_log_%3.txt").arg(path).arg(name).arg(QDATE);
if (this->fileName != fileName) {
this->fileName = fileName;
if (file->isOpen()) {
file->close();
}
file->setFileName(fileName);
file->open(QIODevice::WriteOnly | QIODevice::Append | QFile::Text);
}
QTextStream logStream(file);
logStream << content << "\n";
}
}
void SaveLog::setToNet(bool toNet)
{
this->toNet = toNet;
}
void SaveLog::setPath(const QString &path)
{
this->path = path;
}
void SaveLog::setName(const QString &name)
{
this->name = name;
}
//网络发送日志数据类
QScopedPointer<SendLog> SendLog::self;
SendLog *SendLog::Instance()
{
if (self.isNull()) {
QMutex mutex;
QMutexLocker locker(&mutex);
if (self.isNull()) {
self.reset(new SendLog);
}
}
return self.data();
}
SendLog::SendLog(QObject *parent)
{
socket = NULL;
server = new QTcpServer(this);
connect(server, SIGNAL(newConnection()), this, SLOT(newConnection()));
int listenPort = 6000;
#if (QT_VERSION > QT_VERSION_CHECK(5,0,0))
server->listen(QHostAddress::AnyIPv4, listenPort);
#else
server->listen(QHostAddress::Any, listenPort);
#endif
}
SendLog::~SendLog()
{
if (socket != NULL) {
socket->disconnectFromHost();
}
server->close();
}
void SendLog::newConnection()
{
while (server->hasPendingConnections()) {
socket = server->nextPendingConnection();
}
}
void SendLog::send(const QString &content)
{
if (socket != NULL && socket->isOpen()) {
socket->write(content.toUtf8());
socket->flush();
}
}

欢迎关注微信公众号：Qt实战/Qt入门和进阶(各种开源作品、经验整理、项目实战技巧，专注Qt/C++软件开发，视频监控、物联网、工业控制、嵌入式软件、国产化系统应用软件开发) QQ：517216493 WX：feiyangqingyun QQ群：751439350

分享到 淘江湖新浪 QQ微博 QQ空间开心人人豆瓣网易微博百度鲜果白社会飞信

离线aiwen.zhang

新手上路

只看该作者 1楼发表于: 2019-03-10

太强了。

离线jokerhuang

新手上路

只看该作者 2楼发表于: 2019-03-11

我想说，真的开心死我了！从楼主的分享代码里学到了好多编程知识！

离线九重水

圣骑士

只看该作者 3楼发表于: 2019-03-11

九年？
哪年毕业的？

离线richards

新手上路

只看该作者 4楼发表于: 2019-03-12

这个不错。我用过最好用的就是 android的 monitor logcat

离线ccazqyy

新手上路

只看该作者 5楼发表于: 2019-03-12

离线liuchangyin

骑士

只看该作者 6楼发表于: 2019-03-12

很实用

离线kaikai_king

新手上路

只看该作者 7楼发表于: 2019-03-14

大佬带带我

离线vaehate

新手上路

只看该作者 8楼发表于: 2019-03-25

终于等到大佬发帖了

离线mengjin

新手上路

只看该作者 9楼发表于: 2019-03-26

学习了

离线liuyuanan

侠客

只看该作者 10楼发表于: 2019-04-24

我们现在使用的日志库是qt4log开源库，唯一的遗憾是不能通过网络转发

离线greensky10

新手上路

只看该作者 11楼发表于: 2019-05-14

感谢刘大佬分享！！！

离线0011411

新手上路

只看该作者 12楼发表于: 2019-11-19

离线lizn520

新手上路

只看该作者 13楼发表于: 2020-02-02

您好，我阅读完您这个代码有个疑问，
void Log(QtMsgType type, const QMessageLogContext &, const QString &msg)
#endif
{
    //加锁,防止多线程中qdebug太频繁导致崩溃
    QMutex mutex;
    QMutexLocker locker(&mutex);
    QString content;
...
请问这个mutex在这起作用了吗，按我的理解这里应该改成 static QMutex mutex才对呀，

离线104399

新手上路

只看该作者 14楼发表于: 2020-05-05

多谢

离线toby520

论坛版主

只看该作者 15楼发表于: 2020-05-18

回 lizn520 的帖子

lizn520:您好，我阅读完您这个代码有个疑问，
void Log(QtMsgType type, const QMessageLogContext &, const QString &msg)
#endif
{
//加锁,防止多线程中qdebug太频繁导致崩溃
....... (2020-02-02 23:48)

理解的很对需要优化

QtQML多多指教开发社区 http://qtclub.heilqt.com
将QtCoding进行到底
关注移动互联网，关注金融
开发跨平台客户端，服务于金融行业
专业定制界面
群号:312125701 373955953(qml控件定做)

离线zipl1985

新手上路

只看该作者 16楼发表于: 2022-07-23

学习了，太感谢了


	http://www.qtcn.org/bbs 访问内容超出本站范围，不能确定是否安全


	关闭您还没有登录，快捷通道只有在登录后才能使用。立即登录还没有帐号？赶紧注册一个

帖子

Qt编写调试日志输出类带网络转发（开源） [复制链接]