QHttp库技术文档

QHttp库技术文档

qhttp a light-weight and asynchronous HTTP library (both server & client) in Qt5 and c++14 项目地址: https://gitcode.com/gh_mirrors/qh/qhttp

QHttp是一款为Qt开发者设计的轻量级、异步且高效的HTTP库，它包含了处理连接、解析和构建HTTP请求与响应所需的服务器与客户端类。本文档旨在提供详细的安装指南、使用方法、API文档以及部署步骤，确保您能够顺利地集成并利用QHttp在您的Qt应用中实现RESTful服务。

安装指南

步骤一：克隆仓库

首先，通过Git将QHttp仓库克隆到本地：

git clone https://github.com/azadkuh/qhttp.git
cd qhttp

步骤二：准备依赖项

执行脚本来下载必要的依赖，这里主要依赖于http-parser：

./update-dependencies.sh

步骤三：编译与安装

随后，使用Qt的qmake工具来生成Makefile，并进行编译：

qmake -r qhttp.pro
make -j 8

这会在xbin/目录下生成库文件和示例可执行文件。

项目的使用说明

创建HTTP服务器

以下代码展示了如何快速搭建一个简单的HTTP服务器：

#include <QCoreApplication>
#include "qhttp/server/QHttpServer.hpp"

int main(int argc, char** argv) {
    QCoreApplication app(argc, argv);
    
    qhttp::server::QHttpServer server(&app);
    server.listen(QHostAddress::Any, 8080, [](qhttp::server::QHttpRequest* req, qhttp::server::QHttpResponse* res) {
        res->setStatusCode(qhttp::ESTATUS_OK);
        res->end("Hello World!\n");
    });

    return server.isListening() ? app.exec() : -1;
}

使用HTTP客户端

发起HTTP GET请求的例子：

#include <QCoreApplication>
#include "qhttp/client/QHttpClient.hpp"

int main(int argc, char** argv) {
    QCoreApplication app(argc, argv);
    
    qhttp::client::QHttpClient client(&app);
    QUrl url("http://wttr.in/tehran");
    client.request(qhttp::EHTTP_GET, url, [](qhttp::client::QHttpResponse* res) {
        res->collectData();
        res->onEnd([](QByteArray data) {
            // 处理数据...
            qDebug() << data;
        });
    });

    return app.exec();
}

项目API使用文档

QHttp提供了易于理解的API，重点在于使用std::function和C++14的通用Lambda表达式，类似Node.js的HTTP模块风格。

• 服务器端：

  • QHttpServer::listen(port, address, requestHandler)：启动服务器监听指定端口。
  • 请求处理器可以定义在Lambda中，自动管理QHttpRequest和QHttpResponse对象的生命周期。

• 客户端：

  • QHttpClient::request(method, url, responseCallback)：发送HTTP请求。
  • 回调函数用于接收响应和数据处理，支持错误处理如超时（通过QHttpClient::setConnectingTimeOut）。

项目部署方式

1. 编译后的库文件需要链接到您的Qt项目中。在Qt Creator中，添加相应的库路径和链接库指令。
2. 确保所有运行所需依赖（如Qt5和C++14标准库）在目标系统上已就位。
3. 对于多平台部署，请注意编译配置是否与目标环境相符，例如编译选项、库版本等。

QHttp的设计注重简洁性和性能，通过其精简的API，Qt开发者能够便捷地融入HTTP服务功能到他们的应用程序之中，无论是创建服务器还是作为客户端与外部服务交互。记住，对于更复杂的场景，可能需要结合Qt自身的网络模块或其他专业工具以获得更全面的功能。

qhttp a light-weight and asynchronous HTTP library (both server & client) in Qt5 and c++14 项目地址: https://gitcode.com/gh_mirrors/qh/qhttp