Qt+Cutelyst学习笔记（二十七）win10+Qt5.15.2+qmake实现一个简单的RESTful服务器

原创已于 2022-04-12 17:00:34 修改 · 1.1k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#qt #cutelyst3 #http

于 2022-04-12 16:52:15 首次发布

Qt+web后台开发专栏收录该内容

37 篇文章

订阅专栏

本文档介绍了在win10环境下，使用Qt5.15.2和qmake创建一个简单的RESTful服务器的过程。通过创建控制器类ApiV1并利用Cutelyst的ActionClass(REST)宏，实现了针对HTTP方法的不同处理。文章还展示了编译测试过程，包括GET、POST、PUT和DELETE请求的响应。

前言：

之前的文档记录的都是一些基本功能的实现，本次尝试做一个比较实用的demo，可以以此为模板，创建自己的RESTful服务

一、创建控制器

关于如何创建完整的工程，可以参考笔者之前的文档，在此不再重复

Qt+Cutelyst学习笔记（二十四）win10+Qt5.15.2+qmake实现一个简单的http服务器_aggs1990的博客-优快云博客

Qt+Cutelyst学习笔记（二十五）win10+Qt5.15.2+qmake实现一个简单的https服务器_aggs1990的博客-优快云博客创建一个类ApiV1，继承自Controller类，并添加方法，apiv1.h如下所示

    C_ATTR(users, :Local :AutoArgs :ActionClass(REST))
    void users(Context *c);

    C_ATTR(users_GET, :Private)
    void users_GET(Context *c);

    C_ATTR(users_POST, :Private)
    void users_POST(Context *c);

    C_ATTR(users_PUT, :Private)
    void users_PUT(Context *c);

    C_ATTR(users_DELETE, :Private)
    void users_DELETE(Context *c);

    C_ATTR(users_uuid, :Path('users') :AutoArgs :ActionClass(REST))
    void users_uuid(Context *c, const QString &uuid);

    C_ATTR(users_uuid_GET, :Private)
    void users_uuid_GET(Context *c, const QString &uuid);

    C_ATTR(users_uuid_POST, :Private)
    void users_uuid_POST(Context *c, const QString &uuid);

    C_ATTR(users_uuid_PUT, :Private)
    void users_uuid_PUT(Context *c, const QString &uuid);

    C_ATTR(users_uuid_DELETE, :Private)
    void users_uuid_DELETE(Context *c, const QString &uuid);

我们来分析下这个声明

C_ATTR宏用于添加有关MOC将生成的类的元数据，因此Cutelyst知道如何将URL映射到这些函数。

:Local -通过生成/api/v1/users将方法名称映射到URL
:AutoArgs -自动检查上下文*后的参数数量，在users_uuid中，我们只有一个参数，因此如果URL为/api/v1/users/anything，将调用该方法
:ActionClass(REST) - 将加载REST插件，该插件将创建一个操作类来处理此方法，ActionREST将根据调用的方法调用其他方法
:Private -在Cutelyst中将操作注册为Private，因此无法通过URL直接访问

第一部分，告诉服务端，要处理请求url为http(s)://localhost:3001/api/v1/users的REST请求

第二部分，告诉服务端，要处理请求url为http(s)://localhost:3001/api/v1/users/*/的REST请求，其中*的位置，对应uuid的参数

根据每个函数的HTTP方法，自动进行函数映射，需要注意的是，第一个函数（没有_METHOD）总是执行的

以第一部分为例，当请求http(s)://localhost:3001/api/v1/users时，users()函数会先执行，然后根据请求的方法不同，再执行对应的函数：

若请求方法为get，则执行users_GET()方法
若请求方法为post，则执行users_POST()方法
若请求方法为put，则执行users_PUT()方法
若请求方法为delete，则执行users_DELETE()方法

第二部分和第一部分类型，只是增加了一个参数，在此不再重复

声明分析完成了，下面看下是如何实现的，apiv1.cpp如下所示

void ApiV1::users(Context *c)
{
    qDebug() << Q_FUNC_INFO
             <<"\n hostname:"<<c->request()->hostname()
            <<"\n port:"<<c->request()->port()
           <<"\n uri:"<<c->request()->uri()
          <<"\n base:"<<c->request()->base()
         <<"\n path:"<<c->request()->path()
        <<"\n match:"<<c->request()->match()
       <<"\n arguments:"<<c->request()->arguments()
     <<"\n secure:"<<c->request()->secure()
    <<"\n bodyData:"<<c->request()->bodyData()
    <<"\n bodyParameters:"<<c->request()->bodyParameters()
    <<"\n queryParameters:"<<c->request()->queryParameters()
    <<"\n contentEncoding:"<<c->request()->contentEncoding()
    <<"\n contentType:"<<c->request()->contentType()
    <<"\n method:"<<c->request()->method()
    <<"\n protocol:"<<c->request()->protocol()
    <<"\n userAgent:"<<c->request()->userAgent()
    <<"\n referer:"<<c->request()->referer()
    <<"\n remoteUser:"<<c->request()->remoteUser();
}

笔者建议，为方便进一步理解，把常用的属性打印下，在编程时，可能会用到某些参数

void ApiV1::users_GET(Context *c)
{
    qDebug() << Q_FUNC_INFO
                <<c->request()->queryParameters();
//    c->request()->queryParameters("arg1");

    c->response()->setJsonObjectBody({
                                        {QStringLiteral("message"), QStringLiteral("users_GET")}
                                    });
}

对于get方法，可以使用c->request()->queryParameters()获取url里的查询参数

然后返回一个简单的json串

void ApiV1::users_POST(Context *c)
{
    qDebug() << Q_FUNC_INFO
             << c->request()->bodyData()
                <<c->request()->queryParameters();
    c->response()->setJsonObjectBody({
                                        {QStringLiteral("message"), QStringLiteral("users_POST")}
                                     });
}

对于post方法，可以使用c->request()->queryParameters()获取url里的查询参数

若提交的数据是json，且请求的头设置为application/json，可以通过c->request()->bodyData()获取提交的json对象

然后返回一个简单的json串

put方法和post方法类似；delete方法和get方法类似；就不重复说明了