Spring 5 新特性:函數(shù)式Web框架

2016-11-4    藍(lán)藍(lán)設(shè)計(jì)的小編

如果您想訂閱本博客內(nèi)容,每天自動(dòng)發(fā)到您的郵箱中, 請(qǐng)點(diǎn)這里


舉例

我們先從示例應(yīng)用程序的一些摘錄開始。下面是暴露Person對(duì)象的響應(yīng)信息庫。很類似于傳統(tǒng)的,非響應(yīng)信息庫,只不過它返回Flux<Person>而傳統(tǒng)的返回List<Person>,以及返回Mono<Person>的地方返回Person。Mono<Void>用作完成標(biāo)識(shí):指出何時(shí)保存被完成。關(guān)于Reactor類型的更多信息,請(qǐng)參閱

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

下面是我們?nèi)绾伪┞稁в行碌暮瘮?shù)式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));
}));

下面我們要介紹如何運(yùn)行,比如在Reactor Netty中:

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

最后要做的一件事是試一試:

$ curl 'http://localhost:8080/person/1' {"name":"John Doe","age":42}

下面還有更多介紹,讓我們挖掘得更深!

核心組件

我會(huì)通過徹底說明核心組件來介紹框架:HandlerFunction,RouterFunction,以及FilterFunction。這三個(gè)接口以及文中描述的所有其他類型都可以在org.springframework.web.reactive.function包中找到。

HandlerFunction

這一新框架的起點(diǎn)是HandlerFunction<T>,基本上是Function<Request, Response<T>>,其中Request和Response是新定義的,一成不變的界面友好地來提供JDK-8 DSL到底層HTTP消息。對(duì)于構(gòu)建Response實(shí)體是一個(gè)方便的構(gòu)建工具,非常類似于在ResponseEntity中看到的。對(duì)應(yīng)到HandlerFunction注解是一個(gè)帶有@RequestMapping的方法。

下面是一個(gè)簡單的“Hello World”處理函數(shù)的例子,返回有200狀態(tài)以及body為String的響應(yīng)消息:

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

正如我們?cè)谏厦娴睦又锌吹降模幚砗瘮?shù)是通過構(gòu)建在Reactor的基礎(chǔ)上而完全響應(yīng):它們接受Flux,Mono,或任何其他相應(yīng)的流Publisher作為響應(yīng)類型。

要注意的一點(diǎn),HandlerFunction本身是沒有副作用的,因?yàn)樗祷仨憫?yīng),而不是把它當(dāng)作一個(gè)參數(shù)(參見Servlet.service(ServletRequest,ServletResponse),這實(shí)質(zhì)上是BiConsumer<ServletRequest,ServletResponse> )。沒有副作用有很多好處:易于測(cè)試,編寫和優(yōu)化。

RouterFunction

傳入的請(qǐng)求被路由到有RouterFunction<T>的處理函數(shù)(即Function<Request, Optional<HandlerFunction<T>>)路由到處理函數(shù),如果它匹配的話;否則就返回一個(gè)空的結(jié)果。路由方法與@RequestMapping注解的作用相似。但是,還有一個(gè)顯著的區(qū)別:用注解時(shí)路由會(huì)被限制到注解的value所能表達(dá)的范圍,處理這些方法的覆蓋是困難的;當(dāng)用路由方法的時(shí)候,代碼就在那里,可以輕松的覆蓋或替換。

下面是一個(gè)有內(nèi)嵌處理函數(shù)的路由函數(shù)的例子。它看起來有點(diǎn)冗長,但不要擔(dān)心:我們會(huì)找到辦法讓它變短。

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

一般不用寫完整的路由方法,而是靜態(tài)引入RouterFunctions.route(),這樣就可以用請(qǐng)求判斷式(RequestPredicate) (即 Predicate<Request>)和處理方法(HandlerFunction)創(chuàng)建路由方法了。如果判斷式判斷成功則返回處理方法,否則返回空結(jié)果。如下是用route方法方式重寫上面的例子:

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

你可以(靜態(tài)地)導(dǎo)入RequestPredicates.*以訪問常用的謂詞,基于路徑、HTTP方法、內(nèi)容類型等等匹配。有了它,我們可以使helloWorldRoute更簡單:

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

組合函數(shù)

兩個(gè)路由函數(shù)可以組成一個(gè)新的路由函數(shù),路由到任一個(gè)處理函數(shù):如果第一個(gè)函數(shù)不匹配,那么就執(zhí)行第二個(gè)。你可以通過調(diào)用RouterFunction.and(),像這樣組合兩個(gè)路由函數(shù):

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,以上將回應(yīng)“Hello World”,如果匹配/the-answer,則同時(shí)返回“42”。如果兩者都不匹配,則返回一個(gè)空的Optional。請(qǐng)注意,組合的路由函數(shù)會(huì)依次執(zhí)行,因此在具體函數(shù)之前放入泛型函數(shù)是有意義的。

