En esta página

QHttpServerRouter Class

Ofrece funciones para vincular una ruta a un ViewHandler. Más...

Encabezado: #include <QHttpServerRouter>
CMake: find_package(Qt6 REQUIRED COMPONENTS HttpServer)
target_link_libraries(mytarget PRIVATE Qt6::HttpServer)
qmake: QT += httpserver
Desde: Qt 6.4

Funciones públicas

QHttpServerRouter(QAbstractHttpServer *server)
~QHttpServerRouter()
bool addConverter(QAnyStringView regexp)
void addConverter(QMetaType metaType, QAnyStringView regexp)
QHttpServerRouterRule *addRule(std::unique_ptr<QHttpServerRouterRule> rule)
void clearConverters()
QHash<QMetaType, QString> converters() &&
const QHash<QMetaType, QString> &converters() const &
bool handleRequest(const QHttpServerRequest &request, QHttpServerResponder &responder) const
void removeConverter(QMetaType metaType)

Descripción detallada

QHttpServerRouter es un sistema basado en reglas que redirige las solicitudes HTTP a sus controladores correspondientes. Se pueden añadir instancias de ` QHttpServerRouterRule `, que definen una ruta de solicitud y su controlador correspondiente.

Las partes variables de la ruta se pueden especificar mediante marcadores de posición ("<arg>") en la ruta de la solicitud, aunque no es necesario hacerlo al final. El controlador recibe los valores coincidentes como un objeto QRegularExpressionMatch. Los argumentos pueden ser de cualquier tipo para el que exista un converter. La creación del controlador se puede simplificar con QHttpServerRouterRule::bindCaptured().

Nota: Una instancia de QHttpServerRouter no debe ser modificada por sus reglas.

Nota: Se trata de una API de enrutamiento de bajo nivel para un servidor HTTP.

Ejemplo mínimo:

auto pageView = [] (const quint64 página) {
    qDebug() << "page" << page;
};
using ViewHandler = decltype(pageView);

QHttpServerRouter router;

// registra la llamada de retorno pageView en la solicitud «/page/<número>»
// por ejemplo: «/page/10», «/page/15»
router.addRule<ViewHandler>(
    new QHttpServerRouterRule("/page/", [=] (QRegularExpressionMatch&match,
                                             const QHttpServerRequest&,
                                             QHttpServerResponder&&) {
    auto boundView = QHttpServerRouterRule::bindCaptured(pageView, match);

    // llama a pageView
    boundView();
}));

Documentación de la función miembro

QHttpServerRouter::QHttpServerRouter(QAbstractHttpServer *server)

Crea un objeto QHttpServerRouter con convertidores predeterminados.

Véase también converters.

[noexcept] QHttpServerRouter::~QHttpServerRouter()

Destruye un « QHttpServerRouter ».

template <typename Type> bool QHttpServerRouter::addConverter(QAnyStringView regexp)

Añade un nuevo convertidor para «Type» que se puede analizar con « regexp » y devuelve « true » si la operación se ha realizado correctamente; en caso contrario, devuelve « false ». Si la operación se realiza correctamente, el tipo registrado se puede utilizar como argumento en los controladores de « QHttpServerRouterRule ». La expresión regular se utilizará para analizar el patrón de ruta de la regla.

Si ya existe un convertidor de tipo Type, la expresión regular de dicho convertidor se sustituye por regexp.

Los convertidores personalizados pueden ampliar las conversiones de tipos disponibles a través del sistema QMetaType.

Define una clase con un constructor ` QString `:

struct CustomArg {
    int data = 10;

    CustomArg() {} ;
    CustomArg(const QString &urlArg) : data(urlArg.toInt()) {}
};

Para utilizar un tipo personalizado con el ` HTTP server`, regístralo mediante esta función y define un controlador ` route ` utilizando el nuevo tipo:

server.router()->addConverter<CustomArg>(u"[+-]?\\d+");
server.route("/customTest/<arg>", [] (const CustomArg custom) { return QString::number(custom.data); });

Véase también « converters » y « clearConverters ».

void QHttpServerRouter::addConverter(QMetaType metaType, QAnyStringView regexp)

Añade un nuevo convertidor para metaType que puede analizarse con regexp. Disponer de un convertidor para metaType permite utilizar este tipo en un patrón de ruta de QHttpServerRouterRule. La expresión regular se utiliza para analizar los parámetros de tipo metaType a partir del patrón de ruta.

Si ya existe un convertidor de tipo metaType, la expresión regular de dicho convertidor se sustituye por regexp.

Véase también converters y clearConverters.

template <typename ViewHandler, typename ViewTraits = QHttpServerRouterViewTraits<ViewHandler>> QHttpServerRouterRule *QHttpServerRouter::addRule(std::unique_ptr<QHttpServerRouterRule> rule)

Añade una nueva regla « rule » al enrutador.

Devuelve un puntero a la nueva regla si se realiza correctamente; en caso contrario, devuelve ` nullptr`.

Dentro de `addRule`, determinamos los argumentos de `ViewHandler` y generamos una lista con los identificadores de sus ` QMetaType::Type `. A continuación, analizamos la ruta y sustituimos cada ` "<arg>" ` por una expresión regular correspondiente a su tipo de la lista.

El ` rule ` proporcionado no debe modificar la instancia de ` QHttpServerRouter `.

QHttpServerRouter router;

using ViewHandler = decltype([] (const QString &page, const quint32 num) { });

auto rule = std::make_unique<QHttpServerRouterRule>(
    "/<arg>/<arg>/log",
    [] (QRegularExpressionMatch &match,
        const QHttpServerRequest &request,
        QHttpServerResponder &&responder) {
});

router.addRule<ViewHandler>(std::move(rule));

void QHttpServerRouter::clearConverters()

Elimina todos los convertidores.

Nota: clearConverters () no configura los convertidores predeterminados.

Véase también converters y addConverter.

QHash<QMetaType, QString> QHttpServerRouter::converters() &&

const QHash<QMetaType, QString> &QHttpServerRouter::converters() const &

Devuelve un mapa con los tipos de convertidores y las expresiones regulares registradas en este QHttpServerRouter. Estos son los tipos que se pueden utilizar en los patrones de ruta de QHttpServerRouterRules.

Los siguientes convertidores están disponibles de forma predeterminada:

ConstanteDescripción
QMetaType::Int 
QMetaType::Long 
QMetaType::LongLong 
QMetaType::Short 
QMetaType::UInt 
QMetaType::ULong 
QMetaType::ULongLong 
QMetaType::UShort 
QMetaType::Double 
QMetaType::Float 
QMetaType::QString 
QMetaType::QByteArray 
QMetaType::QUrl 
QMetaType::VoidUn convertidor vacío.

Véase también addConverter y clearConverters.

bool QHttpServerRouter::handleRequest(const QHttpServerRequest &request, QHttpServerResponder &responder) const

Gestiona cada nueva solicitud « request » del servidor HTTP utilizando « responder ».

Recorre la lista de reglas para encontrar la primera que coincida, ejecuta dicha regla y devuelve ` true`. Devuelve ` false ` si ninguna regla coincide con la solicitud.

void QHttpServerRouter::removeConverter(QMetaType metaType)

Elimina el convertidor para el tipo « metaType ».

Véase también addConverter.

© 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.