【QT】实现RestFul接口

在这个教程中，我们将介绍如何在 Qt 中使用 QHttpServer 类来创建一个简单的 HTTP 服务器。QHttpServer 是 Qt 6 引入的新类，用于提供 HTTP 服务。这个类非常适合快速开发restful接口。

准备工作

确保你的 Qt 版本是 Qt 6 或更高版本，因为 QHttpServer 是在 Qt 6 中添加的。如果你还没有安装 Qt 6，可以从 Qt 官网 获取并安装。

1. 创建一个新的 Qt 项目

打开 Qt Creator，创建一个新的 Qt Widgets 应用程序或者 Qt 控制台应用程序。我们将以 Qt 控制台应用程序为例。

2. 添加 Qt HTTP Server 模块

首先，你需要在项目的 .pro 文件中添加 HTTP Server 模块：

QT += core network

3. 创建简单的 HTTP 服务器

在这个简单的示例中，我们将创建一个 HTTP 服务器，它响应根路径 / 的请求，并返回一个简单的 HTML 页面。

3.1 编辑 main.cpp

在 main.cpp 中，我们将创建一个 QHttpServer 实例，并处理 HTTP 请求。

#include <QCoreApplication>
#include <QHttpServer>
#include <QHttpRequest>
#include <QHttpResponse>
#include <QDebug>

int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);

    // 创建 HTTP 服务器实例
    QHttpServer server;

    // 设置服务器的根路径请求
    server.route("/", [](QHttpRequest *request, QHttpResponse *response) {
        // 设置响应头
        response->setHeader("Content-Type", "text/html");

        // 响应内容
        QByteArray body = R"(
            <html>
            <head><title>Welcome to Qt HTTP Server</title></head>
            <body><h1>Hello, World!</h1><p>This is a simple HTTP server using QHttpServer in Qt.</p></body>
            </html>)";

        // 设置响应状态码和内容
        response->writeHead(200);
        response->end(body);
    });

    // 监听 8080 端口
    if (!server.listen(QHostAddress::Any, 8080)) {
        qCritical() << "Failed to start the server!";
        return -1;
    }

    qDebug() << "Server started at http://localhost:8080";

    return a.exec();
}

3.2 代码解释

• QHttpServer server; 创建一个 HTTP 服务器实例。
• server.route("/", ...) 设置一个路由，当访问根路径 / 时，返回指定的 HTML 内容。
• response->setHeader("Content-Type", "text/html"); 设置响应头，告诉浏览器返回的是 HTML 页面。
• response->writeHead(200); 设置响应的状态码为 200，表示请求成功。
• response->end(body); 发送响应内容给客户端。
• server.listen(QHostAddress::Any, 8080); 开始监听 8080 端口。QHostAddress::Any 表示接受任何地址的连接。

3.3 启动服务器

运行程序后，你会看到控制台输出：

Server started at http://localhost:8080

这表示服务器已经启动，并且你可以通过浏览器访问 http://localhost:8080 来查看返回的 HTML 页面。

4. 处理其他请求

你可以通过 server.route() 函数添加其他的路径和对应的处理函数。例如，处理一个 /about 路径的请求：

server.route("/about", [](QHttpRequest *request, QHttpResponse *response) {
    QByteArray body = R"(
        <html>
        <head><title>About</title></head>
        <body><h1>About This Server</h1><p>This is an example of QHttpServer in Qt.</p></body>
        </html>)";
    
    response->setHeader("Content-Type", "text/html");
    response->writeHead(200);
    response->end(body);
});

这样，当你访问 http://localhost:8080/about 时，服务器会返回另一个页面。

5. 处理 POST 请求

你也可以处理 POST 请求。以下是如何处理一个简单的 POST 请求：

server.route("/submit", QHttpServer::Post, [](QHttpRequest *request, QHttpResponse *response) {
    request->setBodySizeLimit(1024 * 1024);  // 设置最大请求体大小
    request->onBody([](const QByteArray &body) {
        qDebug() << "Received POST body:" << body;
    });

    QByteArray body = "<html><body><h1>Post Received</h1></body></html>";
    response->setHeader("Content-Type", "text/html");
    response->writeHead(200);
    response->end(body);
});

这样，你就可以通过 POST 请求向 http://localhost:8080/submit 发送数据。

6. 错误处理

QHttpServer 还提供了一些错误处理机制，例如处理 404 错误（页面未找到）或 500 错误（服务器内部错误）。你可以通过 server.onError() 方法来设置全局错误处理：

server.onError([](QHttpRequest *request, QHttpResponse *response, const QString &error) {
    qWarning() << "Error occurred:" << error;
    response->writeHead(500);
    response->end("<html><body><h1>Internal Server Error</h1></body></html>");
});

7. 结语

到这里，我们已经创建了一个基本的 HTTP 服务器，它可以处理简单的请求，并返回响应。你可以根据需要扩展更多的路由、请求类型以及错误处理逻辑。QHttpServer 是一个非常适合用来快速搭建 HTTP 服务的工具，尤其适合在 Qt 项目中集成网络功能。