• 531阅读
  • 5回复

Qt自制简易好看的日志系统 [复制链接]

上一主题 下一主题
离线dd759378563
 

只看楼主 倒序阅读 楼主  发表于: 05-01
github仓库链接

简介

一个完善的软件工程,自然是少不了log系统的。
这次涛哥教大家,用最少的代码做一个轻量又好看的log系统。
涛哥知道有现成的log4cpp、log4cplus之类的,也有使用过。
这次是抱着学习的心态来造这个轮子的,造轮子的过程才能学到
更多知识,才能有进步、有提升,难道不是么?


预览

先看一下成果



原理



html格式的log

为了实现 “代码最少” 和 “好看” 的需求,涛哥把log写进了一个html文件。
这样的log相当于一个静态的网页,只要装有浏览器的操作系统,都可以打开并看到上面图示那样的log。
涛哥给这个html文件设计了一个固定的模板的:

  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html>
  4. <head>
  5.     <title>TaoLogger</title>
  6.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7.     <style type="text/css" id="logCss">
  8.         body {
  9.             background: #18242b;
  10.             color: #afc6d1;
  11.             margin-right: 20px;
  12.             margin-left: 20px;
  13.             font-size: 14px;
  14.             font-family: Arial, sans-serif, sans;
  15.         }
  16.         a {
  17.             text-decoration: none;
  18.         }
  19.         a:link {
  20.             color: #a0b2bb;
  21.         }
  22.         a:active {
  23.             color: #f59504;
  24.         }
  25.         a:visited {
  26.             color: #adc7d4;
  27.         }
  28.         a:hover {
  29.             color: #e49115;
  30.         }
  31.         h1 {
  32.             text-align: center;
  33.         }
  34.         h2 {
  35.             color: #ebe5e5;
  36.         }
  37.         .d,
  38.         .w,
  39.         .c,
  40.         .f,
  41.         .i {
  42.             padding: 3px;
  43.             overflow: auto;
  44.         }
  45.         .d {
  46.             background-color: #0f1011;
  47.             color: #a8c1ce;
  48.         }
  49.         .i {
  50.             background-color: #294453;
  51.             color: #a8c1ce;
  52.         }
  53.         .w {
  54.             background-color: #7993a0;
  55.             color: #1b2329;
  56.         }
  57.         .c {
  58.             background-color: #ff952b;
  59.             color: #1d2930;
  60.         }
  61.         .f {
  62.             background-color: #fc0808;
  63.             color: #19242b;
  64.         }
  65.     </style>
  66. </head>
  67. <body>
  68.     <h1><a href="https://jaredtao.github.io">TaoLogger</a> 日志文件</h1>
  69.     <script type="text/JavaScript">
  70.         function objHide(obj) {
  71.             obj.style.display="none"
  72.         }
  73.         function objShow(obj) {
  74.             obj.style.display="block"
  75.         }
  76.         function selectType() {
  77.             var sel = document.getElementById("typeSelect");
  78.             const hideList = new Set(['d', 'i', 'w', 'c', 'f']);
  79.             if (sel.value === 'a') {
  80.                 hideList.forEach(element => {
  81.                     var list = document.querySelectorAll('.' + element);
  82.                     list.forEach(objShow);
  83.                 });
  84.             } else {
  85.                 var ss = hideList;
  86.                 ss.delete(sel.value);
  87.                 ss.forEach(element => {
  88.                     var list = document.querySelectorAll('.' + element);
  89.                     list.forEach(objHide);
  90.                 });
  91.                 var showList = document.querySelectorAll('.' + sel.value);
  92.                 showList.forEach(objShow);
  93.             }
  94.         }
  95.     </script>
  96.     <select id="typeSelect" onchange="selectType()">
  97.         <option value='a' selected="selected">All</option>
  98.         <option value='d'>Debug</option>
  99.         <option value='i'>Info</option>
  100.         <option value='w'>Warning</option>
  101.         <option value='c'>Critical</option>
  102.         <option value='f'>Fatal</option>
  103.     </select>



