Qt+QtWebApp开发笔记：http服务器日志系统介绍添加日志系统至Demo测试
Posted 红胖子(红模仿)
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Qt+QtWebApp开发笔记：http服务器日志系统介绍添加日志系统至Demo测试相关的知识，希望对你有一定的参考价值。
前言
上一篇使用QtWebApp的基于Qt的轻量级http服务器实现了一个静态网页返回的Demo，网页服务器很重要的就是日志，因为在服务器类上并没有直接返回，所以，本篇先把日志加上。
可以简单地将输出重定向到一个文件（MyFirstWebApp>logfile.txt），但这有两个问题：
- 在许多系统上，输出重定向有些慢。
- 日志文件将变得无限大，如果不短时间停止web服务器，就无法防止这种情况发生。
因此，最好让web服务器自己将所有消息写入文件。这就是记录器模块的作用。
要将日志模块的源代码包括到项目中，请在项目文件中添加一行：
include(../QtWebApp/QtWebApp/logging/logging.pri)
这个而模块也是QtWebApp的logging模块，如下：
然后在程序的*.ini文件中添加另一个部分：
[logging]
minLevel=WARNING
bufferSize=100
fileName=../logs/webapp1.log
maxSize=1000000
maxBackups=2
timestampFormat=dd.MM.yyyy hh:mm:ss.zzz
msgFormat=timestamp typeNr type thread msg
日志级别有：DEBUG（别名ALL）、INFO、WARN或WARNING、CRITICAL（别名ERROR）、FATAL。信息级别由Qt 5.5引入。
上面的示例配置启用线程本地缓冲区，**这些缓冲区将不太重要的消息保留在内存中，直到出现警告或严重错误。**然后，错误消息与收集到的低级消息一起写入日志文件。只要一切正常，使用缓冲区可以大大减少日志文件的大小。像这样的系统操作员。
但是，缓冲区的内存和性能成本都很高。收益通常大于成本。要禁用缓冲区，请将bufferSize设置为0。在这种情况下，只有配置了minLevel及以上级别的消息才会写入日志文件。
如果没有指定文件名，则记录器会写入控制台。日志文件的路径可以是绝对路径，也可以是相对于配置文件的文件夹的路径。maxSize参数限制日志文件的大小（以字节为单位）。当超过此限制时，记录器将启动一个新文件。设置maxBackups指定磁盘上应保留多少旧日志文件。
时间戳格式设置的作用。QDateTime::toString()的文档以获得对字符的解释，还有更多可用的内容。msgFormat设置指定每条消息的格式。以下字段可用：
- timestamp：创建日期和时间
- typeNr：数字格式的消息类型或级别(0=DEBUG, 4=INFO, 1=WARNING, 2=CRITICAL, 3=FATAL)
- type：字符串格式的消息类型或级别(DEBUG, INFO, WARNING, CRITICAL, FATAL)
- thread：线程的ID号
- msg：消息文本
- xxx：可以自己定义的任何记录器变量QT 5.0及更新版本在调试模式下有一些附加变量：
file：Filename of source code where the message was generated
function：Function where the message was generated
line：Line number where the message was generated
Qt开发人员将这三个字段添加到他们的框架中。也可以使用\\n在消息格式中插入换行符和插入 制表符。上述所有变量也可以在日志消息中使用，例如：
qCritical("An error occured in file: out of disk space");
需要一个指向FileLogger实例的全局指针，以便整个程序都可以访问它。首先添加到global.h:
#include "httpsessionstore.h"
#include "staticfilecontroller.h"
#include "templatecache.h"
#include "filelogger.h"
using namespace stefanfrings;
/** Storage for session cookies */
extern HttpSessionStore* sessionStore;
/** Controller for static files */
extern StaticFileController* staticFileController;
/** Cache for template files */
extern TemplateCache* templateCache;
/** Redirects log messages to a file */
extern FileLogger* logger;
#endif // GLOBAL_H
global.cpp:
#include "global.h"
HttpSessionStore* sessionStore;
StaticFileController* staticFileController;
TemplateCache* templateCache;
FileLogger* logger;
在main.cpp中，配置FileLogger的实例：
int main(int argc, char *argv[])
QCoreApplication app(argc, argv);
QString configFileName=searchConfigFile();
// Configure logging
QSettings* logSettings=new QSettings(configFileName,QSettings::IniFormat,&app);
logSettings->beginGroup("logging");
logger=new FileLogger(logSettings,10000,&app);
logger->installMsgHandler();
// Log the library version
qDebug("QtWebApp has version %s",getQtWebAppLibVersion());
// Session store
QSettings* sessionSettings=new QSettings(configFileName,QSettings::IniFormat,&app);
sessionSettings->beginGroup("sessions");
sessionStore=new HttpSessionStore(sessionSettings,&app);
// Static file controller
QSettings* fileSettings=new QSettings(configFileName,QSettings::IniFormat,&app);
fileSettings->beginGroup("files");
staticFileController=new StaticFileController(fileSettings,&app);
// Configure template cache
QSettings* templateSettings=new QSettings(configFileName,QSettings::IniFormat,&app);
templateSettings->beginGroup("templates");
templateCache=new TemplateCache(templateSettings,&app);
// HTTP server
QSettings* listenerSettings=new QSettings(configFileName,QSettings::IniFormat,&app);
listenerSettings->beginGroup("listener");
new HttpListener(listenerSettings,new RequestMapper(&app),&app);
return app.exec();
数字10000是以毫秒为单位的刷新间隔，记录器使用它来重新加载配置文件。因此，可以在程序运行时编辑任何记录器设置，并且更改在几秒钟后生效，而无需重新启动服务器。如果不希望自动重新加载，请使用值0。
给了一个示例代码，用于查询和记录库的版本号。一些人要求添加该功能。
不要忘记创建一个空文件夹MyFirstWebApp/logs。记录器本身不会创建文件夹。
现在可以启动应用程序并查看会发生什么。因为程序没有错误，所以日志文件保持为空。但 可以看到控制台窗口中的输出已降至最低：
让在logincontroller.cpp中插入一条qCritical()消息，然后可以看到日志缓冲区工作：
然后打开URLhttp://localhost:8080/login?username=test&password=wrong.
再次查看日志文件，它就在那里：
现在通过将min Level降低到DEBUG来进行另一个测试。保存ini文件，等待10秒，然后打开URLhttp://localhost:8080/hello.再次检查日志文件。可以看到，尽管没有发生错误，但现在所有的调试消息都已写入。因此，在不重新启动程序的情况下更改日志级别可以很好地工作。
其实这个很容易看出来，是直接对qt的几个日志等级进行了（PS：这个日志库还不错，installMsgHandler可以截断qDebug等相关的错误信息，可以直接无缝使用到每一个qt项目中，有这个兴趣可以试一试）。
写到记录器支持用户定义的变量。这些变量是线程本地的，在清除它们之前一直保留在内存中。对于web应用程序，在每条消息中记录当前用户的名称可能很有用。向requestmapper.cpp添加代码以设置记录器变量：
void RequestMapper::service(HttpRequest& request, HttpResponse& response)
QByteArray path=request.getPath();
qDebug("RequestMapper: path=%s",path.data());
HttpSession session=sessionStore->getSession(request,response,false);
QString username=session.get("username").toString();
logger->set("currentUser",username);
...
通过这种方式，请求映射器在将请求传递给控制器类之前，为所有传入的HTTP请求查询调用用户的名称。
现在可以修改ini文件以使用该变量：
msgFormat=timestamp typeNr type thread User:currentUser msg
运行程序并打开URLhttp://localhost:8080/login?username=test&password=hello两次。然后再次检查日志文件：
在用户登录之前，可以看到变量｛currentUser｝为空。然后，所有以下请求都会以该用户的名称记录。
注意：在RequestMapper类中放置了许多静态资源（logger、sessionStore、staticFileController、templateCache）。在实际应用程序中，建议创建一个单独的类，例如名称为“Globals”的类，这样每个人都知道在哪里可以找到这样的资源。或者按照在Demo1项目中的例子，将它们放在任何类之外的cpp源文件中。
由于线程被重新用于后续的HTTP请求，记录器可能会输出更多的细节。例如，假设第一个成功的HTTP请求会产生一些隐藏的调试消息，然后由同一线程处理的第二个请求会产生错误。然后，日志文件将包含错误消息以及所有缓冲的调试消息。但其中一些来自以前的HTTP请求，并不需要它。
要清除两个HTTP请求之间的缓冲区，请添加到requestmapper.cpp：
void RequestMapper::service(HttpRequest& request, HttpResponse& response)
...
else
response.setStatus(404,"Not found");
response.write("The URL is wrong, no such document.");
qDebug("RequestMapper: finished request");
logger->clear(true,true);
因此，每当HTTP请求的处理完成时，都要清理记录器的内存。当同一个线程处理下一个请求时，它将以空缓冲区开始。(碰到错误则会输出到文件，所以一个http请求完成了，就是其前面的日志都是无错误，所以可以清空了)。
该项目还包含一个DualFileLogger类，可用于并行生成两个日志文件。这可能对以下设置组合有用：
- 主记录日志文件
minLevel=INFO
bufferSize=0
- 第二日志文件
minLevel=ERROR (or WARNING)
bufferSize=100
这样，主日志文件就不包含调试消息。但是，当发生错误时，辅助日志文件会包含该错误以及多达100条相关的调试消息。如果错误消息本身无法识别问题原因，则此文件特别有用。
这个日志logging模块起到的最大作用，是因为在QtWebApp三方源码中的qDebug，qWarn，QFatal等相关系统直接输出到控制台的，使用该日志则截断才可以获取httpservice模块以及其他模块中的打印调试信息，而这些信息是在函数返回值中没有体现的。
为了能查看到三方模块日志，则必须要使用logging模块，或者自己写一个模块去截断，或者直接修改三方源码中的调试信息的代码。
使用httpservice肯定是最好使用logging模块了。
准备之前的demo模板：
将QtWebApp中的logging，符合模块化设计准则，如下图：
拷贝到的Demo
添加模块进入工程：
# logging模块，QtWebApp自带的三方模块
include ($$PWD/modules/logging/logging.pri)
第三方的模块。
先把上一篇的Demo配置文件加了listener之后就读不出的问题解决了，其实区别关键在下面：
beginGroup就是进入了这一组，这一组拿到key就可以不带前缀。
然后开始添加日志配置，也在httpServerManager，因为配置文件beginGroup之后就是操作单独一组了，这里从第三方源码中也可以看出来：
本次加入logging，也要进行配置文件分组的区分，原来的_pSettings改成_pHttpListenerSettings，然后新增_pLoggingListenerSettings用于配置logging模块的配置实例：
至此，日志加入成功
修改下日志时间：
记录日志则是：
#ifndef HTTPSERVERMANAGER_H
#define HTTPSERVERMANAGER_H
#include <QObject>
#include <QMutex>
#include "httplistener.h"
#include "filelogger.h"
#include "HelloWorldRequestHandler.h"
class HttpServerManager : public QObject
Q_OBJECT
private:
explicit HttpServerManager(QObject *parent = 0);
public:
static HttpServerManager *getInstance();
public slots:
void slot_start(); // 开启线程
void slot_stop(); // 停止线程
private:
static HttpServerManager *_pInstance;
static QMutex _mutex;
private:
bool _running; // 运行状态
private:
HttpListener *_pHttpListener; // http服务监听器
QSettings *_pHttpListenerSettings; // http服务器配置文件
FileLogger *_pFileLogger; // 日志记录
QSettings *_pFileLoggerSettings; // 日志配置文件
private:
QString _ip; // 服务器监听ip（若为空，则表示监听所有ip）
quint16 _port; // 服务器监听端口
int _minThreads; // 空闲最小线程数
int _maxThreads; // 负载最大线程数
int _cleanupInterval; // 空线程清空间隔（单位：毫秒）
int _readTimeout; // 保持连接空载超时时间（单位：毫秒）
int _maxRequestSize; // 最大请求数
int _maxMultiPartSize; // 上载文件最大数（单位：字节）
;
#endif // HTTPSERVERMANAGER_H
#include "HttpServerManager.h"
#include <QApplication>
#include <QDir>
#include <QDebug>
#include <QDateTime>
//#define LOG qDebug()<<__FILE__<<__LINE__
//#define LOG qDebug()<<__FILE__<<__LINE__<<__FUNCTION__
//#define LOG qDebug()<<__FILE__<<__LINE__<<QThread()::currentThread()
//#define LOG qDebug()<<__FILE__<<__LINE__<<QDateTime::currentDateTime().toString("yyyy-MM-dd")
#define LOG qDebug()<<__FILE__<<__LINE__<<QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss:zzz")
HttpServerManager *HttpServerManager::_pInstance = 0;
QMutex HttpServerManager::_mutex;
HttpServerManager::HttpServerManager(QObject *parent)
: QObject(parent),
_pHttpListener(0),
_pHttpListenerSettings(0),
_pFileLogger(0),
_pFileLoggerSettings(0),
_running(false),
_port(8088),
_minThreads(2),
_maxThreads(10),
_cleanupInterval(60000),
_readTimeout(60000),
_maxRequestSize(100),
_maxMultiPartSize(1024*1024*1024)
HttpServerManager *HttpServerManager::getInstance()
if(!_pInstance)
QMutexLocker lock(&_mutex);
if(!_pInstance)
_pInstance = new HttpServerManager();
return _pInstance;
void HttpServerManager::slot_start()
if(_running)
LOG << "It\'s running!!!";
return;
_running = true;
LOG << "Succeed to run";
QString httpServerPath = QString("%1/etc/httpServer.ini").arg(qApp->applicationDirPath());
LOG << httpServerPath << "exit:" << QFile::exists(httpServerPath);
// 启动日志几里路
if(!_pFileLoggerSettings)
_pFileLoggerSettings = new QSettings(httpServerPath, QSettings::IniFormat);
_pFileLoggerSettings->beginGroup("logging");
// 日志不会主动创建文件夹，这里需要补全
QFileInfo fileInfo(httpServerPath);
QString dirPath = fileInfo.dir().