QAxios研发笔记（一）：在Qt环境下,构建Promise风格的Get请求接口

在Qt环境下,构建Promise风格的Get请求接口

• 一、项目背景与目标
• 二、设计理念与实现思路
• • [1. **Promise风格的设计**](#1. Promise风格的设计)
  • [2. **基于Qt的网络模块**](#2. 基于Qt的网络模块)
  • [3. **支持查询参数**](#3. 支持查询参数)
• 三、核心代码实现
• • [1. **QAxios类的设计**](#1. QAxios类的设计)
  • [2. **Query类的设计**](#2. Query类的设计)
  • [3. **Promise的生命周期管理**](#3. Promise的生命周期管理)
  • [4. **异步回调的绑定**](#4. 异步回调的绑定)
• 四、使用示例
• • [1. **发送GET请求**](#1. 发送GET请求)
  • [2. **SpringBoot服务端代码**](#2. SpringBoot服务端代码)
• 五、优势与不足
• • [1. **优势**](#1. 优势)
  • [2. **不足**](#2. 不足)
• 六、未来展望
• 七、总结

在现代软件开发中，HTTP请求是前后端交互的核心手段之一。前端开发中，Axios因其简洁的API和强大的功能而广受欢迎。然而，在C++环境下，尤其是Qt框架中，开发者往往需要自行实现类似的HTTP请求库。本文将介绍如何在Qt环境下构建一个Promise风格的Get请求接口------QAxios，并详细讲解其实现原理和使用方法。

---

一、项目背景与目标

QAxios的目标是为Qt开发者提供一个类似于Axios的HTTP请求库，支持Promise风格的异步操作。通过QAxios，开发者可以轻松发送HTTP请求，并以Promise的方式处理响应或错误。本文将重点介绍QAxios中Get请求接口的设计与实现。

---

二、设计理念与实现思路

1. Promise风格的设计

Promise风格的核心思想是通过异步操作的链式调用，简化异步代码的编写和维护。在QAxios中，我们通过自定义的CProimse类来实现Promise的功能，支持.then()和.catch()方法。详细实现可以参考基于C++11手撸前端Promise。

2. 基于Qt的网络模块

QAxios基于Qt的QNetworkAccessManager实现HTTP请求。QNetworkAccessManager是Qt网络模块的核心类，支持发送HTTP请求并处理响应。

3. 支持查询参数

为了方便构建包含查询参数的URL，我们设计了一个Query类，支持通过链式调用添加参数，并将参数转换为标准的URL查询字符串。

---

三、核心代码实现

1. QAxios类的设计

QAxios类是整个库的核心类，提供了发送HTTP请求的方法。以下是其关键代码：

class QAXIOS_EXPORT QAxios
{
private:
    QNetworkAccessManager *m_networkAccessManager;

private:
    QAxios();

    AxiosProimse* createAxiosProimse(QNetworkReply *reply);

public:
    static QAxios * axios(const QString& key);        
    AxiosProimse *get(const QString& url, Query* query);
    ~QAxios();
};

• QNetworkAccessManager ：用于管理HTTP请求。
• createAxiosProimse ：根据QNetworkReply创建一个Promise对象，并绑定响应处理逻辑。
• axios ：单例模式的工厂方法，用于获取QAxios实例。
• get ：发送GET请求的方法。

2. Query类的设计

Query类用于构建URL查询参数。以下是其关键代码：

class Query {
public:
    static Query* query();

    Query* addParam(const QString& key, int value);
    Query* addParam(const QString& key, bool value);
    Query* addParam(const QString& key, const QString& value);
    QString toQuery();

private:
    QString m_query;
};

3. Promise的生命周期管理

在createAxiosProimse方法中，Promise对象的生命周期需要特别注意。为了避免内存泄漏，我们在Promise对象的resolve和reject回调中手动释放内存。

QObject::connect(reply, &QNetworkReply::readyRead, [=] {
    // 处理响应
    proimse->resolve(resultResponse);
    if (proimse != nullptr) {
        delete proimse;
    }
});

QObject::connect(reply, &QNetworkReply::errorOccurred, [=](QNetworkReply::NetworkError networkError) {
    // 处理错误
    proimse->reject(...);
    if (proimse != nullptr) {
        delete proimse;
    }
});

4. 异步回调的绑定

通过Qt的信号与槽机制，我们将QNetworkReply的信号绑定到Promise的回调函数中。

QObject::connect(reply, &QNetworkReply::readyRead, [=] {
    // 处理响应
});

QObject::connect(reply, &QNetworkReply::errorOccurred, [=](QNetworkReply::NetworkError networkError) {
    // 处理错误
});

---

四、使用示例

1. 发送GET请求

以下是使用QAxios发送GET请求的示例代码：

QAxios* axios = QAxios::axios("axios");

Query* query = Query::query()
    ->addParam("age", 250)
    ->addParam("username", QString::fromLocal8Bit("勇勇"))
    ->addParam("sex", true);

axios->get("http://127.0.0.1:8060/say", query)
    ->then([=](ResultResponse result) -> void {
        qDebug() << result.toString("message");
    })
    ->catch([=](const std::string& reason) {
        qDebug() << QString::fromStdString(reason);
    });

2. SpringBoot服务端代码

以下是服务端的SpringBoot代码，用于处理GET请求并返回响应：

@GetMapping("/say")
public ResultResponse<Boolean> say(DemoParam param) {
    System.out.println(param);
    return ResultResponse.message("Hello Demo !!!");
}

---

五、优势与不足

1. 优势

• Promise风格：支持异步操作的链式调用，代码简洁易读。
• 支持查询参数 ：通过Query类简化URL查询参数的构建。
• 基于Qt：充分利用Qt的网络模块，保证了跨平台的兼容性。

2. 不足

• 仅支持GET请求：当前版本仅实现了GET请求，后续版本可以扩展支持POST、PUT等其他HTTP方法。
• Promise实现简单 ：当前的Promise实现较为基础，后续可以增加更多的功能，如finally等。

---

六、未来展望

QAxios目前只是一个初步的实现，未来可以进一步扩展其功能，例如：

• 支持更多的HTTP方法（POST、PUT、DELETE等）。
• 增加对请求头和请求体的更多控制。
• 支持文件上传和下载。
• 增加更丰富的Promise功能（如finally）。

---

七、总结

通过本文的介绍，我们了解了如何在Qt环境下构建一个Promise风格的Get请求接口------QAxios。QAxios的核心思想是通过Promise简化异步HTTP请求的编写，并通过Qt的网络模块实现高效的网络通信。希望本文能够为Qt开发者提供一些启发，帮助他们更好地进行HTTP请求的开发。

如果对本文内容感兴趣，可以访问以下链接获取更多详细信息：

• 项目地址：https://gitee.com/shendeyidi/softwarer_qt
• 参考文献：
  • 基于C++11手撸前端Promise：https://shendeyidi.blog.csdn.net/article/details/151896346
  • 深入理解前端 Axios 框架：特性、使用场景与最佳实践：https://shendeyidi.blog.csdn.net/article/details/151986528
  • 解析前端框架 Axios 的设计理念与源码：https://shendeyidi.blog.csdn.net/article/details/152074517
  • 深入理解 Qt 元对象系统：QMetaEnum 的应用与实践：https://shendeyidi.blog.csdn.net/article/details/152136048
  • QT与Spring Boot通信：实现HTTP请求的完整指南：https://shendeyidi.blog.csdn.net/article/details/151924986