(如果你不懂html,也没关系,直接拿过去用就好了)
这个模板只使用了一些很基本的html元素和css样式表,筛选器那里用了一点JavaScript。
(筛选器功能,我去请教了一下前端的同事,给了我一个JQuery版本,只要很少几行代码,但是要带上一个大大的JQuery.js。。。)
(涛哥我也写了不少qml,多多少少还是懂点js的,于是就自己写了这么一个筛选器。不到20行代码,真是自己动手丰衣足食啊。)
  • Log模板的用法
很简单的,模板作为html文件的前面部分,接下来每一行log,以追加的方式跟在模板后面就行了。
(html的body结束标记并没有写,浏览器都能正常打开。容错性真的强!)
当然, 每一条log有个格式要求:
    
  1. <div class="d"> 山有木兮木有枝,心悦君兮君不知。</div>



就是增加了一对div标记, div的class属性要设置为d、i、w、c、f这几个字符中的一个,分别是
debug、info、warning、critical、fatal的首字母, 这正是Qt所提供的log分类。
设置div的class属性,就是给筛选器用来做筛选。
  • Log模板的存取
文件读取? 不,太慢了。
这就是一段固定的字符串,直接编译进代码里,程序启动的时候直接装载到内存就好了。
那么C++里面,怎么才能装下这段带有转义字符的字符串呢?涛哥的答案是:C++11的 “原始字符串字面量”或者叫 “R字符串”
可以参考这里 cppreference
简单来说,是这样写的:
  1. string logTemplate = R"(xxxxxx)";



只要有了 R"(  )" 这个写法,括号中间随便写转义字符、换行符都行。当然为了方便让编译器识别哪个
才是真正的’结束括号’,C++11标准提出了括号前后增加分隔符的写法,即:
  1. string logTemplate = R"prefix(xxxxxx)prefix";

左括号的前面和右括号的后面, 是同样的一段字符串作为分隔符就行了。
涛哥的代码里是这么用的
  1. namespace Logger
  2. {
  3.     const static QString logTemplate = u8R"logTemplate(
  4. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  5. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  6. <html>
  7. <head>
  8.     <title>TaoLogger</title>
  9.     ...
  10.     这里省略一大堆html代码
  11.     ...
  12.     )logTemplate";
  13. }






Qt的log系统

  • Qt的log分类
Qt的打印信息,大家普遍使用的是qDebug,不过Qt除了qDebug,还有qInfo, qWarning, qCritical等等。
涛哥翻了Qt5.12的源码,发现这几个打印最终都是通过fprintf(stderr)或者fprintf(stdout)来实现输出的,
不同的地方就在于Log类型。如果要用好这个分类,那我们平时使用打印的时候,就要注意做区分:
- 调试信息用qDebug- 常规信息用qInfo- 警告用qWarning- 比较严重的问题qCritical
  • Qt的log格式化
Qt提供了一个函数qSetMessagePattern,用来定制输出信息。
例如:
  1. qSetMessagePattern("[%{time yyyyMMdd h:mm:ss.zzz t} %{if-debug}D%{endif}%{if-info}I%{endif}%{if-warning}W%{endif}%{if-critical}C%{endif}%{if-fatal}F%{endif}] %{file}:%{line} - %{message}");



一般只要在main.cpp中添加这一行代码,之后的qDebug、qInfo等函数都会按照这个格式来输出,包含了
时间戳、log类型、文件名、行号 等信息。也可以不改任何代码、改环境变量来做到

  • Release模式信息缺失
这里有个问题,就是文件名和行号在debug模式正常,Release模式会变成空的。
要解决这个问题,那么就需要编译器提供的内置宏__FILE__ 和 __LINE__了
涛哥写了这样几个宏,代替qDebug和qInfo等函数。
  1. #define LOG_DEBUG qDebug() << __FILE__ << __FUNCTION__ << __LINE__
  2. #define LOG_INFO qInfo() << __FILE__ << __FUNCTION__ << __LINE__
  3. #define LOG_WARN qWarning() << __FILE__ << __FUNCTION__ << __LINE__
  4. #define LOG_CRIT qCritical() << __FILE__ << __FUNCTION__ << __LINE__




