QHttpServerRouter Class

成员函数文档

QHttpServerRouter::QHttpServerRouter(QAbstractHttpServer *server)

创建一个带有默认转换器的 QHttpServerRouter 对象。

另请参阅 converters 。

[noexcept] QHttpServerRouter::~QHttpServerRouter()

销毁一个QHttpServerRouter 。

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

为Type添加一个新的转换器，该转换器可使用regexp 进行解析，若解析成功则返回true ，否则返回false 。若解析成功，则该已注册的类型可作为QHttpServerRouterRule 中处理程序的参数使用。正则表达式将用于解析规则的路径模式。

如果已经存在类型为Type 的转换器，则该转换器的正则表达式将被替换为regexp 。

自定义转换器可以通过QMetaType 系统扩展现有的类型转换功能。

定义一个带有 `QString ` 构造函数的类：

struct CustomArg {
    int data = 10;

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

若要将自定义类型与HTTP server 配合使用，请通过此函数进行注册，并使用新类型定义route 处理程序：

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

另请参阅 converters 和clearConverters 。

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

为metaType 添加了一个新的转换器，该转换器可通过regexp 进行解析。为metaType 提供转换器后，即可在QHttpServerRouterRule 的路径模式中使用该类型。该正则表达式用于从路径模式中解析metaType 类型的参数。

如果已经存在类型为metaType 的转换器，则该转换器的正则表达式将被替换为regexp 。

另请参阅 converters 和clearConverters 。

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

向路由器添加一个新的rule 。

若操作成功，则返回指向新规则的指针；否则返回nullptr 。

在 addRule 方法中，我们会确定 ViewHandler 的参数，并生成其QMetaType::Type 标识符的列表。然后解析路径，并将每个"<arg>" 替换为列表中对应类型的正则表达式。

提供的rule 绝不能修改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()

移除所有转换器。

另请参阅 converters 和addConverter 。

返回一个映射，其中包含已注册到此QHttpServerRouter 的转换器类型和正则表达式。这些类型可用于QHttpServerRouterRules 的路径模式中。

默认情况下提供以下转换器：

另请参阅 addConverter 和clearConverters 。

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

使用 `responder` 处理 HTTP 服务器收到的每个新的 `request ` 请求。

遍历规则列表以查找第一个匹配的规则，然后执行该规则，并返回true 。如果没有规则与请求匹配，则返回false 。

void QHttpServerRouter::removeConverter(QMetaType metaType)

移除类型metaType 的转换器。

另请参阅 addConverter 。