Spring 5 新功能：函數式 Web 框架

範例

我們選用範例程式作為開始。下面是一個回應資源庫用於暴露Person物件。這個回應資源庫與傳統的無回應資源庫類似，除了Flux對應傳統的 List，Mono對應傳統的 Person物件。 Mono作為完成識別：用於指示保存工作完成.更多Reactor 類型資訊請查閱 Dave發布的博客

public interface PersonRepository {
  Mono<Person> getPerson(int id);
  Flux<Person> allPeople();
  Mono<Void> savePerson(Mono<Person> person);}

這裡我們介紹如何使用新的函數式web框架暴露資源庫：

RouterFunction<?> route = route(GET("/person/{id}"),
  request -> {
    Mono<Person> person = Mono.justOrEmpty(request.pathVariable("id"))
      .map(Integer::valueOf)
      .then(repository::getPerson);
    return Response.ok().body(fromPublisher(person, Person.class));
  })
  .and(route(GET("/person"),
    request -> {
      Flux<Person> people = repository.allPeople();
      return Response.ok().body(fromPublisher(people, Person.class));
    }))
  .and(route(POST("/person"),
    request -> {
      Mono<Person> person = request.body(toMono(Person.class));
      return Response.ok().build(repository.savePerson(person));
    }));

這裡我們介紹如何運行它，以下是Reactor Netty的範例：

HttpHandler httpHandler = RouterFunctions.toHttpHandler(route);
ReactorHttpHandlerAdapter adapter =
  new ReactorHttpHandlerAdapter(httpHandler);
HttpServer server = HttpServer.create("localhost", 8080);
server.startAndAwait(adapter);

最後要做的是，進行一次嘗試請求：

$ curl ' 
{"name":"John Doe","age":42}

上面的介紹覆蓋了很多內容，下面讓我們深入挖掘下！

核心元件

我將透過依序介紹HandlerFunction,RouterFunction以及FilterFunction 等核心元件來介紹整個框架。這三個介面以及本文中其他類型都可以在org.springframework.web.reactive.function套件中找到。

處理功能

新框架的起點是HandlerFunction，其實質是Function>，其中的Request 和Response都是新定義的不可變接口，提供了基礎的對JDK8優化的HTTP訊息描述DSL。有一個便捷的構造Response實例的構造器，與ResponseEntity中的十分相似。註解方式中與HandlerFunction相對應的是@RequestMapping所註解的方法。

如下是「Hello World」的處理方法，它傳回了狀態為200，body為字串的訊息。

HandlerFunction<String> helloWorld =
  request -> Response.ok().body(fromObject("Hello World"));

如上，建構於Reactor之上的處理方法是完全的響應式的（reactive），它們可以接受Flux、Mono或其他對應流（Reactive Streams）的發布者作為傳回類型的參數。

需要注意的是處理方法本身是沒有副作用的，因為它將response作為回傳值，而不是作為參數（對比Servlet.service(ServletRequest,ServletResponse)，其實質是BiConsumer）。無副作用的方法有許多好處：更有利於測試、建構和最佳化。

路由功能

入站請求是由RouterFunction，(即Function>)路由到HandlerFunction中去的。當滿足條件匹配時，路由方法會執行處理方法，否則會傳回一個空結果。路由方法與@RequestMapping註解的作用相似。但是，還有一個顯著的差異：用註解時路由會被限製到註解的value所能表達的範圍，處理這些方法的覆蓋是困難的；當用路由方法的時候，程式碼就在那裡，可以輕鬆的覆蓋或替換。

如下是一個路由方法的例子，包含了一個行內的處理方法。這裡看起來有一點冗餘，不必擔心，因為後面我們將把它變得精簡。

RouterFunction<String> helloWorldRoute = 
  request -> {
    if (request.path().equals("/hello-world")) {
      return Optional.of(r -> Response.ok().body(fromObject("Hello World")));
    } else {
      return Optional.empty();
    }
  };

一般不用寫完整的路由方法，而是靜態引入RouterFunctions.route()，這樣就可以用請求判斷式（RequestPredicate） (即 Predicate)和處理方法（HandlerFunction）創建路由方法了。如果判斷式判斷成功則傳回處理方法，否則傳回空結果。如下是用route方法重寫上面的例子：

RouterFunction<String> helloWorldRoute =
  RouterFunctions.route(request -> request.path().equals("/hello-world"),
    request -> Response.ok().body(fromObject("Hello World")));

靜態引入RequestPredicates.*後就可以使用那些常用的判斷式了，如匹配路徑、HTTP方法、content-type等。這樣上面的例子將會更精簡：

RouterFunction<String> helloWorldRoute =
  RouterFunctions.route(RequestPredicates.path("/hello-world"),
    request -> Response.ok().body(fromObject("Hello World")));

组合功能

两个路由方法可以被组合成一个新的路由方法，可以路由任意处理方法：如果第一个路由不匹配则执行第二个。可以通过调用RouterFunction.and()方法实现，如下：

RouterFunction<?> route =
  route(path("/hello-world"),
    request -> Response.ok().body(fromObject("Hello World")))
  .and(route(path("/the-answer"),
    request -> Response.ok().body(fromObject("42"))));

上面的例子如果路径匹配/hello-world会返回“Hello World”，如果匹配/the-answer则返回“42”。如果都不匹配则返回一个空的Optional对象。注意，组合的路由是按顺序执行的，所以应该将更通用的方法放到更明确的方法的前面。

