Question

是否有关于路径的路由模板格式的文档。我想设置这样的处理程序：

/ or /index.html -> Use handler 1
Anything else -> Use handler 2

我试过这个，但是没有用：

Handlers.routing()
        .add("GET", "/", handler1)
        .add("GET", "/index.html", handler1)
        .add("GET", "/*", handler2)

有什么想法吗？

Answer 1

有几种方法可以实现这一目标：

1）基本方法：PathHandler

Handlers.path()
    .addExactPath("/path1", handler1)
    .addPrefixPath("/path2", handler2);

handler1仅匹配 / path1 （或 / path1 / ）。

handler2将匹配 / path2 ， / path2 / 以及以 / path2 / 开头的所有其他内容。< / p>

2）路线方法：RoutingHandler

如果您使用RoutingHandler，则可以选择从路径中轻松提取变量。这样可以方便地构建REST API（请注意在get上使用方便RoutingHandler方法）。

Handlers.routing().get("/{test}/*", exchange -> {
    PathTemplateMatch pathMatch = exchange.getAttachment(PathTemplateMatch.ATTACHMENT_KEY);
    String itemId1 = pathMatch.getParameters().get("test"); // or exchange.getQueryParameters().get("test")
    String itemId2 = pathMatch.getParameters().get("*"); // or exchange.getQueryParameters().get("*")
}))

*参数可以匹配任何内容（例如a/b/c的路径）。要使用*参数，您需要在路由模板中定义之前定义的实际命名参数（在我的示例中为test）。

请注意，路径模板中定义的参数将与查询参数（exchange.getQueryParameters()）一起使用。这是默认行为。如果您不想要它，可以创建如下所示的路由处理程序：Handlers.routing(false).get(...)，然后从交换的附件中检索参数。

对于路由处理程序不匹配的任何路由，您可以使用fallbackHandler中提供的RoutingHandler。

Handlers.routing()
      .get("/", handler1)
      .get("/index.html", handler1)
      .setFallbackHandler(handler2);

默认情况下，fallbackHandler只返回一个带有404状态代码的空响应正文。 handler2将匹配任何其他请求，而不仅仅是 GET 请求。

综合示例

您当然可以合并PathHandler和RoutingHandler以满足您的需求。

以下是更现实的设置的一个小例子：

Undertow.builder().addHttpListener(8080, "0.0.0.0")
    .setHandler(Handlers.path()

        // REST API path
        .addPrefixPath("/api", Handlers.routing()
            .get("/customers", exchange -> {...})
            .delete("/customers/{customerId}", exchange -> {...})
            .setFallbackHandler(exchange -> {...}))

        // Redirect root path to /static to serve the index.html by default
        .addExactPath("/", Handlers.redirect("/static"))

        // Serve all static files from a folder
        .addPrefixPath("/static", new ResourceHandler(
            new PathResourceManager(Paths.get("/path/to/www/"), 100))
            .setWelcomeFiles("index.html"))

    ).build().start();

此应用程序还提供文件系统中的静态文件。例如，这对于提供javascript应用程序或静态html文件非常方便。

路径的路由模板格式

1 个答案: