En esta página

QRestAccessManager Class

QRestAccessManager es un envoltorio que facilita el uso de QNetworkAccessManager. Más información...

Encabezado: #include <QRestAccessManager>
CMake: find_package(Qt6 REQUIRED COMPONENTS Network)
target_link_libraries(mytarget PRIVATE Qt6::Network)
qmake: QT += network
Desde: Qt 6.7
Heredado de: QObject

Nota: Todas las funciones de esta clase son reentrantes.

Funciones públicas

QRestAccessManager(QNetworkAccessManager *manager, QObject *parent = nullptr)
virtual ~QRestAccessManager() override
QNetworkReply *deleteResource(const QNetworkRequest &request)
QNetworkReply *deleteResource(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *get(const QNetworkRequest &request)
QNetworkReply *get(const QNetworkRequest &request, const QByteArray &data)
QNetworkReply *get(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *get(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *get(const QNetworkRequest &request, QIODevice *data)
QNetworkReply *get(const QNetworkRequest &request, const QJsonDocument &data)
QNetworkReply *get(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *get(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *head(const QNetworkRequest &request)
QNetworkReply *head(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkAccessManager *networkAccessManager() const
QNetworkReply *patch(const QNetworkRequest &request, const QJsonDocument &data)
QNetworkReply *patch(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *patch(const QNetworkRequest &request, QIODevice *data)
QNetworkReply *patch(const QNetworkRequest &request, const QByteArray &data)
QNetworkReply *patch(const QNetworkRequest &request, const QVariantMap &data)
QNetworkReply *patch(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *patch(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *patch(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *post(const QNetworkRequest &request, const QJsonDocument &data)
QNetworkReply *post(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *post(const QNetworkRequest &request, QHttpMultiPart *data)
QNetworkReply *post(const QNetworkRequest &request, QIODevice *data)
QNetworkReply *post(const QNetworkRequest &request, const QByteArray &data)
QNetworkReply *post(const QNetworkRequest &request, const QVariantMap &data)
QNetworkReply *post(const QNetworkRequest &request, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *post(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *post(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *post(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *put(const QNetworkRequest &request, const QJsonDocument &data)
QNetworkReply *put(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *put(const QNetworkRequest &request, QHttpMultiPart *data)
QNetworkReply *put(const QNetworkRequest &request, QIODevice *data)
QNetworkReply *put(const QNetworkRequest &request, const QByteArray &data)
QNetworkReply *put(const QNetworkRequest &request, const QVariantMap &data)
QNetworkReply *put(const QNetworkRequest &request, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *put(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *put(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *put(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, const QByteArray &data)
QNetworkReply *sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QHttpMultiPart *data)
QNetworkReply *sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QIODevice *data)
QNetworkReply *sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)
QNetworkReply *sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Descripción detallada

QRestAccessManager es un envoltorio de conveniencia sobre QNetworkAccessManager. Modifica los tipos de datos y los métodos HTTP que resultan útiles para las aplicaciones cliente RESTful típicas.

Se puede acceder a las funciones habituales de Qt Network configurando directamente el ` QNetworkAccessManager ` envuelto. `QRestAccessManager` no asume la propiedad del ` QNetworkAccessManager` envuelto.

QRestAccessManager y las clases relacionadas de QRestReply solo pueden utilizarse en el hilo en el que se encuentran. Consulte QObject thread affinity para obtener más información.

Realización de solicitudes de red y gestión de respuestas

Las solicitudes de red se inician mediante una llamada a una función correspondiente al método HTTP deseado, como get() y post().

Uso de señales y ranuras

La función devuelve un objeto ` QNetworkReply*`, cuyas señales se pueden utilizar para realizar un seguimiento de la finalización de la solicitud al estilo tradicional de señales y ranuras de Qt.

A continuación se muestra un ejemplo de cómo se puede enviar una solicitud GET y gestionar la respuesta:

QNetworkReply *reply = manager->get(request);
QObject::connect(reply, &QNetworkReply::finished, this, [reply]() {
    // The reply may be wrapped in the finish handler:
    QRestReply restReply(reply);
    if (restReply.isSuccess())
        // ...
});

Uso de callbacks y objetos de contexto

Las funciones también admiten como parámetros un objeto de contexto de tipo QObject (subclase) y una función de llamada de retorno. La llamada de retorno toma un QRestReply& como parámetro. La llamada de retorno puede ser cualquier objeto ejecutable, incluido un puntero a una función miembro.

Estas funciones de devolución de llamada se invocan cuando ha finalizado el procesamiento de la respuesta (también en el caso de que el procesamiento haya finalizado debido a un error).

El objeto de contexto puede ser de tip nullptr, aunque, en general, no se recomienda. El uso de un objeto de contexto válido garantiza que, si dicho objeto se destruye durante el procesamiento de la solicitud, no se invocará la función de devolución de llamada. Las funciones de devolución de llamada aisladas que acceden a un contexto destruido son una fuente de comportamiento anómalo de la aplicación.

A continuación se muestra un ejemplo de cómo se podría enviar una solicitud GET y comprobar la respuesta:

// With lambda
manager->get(request, this, [this](QRestReply &reply) {
    if (reply.isSuccess()) {
        // ...
    }
});
// With member function
manager->get(request, this, &MyClass::handleFinished);

Muchas de las funciones aceptan datos para enviarlos a un servidor. Los datos se proporcionan como segundo parámetro después de la solicitud.

A continuación se muestra un ejemplo de cómo se puede enviar una solicitud POST y comprobar la respuesta:

QJsonDocument myJson;
// ...
manager->post(request, myJson, this, [this](QRestReply &reply) {
    if (!reply.isSuccess()) {
        // ...
    }
    if (std::optional json = reply.readJson()) {
        // use *json
    }
});

El objeto ` QRestReply` proporcionado solo es válido mientras se ejecuta la llamada de retorno. Si lo necesitas durante más tiempo, puedes trasladarlo a otro ` QRestReply` o crear uno nuevo e inicializarlo con ` QNetworkReply ` (véase ` QRestReply::networkReply()`).

Tipos de datos admitidos

La siguiente tabla resume los métodos y los tipos de datos admitidos. « X » significa «admitido».

Tipo de datosget()post()put()head()patch()deleteResource()sendCustomRequest()
Sin datosX--X-X-
QByteArrayXXX-X-X
QJsonDocument *)XXX-X--
QVariantMap **)-XX-X--
QHttpMultiPart-XX---X
QIODeviceXXX-X-X

*) QJsonDocument se envía en formato QJsonDocument::Compact, y el encabezado Content-Type se establece en application/json si no se ha establecido el encabezado Content-Type

**) QVariantMap se convierte y se trata como un QJsonObject

Véase también QRestReply, QNetworkRequestFactory y QNetworkAccessManager.

Documentación de funciones de miembro

[explicit] QRestAccessManager::QRestAccessManager(QNetworkAccessManager *manager, QObject *parent = nullptr)

Crea un objeto QRestAccessManager y establece parent como objeto padre, y manager como el QNetworkAccessManager subyacente que se utiliza para la comunicación.

Véase también networkAccessManager().

[override virtual noexcept] QRestAccessManager::~QRestAccessManager()

Elimina el objeto « QRestAccessManager ».

QNetworkReply *QRestAccessManager::deleteResource(const QNetworkRequest &request)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::deleteResource(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Genera un objeto ` HTTP DELETE ` basado en ` request`.

Se pueden proporcionar los objetos opcionales ` callback ` y ` context ` para gestionar la finalización de la solicitud, tal y como se ilustra a continuación:

manager->deleteResource(request, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Como alternativa, se pueden utilizar las señales del objeto QNetworkReply* devuelto. Para más información, véase Issuing Network Requests and Handling Replies.

deleteResource() La solicitud no admite el envío de datos.

Véase también QRestReply.

QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Genera un objeto ` HTTP GET ` basado en ` request`.

Se pueden proporcionar los objetos opcionales ` callback ` y ` context ` para gestionar la finalización de la solicitud, tal y como se ilustra a continuación:

manager->get(request, this, [this](QRestReply &reply) {
    if (!reply.isSuccess())
        // handle error
    if (std::optional json = reply.readJson())
        // use *json
});

Como alternativa, se pueden utilizar las señales del objeto QNetworkReply* devuelto. Para más información, véase Issuing Network Requests and Handling Replies.

Véase también QRestReply.

QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, const QByteArray &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Genera un objeto ` HTTP GET ` basado en ` request ` y en el ` data` facilitado.

Se pueden proporcionar los objetos opcionales ` callback ` y ` context ` para gestionar la finalización de la solicitud, tal y como se ilustra a continuación:

manager->get(request, myData, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Como alternativa, se pueden utilizar las señales del objeto QNetworkReply* devuelto. Para más información, véase Issuing Network Requests and Handling Replies.

Véase también QRestReply.

QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, QIODevice *data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, const QJsonDocument &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::head(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Genera un objeto ` HTTP HEAD ` basado en ` request`.

Se pueden proporcionar los objetos opcionales ` callback ` y ` context ` para gestionar la finalización de la solicitud, tal y como se ilustra a continuación:

manager->head(request, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Como alternativa, se pueden utilizar las señales del objeto QNetworkReply* devuelto. Para más información, véase Issuing Network Requests and Handling Replies.

head() La solicitud no admite el envío de datos.

Véase también QRestReply.

QNetworkAccessManager *QRestAccessManager::networkAccessManager() const

Devuelve la instancia subyacente de ` QNetworkAccessManager `.

Véase también QNetworkAccessManager.

QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QJsonDocument &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Genera un objeto ` HTTP PATCH ` basado en ` request`.

Se pueden proporcionar los objetos opcionales ` callback ` y ` context ` para gestionar la finalización de la solicitud, tal y como se ilustra a continuación:

manager->patch(request, myData, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Como alternativa, se pueden utilizar las señales del objeto QNetworkReply* devuelto. Para más información, véase Issuing Network Requests and Handling Replies.

El método ` patch() ` siempre requiere el parámetro ` data `. Se admiten los siguientes tipos de datos:

*) Se envía en formato ` QJsonDocument::Compact `, y el encabezado ` Content-Type ` se establece en ` application/json ` si no se ha establecido el encabezado ` Content-Type ` **) ` QVariantMap ` se convierte a y se trata como un QJsonObject

Véase también QRestReply.

QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, QIODevice *data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QByteArray &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QVariantMap &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QJsonDocument &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Genera un objeto ` HTTP POST ` basado en ` request`.

Se pueden proporcionar los objetos opcionales ` callback ` y ` context ` para gestionar la finalización de la solicitud, tal y como se ilustra a continuación:

manager->post(request, myData, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Como alternativa, se pueden utilizar las señales del objeto ` QNetworkReply*` devuelto. Para más información, véase ` Issuing Network Requests and Handling Replies`.

El método post() siempre requiere el parámetro data. Se admiten los siguientes tipos de datos:

*) Se envía en formato « QJsonDocument::Compact », y el encabezado « Content-Type » se establece en « application/json » si no se ha establecido el encabezado « Content-Type » **) « QVariantMap » se convierte y se trata como un QJsonObject

Véase también QRestReply.

QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, QHttpMultiPart *data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, QIODevice *data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QByteArray &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QVariantMap &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QJsonDocument &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Genera un objeto ` HTTP PUT ` basado en ` request`.

Se pueden proporcionar los objetos opcionales ` callback ` y ` context ` para gestionar la finalización de la solicitud, tal y como se ilustra a continuación:

manager->put(request, myData, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Como alternativa, se pueden utilizar las señales del objeto QNetworkReply* devuelto. Para más información, véase Issuing Network Requests and Handling Replies.

El método ` put() ` siempre requiere el parámetro ` data `. Se admiten los siguientes tipos de datos:

*) Se envía en formato « QJsonDocument::Compact », y el encabezado « Content-Type » se establece en « application/json » si no se ha establecido el encabezado « Content-Type ». **) « QVariantMap » se convierte y se trata como un QJsonObject

Véase también QRestReply.

QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, QHttpMultiPart *data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, QIODevice *data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QByteArray &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QVariantMap &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, const QByteArray &data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Envía una solicitud HTTP basada en request con un method personalizado y el data facilitado.

Se pueden proporcionar los objetos opcionales ` callback ` y ` context ` para gestionar la finalización de la solicitud, tal y como se ilustra a continuación:

manager->sendCustomRequest(request, "MYMETHOD",  myData,  this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Como alternativa, se pueden utilizar las señales del objeto QNetworkReply* devuelto. Para más información, consulta Issuing Network Requests and Handling Replies.

QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QHttpMultiPart *data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QIODevice *data)

template <typename Functor> requires if_compatible_callback<Functor> QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.