请求判断式也是可以组合的，通过调研and或者or方法。正如预期的一样：and表示给定的两个判断式同时满足则组合判断式满足，or则表示任意判断式满足。如下：

RouterFunction<?> route =
  route(method(HttpMethod.GET).and(path("/hello-world")), 
    request -> Response.ok().body(fromObject("Hello World")))
  .and(route(method(HttpMethod.GET).and(path("/the-answer")), 
    request -> Response.ok().body(fromObject("42"))));

实际上，RequestPredicates中的大部分判断式都是组合的！比如RequestPredicates.GET(String)是RequestPredicates.method(HttpMethod)和RequestPredicates.path(String)的组合。所以上面的例子可以重写为：

RouterFunction<?> route =
  route(GET("/hello-world"),
    request -> Response.ok().body(fromObject("Hello World")))
  .and(route(GET("/the-answer"),
    request -> Response.ok().body(fromObject(42))));

方法引用

此外，目前为止我们的处理方法都是行内的lambda表达式。尽管这样很适合于实例和简短的例子，但是当结合请求路由和请求处理两个关注点时，可能就有变“混乱”的趋势了。所以我们将尝试将他们简化。首先，创建一个包含处理逻辑的类：

class DemoHandler {
  public Response<String> helloWorld(Request request) {
    return Response.ok().body(fromObject("Hello World"));
  }
  public Response<String> theAnswer(Request request) {
    return Response.ok().body(fromObject("42"));
  }}

注意，这两个方法的签名都是和处理方法兼容的。这样就可以方法引用了：

DemoHandler handler = new DemoHandler(); // or obtain via DI
RouterFunction<?> route =
  route(GET("/hello-world"), handler::helloWorld)
  .and(route(GET("/the-answer"), handler::theAnswer));

过滤功能

由路由器函数进行映射的路由可以通过调用 RouterFunction.filter(FilterFunction) 来进行过滤, 这里的 FilterFunction 其实就是一个 BiFunction, Response>。函数的处理器（handler）参数代表的就是整个链条中的下一项: 这是一个典型的 HandlerFunction, 但如果附加了多个过滤器的话，它也能够是另外的一个 FilterFunction。让我们向路由添加一个日志过滤器：

RouterFunction<?> route =
  route(GET("/hello-world"), handler::helloWorld)
  .and(route(GET("/the-answer"), handler::theAnswer))
  .filter((request, next) -> {
    System.out.println("Before handler invocation: " + request.path());
    Response<?> response = next.handle(request);
    Object body = response.body();
    System.out.println("After handler invocation: " + body);
    return response;
  });

注意这里对下一个处理器的调用时可选的。这个在安全或者缓存的场景中是很有用的 (例如只在用户拥有足够的权限时才调用 next)。

因为 route 是一个没有被绑定的路由器函数，我们就得知道接下来的处理会返回什么类型的响应消息。这就是为什么我们在过滤器中要以一个 Response> 结束, 那样它就会可能有一个 String 类型的响应消息体。我们可以通过使用 RouterFunction.andSame() 而不是 and() 来完成这件事情。这个组合方法要求路由器函数参数是同一个类型。例如，我们可以让所有的响应消息变成小写的文本形式:

RouterFunction<String> route =
  route(GET("/hello-world"), handler::helloWorld)
  .andSame(route(GET("/the-answer"), handler::theAnswer))
  .filter((request, next) -> {
    Response<String> response = next.handle(request);
    String newBody = response.body().toUpperCase();
    return Response.from(response).body(fromObject(newBody));
  });

使用注解的话，类似的功能可以使用 @ControllerAdvice 或者是一个 ServletFilter 来实现。

运行一个服务端

所有这些都很不错，不过仍然有一块欠缺：我们如何实际地将这些函数在一个 HTTP 服务器中跑起来呢? 答案毋庸置疑，那就是通过调用另外的一个函数。 你可以通过使用 RouterFunctions.toHttpHandler() 来将一个路由器函数转换成 HttpHandler。HttpHandler 是 Spring 5.0 M1 中引入的一个响应式抽象: 它能让你运行许多的响应式运行时: Reactor Netty, RxNetty, Servlet 3.1+, 以及 Undertow。在本示例中，我们已经展示了在 Reactor Netty 中运行一个路由会是什么样子的。对于 Tomcat 来说则是像下面这个样子：

HttpHandler httpHandler = RouterFunctions.toHttpHandler(route);
HttpServlet servlet = new ServletHttpHandlerAdapter(httpHandler);
Tomcat server = new Tomcat();
Context rootContext = server.addContext("",
  System.getProperty("java.io.tmpdir"));
Tomcat.addServlet(rootContext, "servlet", servlet);  
rootContext.addServletMapping("/", "servlet");
tomcatServer.start();

需要注意的意见事情就是上面的东西并不依赖于一个 Spring 应用程序上下文。就跟 JdbcTemplate 以及其它 Spring 的工具类那样, 要不要使用应用程序上下文是可以选的: 你可以将你的处理器和路由器函数在一个上下文中进行绑定，但并不是必须的。
还要注意的就是你也可以将一个路由器函数转换到一个 HandlerMapping中去，那样就它可以在一个 DispatcherHandler (可能是跟响应式的 @Controllers 并行)中运行了。

结论

至此便結束了對 Spring 新函數式 web 框架的介紹。讓我簡單小結一下：

處理功能透過回應來處理請求，

路由器功能可連接到處理功能，並可與其他路由器功能共用，

路由器功能可由過濾器的功能進行過濾，

路由器功能可在響應式網路運作機制中運作。