你也可以組合要求謂詞,通過調(diào)用and或or。工作方式是這樣:對(duì)于and,如果兩個(gè)給定謂詞匹配的話,結(jié)果謂詞匹配,而如果兩者中的一個(gè)謂語匹配的話,那么就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"))));

事實(shí)上,在RequestPredicates發(fā)現(xiàn)的大多數(shù)謂詞是組合的!例如,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))));

方法引用

順便說一句:到目前為止,我們已經(jīng)編寫了所有的處理函數(shù)作為內(nèi)聯(lián)的lambda表達(dá)式。雖然這在演示和短的例子中表現(xiàn)良好,但是不得不說這有一種會(huì)導(dǎo)致“混亂”的傾向,因?yàn)槟阋旌蟽煞N擔(dān)憂:請(qǐng)求路由和請(qǐng)求處理。因此,我們要看看是否能夠讓事情變得更簡潔。首先,我們創(chuàng)建一個(gè)包含處理代碼的類:

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"));
    }
}

注意,兩個(gè)方法都有一個(gè)兼容了處理函數(shù)的標(biāo)志。這允許我們使用方法引用:

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

FilterFunction

由路由函數(shù)映射的路徑可以通過調(diào)用RouterFunction.filter(FilterFunction<T, R>)進(jìn)行過濾,其中FilterFunction<T,R>本質(zhì)上是BiFunction<Request, HandlerFunction<T>, Response<R>>。函數(shù)的處理器(handler)參數(shù)代表的就是整個(gè)鏈條中的下一項(xiàng): 這是一個(gè)典型的 HandlerFunction, 但如果附加了多個(gè)過濾器的話,它也能夠是另外的一個(gè) FilterFunction。讓我們向路由添加一個(gè)日志過濾器:

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;
});

需要注意的是,要不要調(diào)用下一個(gè)處理程序是可選的。這在安全和緩存方案中非常有用(如只在用戶有足夠權(quán)限的時(shí)候調(diào)用next)。

由于route是一個(gè)無限路由函數(shù),因此我們知道接下來的處理程序會(huì)返回什么類型的響應(yīng)信息。這就是為什么我們最終在我們的過濾器中用Response<?>結(jié)束以及用Object響應(yīng)body的原因。在處理程序類中,兩種方法都返回Response<String>,所以應(yīng)該有可能有String響應(yīng)主體。我們可以通過使用RouterFunction.andSame()來代替and()做到這一點(diǎn)。這種組合方法需要參數(shù)路由函數(shù)是相同的類型。例如,我們可以讓所有的響應(yīng)變成大寫:

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來實(shí)現(xiàn)。

運(yùn)行服務(wù)端

所有這一切都很好,但有一件事忘了:我們?nèi)绾尾拍茉趯?shí)際的HTTP服務(wù)器中運(yùn)行這些函數(shù)呢?答案勿庸置疑是通過調(diào)用另一個(gè)函數(shù)。你可以通過使用RouterFunctions.toHttpHandler()將路由函數(shù)轉(zhuǎn)換成HttpHandler。HttpHandler是引進(jìn)到Spring 5.0 M1的一個(gè)響應(yīng)抽象:它允許你運(yùn)行在各種響應(yīng)運(yùn)行時(shí)上:Reactor Netty、RxNetty、Servlet 3.1+,和Undertow。在這個(gè)例子中,我們已經(jīng)表明了在Reactor Netty中運(yùn)行route是怎么樣的。對(duì)于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();

有一點(diǎn)要注意的是,上面的代碼不依賴于Spring應(yīng)用程序上下文。就像JdbcTemplate和其他Spring實(shí)用工具類,使用應(yīng)用程序上下文是可選的:你可以在上下文中接通處理程序和路由函數(shù),但它不是必需的。

還要注意的是,你也可以轉(zhuǎn)換路由函數(shù)為HandlerMapping,以便它可以在DispatcherHandler中運(yùn)行(可能需要有響應(yīng)的@Controllers)。

結(jié)論

讓我通過簡短的總結(jié)來得出結(jié)論:

  • 處理函數(shù)通過返回響應(yīng)處理請(qǐng)求。
  • 路由函數(shù)路由到處理函數(shù),并且可以與其他路由函數(shù)組合。
  • 路由函數(shù)可以通過過濾器進(jìn)行過濾。
  • 路由函數(shù)可以在響應(yīng)的web運(yùn)行時(shí)中運(yùn)行。


藍(lán)藍(lán)設(shè)計(jì)m.sillybuy.com )是一家專注而深入的界面設(shè)計(jì)公司,為期望卓越的國內(nèi)外企業(yè)提供卓越的UI界面設(shè)計(jì)、BS界面設(shè)計(jì) 、 cs界面設(shè)計(jì) 、 ipad界面設(shè)計(jì) 、 包裝設(shè)計(jì) 、 圖標(biāo)定制 、 用戶體驗(yàn) 、交互設(shè)計(jì)、 網(wǎng)站建設(shè) 平面設(shè)計(jì)服務(wù)

日歷

鏈接

個(gè)人資料

存檔