Spring WebFlux使用函数式编程之HandlerFunction-51CTO.COM

本篇主要内容：

RouterFunction的使用

概述

路由器函数用于将请求路由到相应的HandlerFunction。通常情况下，你不需要自己编写路由器函数，而是使用RouterFunctions类中的方法来创建一个。RouterFunctions.route()(无参数)为创建路由器函数提供了一个流畅的构建器，而RouterFunctions.route(RequestPredicate, HandlerFunction)提供了创建路由器的直接方法。

通常，建议使用route()构建器，因为它为典型的映射场景提供了方便的快捷方式，而不需要难以发现的静态导入。例如，路由器函数构建器提供了方法GET(String, HandlerFunction)来为GET请求创建映射;和POST(String, HandlerFunction)用于POST。

除了基于HTTP方法的映射之外，路由构建器还提供了一种在映射到请求时引入附加谓词的方法。对于每个HTTP方法，都有一个以RequestPredicate作为参数的重载变体，尽管可以表示附加的约束。

谓词Predicates

你可以编写自己的RequestPredicate，但RequestPredites类提供了常用的实现，基于请求路径、HTTP方法、内容类型等。以下示例使用请求谓词根据Accept标头创建约束：

RouterFunction<ServerResponse> route = RouterFunctions.route()
    .GET("/hello-world", accept(MediaType.TEXT_PLAIN),
        request -> ServerResponse.ok().bodyValue("Hello World")).build();

你可以使用以下命令将多个请求谓词组合在一起：

RequestPredicate.and(RequestPredicate) // 两者必须匹配。
RequestPredicate.or(RequestPredicate) // 两者都可以匹配。

RequestPredicates中的许多谓词都是组合的。例如，RequestPredicates.GET(String)由RequestPredicates.method(HttpMethod)和RequestPredicates.path(String)组合而成。上面显示的示例还使用了两个请求谓词，因为构建器使用RequestPredicates.GET内部，并用accept谓词组合它。

路由Routes

路由器函数按顺序计算:如果第一个路由不匹配，则计算第二个路由，依此类推。因此，在一般路由之前声明更具体的路由是有意义的。这在将路由器函数注册为Spring bean时也很重要，稍后将对此进行描述。注意，此行为不同于基于注释的编程模型，后者自动选择“最特定的”控制器方法。

当使用路由器函数构建器时，所有定义的路由被组合到一个RouterFunction中，该RouterFunction从build()返回。还有其他方法可以将多个路由器功能组合在一起:

add(RouterFunction) on the RouterFunctions.route() builder。
RouterFunction.and(RouterFunction)。
RouterFunction.andRoute(RequestPredicate, HandlerFunction) — shortcut for RouterFunction.and() with nested RouterFunctions.route()。

下面的例子展示了四条路由的组合：

import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.web.reactive.function.server.RequestPredicates.*;
PersonRepository repository = ...
PersonHandler handler = new PersonHandler(repository);
RouterFunction<ServerResponse> otherRoute = ...
RouterFunction<ServerResponse> route = route()
    .GET("/person/{id}", accept(APPLICATION_JSON), handler::getPerson) // 1
    .GET("/person", accept(APPLICATION_JSON), handler::listPeople)  // 2
    .POST("/person", handler::createPerson)  // 3
    .add(otherRoute)  // 4
    .build();

带有匹配JSON的Accept头的GET /person/{id}被路由到PersonHandler.getPerson。
带有与JSON匹配的Accept头的GET /person被路由到PersonHandler.listPeople。
没有附加谓词的POST /person被映射到PersonHandler.createPerson。
otherRoute是一个在别处创建的路由器函数，并添加到构建的路由中。

嵌套路由Nested Routes

一组路由器函数通常具有一个共享谓词，例如共享路径。在上面的示例中，共享谓词将是一个与/person匹配的路径谓词，由三条路由使用。在使用注释时，可以通过使用映射到/person的类型级@RequestMapping注释来消除这种重复。在WebFlux.Fn，路径谓词可以通过路由器函数构建器上的路径方法共享。例如，上面例子的最后几行可以通过使用嵌套路由通过以下方式进行改进：

RouterFunction<ServerResponse> route = route()
    .path("/person", builder -> builder // 1
        .GET("/{id}", accept(APPLICATION_JSON), handler::getPerson)
        .GET(accept(APPLICATION_JSON), handler::listPeople)
        .POST(handler::createPerson))
    .build();

注意：path的第二个参数是接受路由器构建器的消费者。

尽管基于路径的嵌套是最常见的，但是你可以通过在构建器上使用嵌套方法来嵌套任何类型的谓词。上面的内容仍然以共享的Accept-header谓词的形式包含了一些重复。我们可以通过使用nest方法和accept来进一步改进：

RouterFunction<ServerResponse> route = route()
    .path("/person", b1 -> b1
        .nest(accept(APPLICATION_JSON), b2 -> b2
            .GET("/{id}", handler::getPerson)
            .GET(handler::listPeople))
        .POST(handler::createPerson))
    .build();

总结：

路由函数中RouteFunction的使用。
嵌套路由的使用。