用法类似这样:
  1. LOG_DEBUG << u8"山有木兮木有枝,心悦君兮君不知。";


  • Qt的写log文件
Qt还提供了一个函数 qInstallMessageHandler,可以插入一个回调函数,让每一行qDebug/qInfo等
函数的打印信息,都经过这个回调来处理。看一下帮助文档:

其实帮助文档已经提供了一个简易的log功能,涛哥就是在这个功能的基础上,做了一些定制化的修改。


融合


  • log存储路径和容量
涛哥写了一个函数和一组静态变量,用来设置和记录log存储的路径和容量
头文件中的声明
  1. #pragma once
  2. #include <QDebug>
  3. namespace Logger
  4. {
  5. //默认存储路径为当前路径的Log文件夹下,默认文件数量为1024
  6. void initLog(const QString& logPath = QStringLiteral("Log"), int logMaxCount = 1024);
  7. } // namespace Logger

  • log存储
  1. namespace Logger
  2. {
  3. //静态变量,记录存储路径
  4. static QString gLogDir;
  5. //静态变量,记录最大存储数量
  6. static int gLogMaxCount;
  7. void initLog(const QString &logPath, int logMaxCount)
  8. {
  9.     //安装回调
  10.     qInstallMessageHandler(outputMessage);
  11.     //记录路径
  12.     gLogDir = QCoreApplication::applicationDirPath() + "/" + logPath;
  13.     //记录最大存储数
  14.     gLogMaxCount = logMaxCount;
  15.     //检查存储文件夹,不存在则创建
  16.     QDir dir(gLogDir);
  17.     if (!dir.exists())
  18.     {
  19.         dir.mkpath(dir.absolutePath());
  20.     }
  21.     //获取文件列表
  22.     QStringList infoList = dir.entryList(QDir::Files, QDir::Name);
  23.     //硬盘空间有限,超过最大存储数的都删掉。
  24.     while (infoList.size() > gLogMaxCount)
  25.     {
  26.         //每次删第一个。文件名其实是默认按时间排序的,第一个就是时间最早的。
  27.         dir.remove(infoList.first());
  28.         infoList.removeFirst();
  29.     }
  30. }
  31. static void outputMessage(QtMsgType type, const QMessageLogContext &context, const QString &msg)
  32. {
  33.     //
  34. }
  35. }
  36. ```
  37. * log存储
  38. ```C++
  39. static void outputMessage(QtMsgType type, const QMessageLogContext &context, const QString &msg)
  40. {
  41.     //每一条消息的约定格式。%1即log类型,%2即log内容。这里用静态变量,每次用的时候填充
  42.     //生成一个QString副本,达到最大程度的复用。
  43.     static const QString messageTemp= QString("<div class=\"%1\">%2</div>\r\n");
  44.     //预定的消息类型映射表
  45.     static const char typeList[] = {'d', 'w', 'c', 'f', 'i'};
  46.     //锁
  47.     static QMutex mutex;
  48.     //取时间
  49.     QDateTime dt = QDateTime::currentDateTime();
  50.     
  51.     //时间作为文件名
  52.     //每分钟一个文件
  53.     //QString fileNameDt = dt.toString("yyyy-MM-dd_hh_mm");
  54.     //每小时一个文件
  55.     QString fileNameDt = dt.toString("yyyy-MM-dd_hh");
  56.     //每天一个文件
  57.     //QString fileNameDt = dt.toString("yyyy-MM-dd_");
  58.     //时间戳
  59.     QString contentDt = dt.toString("yyyy-MM-dd hh:mm:ss");
  60.     //消息的前面写上时间戳,后面写内容。 msg如果是用LOG_WARN那几个宏打印的,本身已经带了文件名和行号了。
  61.     QString message = QString("%1 %2").arg(contentDt).arg(msg);
  62.     
  63.     //组装一条html格式的log
  64.     QString htmlMessage = messageTemp.arg(typeList[static_cast<int>(type)]).arg(message);
  65.     QFile file(QString("%1/%2_log.html").arg(gLogDir).arg(fileNameDt));
  66.     //这里开始锁起来,多线程安全
  67.     mutex.lock();
  68.     bool exist = file.exists();
  69.     //写 | 追加的方式
  70.     file.open(QIODevice::WriteOnly | QIODevice::Append);
  71.     //文件流
  72.     QTextStream text_stream(&file);
  73.     //注意字符编码
  74.     text_stream.setCodec("UTF-8");
  75.     if (!exist)
  76.     {
  77.         //文件不存在的情况下,先把我们的html模板写进去。
  78.         text_stream << logTemplate << "\r\n";
  79.     }
  80.     //往文件流里面追加数据
  81.     text_stream << htmlMessage;
  82.     file.close();
  83.     mutex.unlock();
  84.     //解锁
  85.     
  86.     //把log都写到文件了,QtCreator 或者VS 不就看不到输出了?
  87.     //这里用Win32的方式多加了一次输出,当然也可以使用std::cout fprintf。不能再使用qDebug了,因为这是在qDebug的回调里,会无限递归调用的。
  88.     ::OutputDebugString(message.toStdWString().data());
  89.     ::OutputDebugString(L"\r\n");
  90. }



文件句柄复用

有朋友(Qt侠- 刘典武)指出了优化的地方,应该复用文件句柄,不要每次都打开关闭文件,所以涛哥改了一下。
这里贴个小乌龟的变更图吧,当然github上也有变更记录的。



多线程测试

涛哥同时起了8个线程,每个线程输出1000条log信息,并统计最终结果。


代码去github吧。



github仓库链接

TaoLogger


转载声明

文章出自涛哥的博客 – 点击这里查看涛哥的博客本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可进行许可, 转载请注明出处, 谢谢合作 © 涛哥


联系方式

    
作者涛哥
开发理念弘扬鲁班文化,传承工匠精神
博客https://wentaojia2014.github.io
知乎https://www.zhihu.com/people/wentao-jia
邮箱jared2020@163.com
微信xsd2410421
QQ759378563
    
请放心联系我,乐于提供咨询服务,也可洽谈有偿技术支持相关事宜。


打赏

    
觉得分享的内容还不错, 就请作者喝杯奶茶吧~~





涛哥是个Qml高手,著有《Qml组件化编程》《Qml特效》系列教程,见知乎专栏-Qt进阶之路:https://zhuanlan.zhihu.com/TaoQt
或微信公众号:Qt进阶之路
在线lsyzsl

只看该作者 1楼 发表于: 05-01
喜欢鲁班文化,因为我出生在一个木匠世家。以后多多关注涛哥。 ,劳动人民最美丽。劳动节快乐。
离线dd759378563

只看该作者 2楼 发表于: 05-18
代码格式改好了
涛哥是个Qml高手,著有《Qml组件化编程》《Qml特效》系列教程,见知乎专栏-Qt进阶之路:https://zhuanlan.zhihu.com/TaoQt
或微信公众号:Qt进阶之路
离线chamsdoncon

只看该作者 3楼 发表于: 06-11
    
离线往事纯白

只看该作者 4楼 发表于: 06-19
在写的过程中界面是卡住的
离线dd759378563

只看该作者 5楼 发表于: 06-21
回 往事纯白 的帖子
往事纯白:
在写的过程中界面是卡住的

感谢反馈,修改了一下。主要是std::thread join了之后,会让当前线程等待。

涛哥是个Qml高手,著有《Qml组件化编程》《Qml特效》系列教程,见知乎专栏-Qt进阶之路:https://zhuanlan.zhihu.com/TaoQt
或微信公众号:Qt进阶之路
快速回复
限100 字节
 
上一个 下一个