Spring Boot 2.0 WebFlux 快速入門(mén)實(shí)踐

02：WebFlux 快速入門(mén)實(shí)踐

Spring Boot 2.0

spring.io 官網(wǎng)有句醒目的話(huà)是：

BUILD ANYTHING WITH SPRING BOOT

Spring Boot （Boot 顧名思義，是引導(dǎo)的意思）框架是用于簡(jiǎn)化 Spring 應(yīng)用從搭建到開(kāi)發(fā)的過(guò)程挤茄。應(yīng)用開(kāi)箱即用锻霎，只要通過(guò)一個(gè)指令莫其，包括命令行 java -jar 墓阀、SpringApplication 應(yīng)用啟動(dòng)類(lèi) 塌碌、 Spring Boot Maven 插件等舆驶，就可以啟動(dòng)應(yīng)用了橱健。另外，Spring Boot 強(qiáng)調(diào)只需要很少的配置文件沙廉，所以在開(kāi)發(fā)生產(chǎn)級(jí) Spring 應(yīng)用中拘荡，讓開(kāi)發(fā)變得更加高效和簡(jiǎn)易。目前撬陵，Spring Boot 版本是 2.x 版本珊皿。Spring Boot 包括 WebFlux。

Spring Boot 2.0 WebFlux

了解 WebFlux ,首先了解下什么是 Reactive Streams巨税。Reactive Streams 是 JVM 中面向流的庫(kù)標(biāo)準(zhǔn)和規(guī)范：

處理可能無(wú)限數(shù)量的元素
按順序處理
組件之間異步傳遞
強(qiáng)制性非阻塞背壓（Backpressure）

Backpressure(背壓)

背壓是一種常用策略蟋定，使得發(fā)布者擁有無(wú)限制的緩沖區(qū)存儲(chǔ)元素，用于確保發(fā)布者發(fā)布元素太快時(shí)草添，不會(huì)去壓制訂閱者驶兜。

Reactive Streams（響應(yīng)式流）

一般由以下組成：

發(fā)布者：發(fā)布元素到訂閱者
訂閱者：消費(fèi)元素
訂閱：在發(fā)布者中，訂閱被創(chuàng)建時(shí)远寸，將與訂閱者共享
處理器：發(fā)布者與訂閱者之間處理數(shù)據(jù)

響應(yīng)式編程
有了 Reactive Streams 這種標(biāo)準(zhǔn)和規(guī)范抄淑，利用規(guī)范可以進(jìn)行響應(yīng)式編程。那再了解下什么是 Reactive programming 響應(yīng)式編程驰后。響應(yīng)式編程是基于異步和事件驅(qū)動(dòng)的非阻塞程序肆资，只是垂直通過(guò)在 JVM 內(nèi)啟動(dòng)少量線(xiàn)程擴(kuò)展，而不是水平通過(guò)集群擴(kuò)展倡怎。這就是一個(gè)編程范例迅耘，具體項(xiàng)目中如何體現(xiàn)呢贱枣？

響應(yīng)式項(xiàng)目編程實(shí)戰(zhàn)中，通過(guò)基于 Reactive Streams 規(guī)范實(shí)現(xiàn)的框架 Reactor 去實(shí)戰(zhàn)颤专。Reactor 一般提供兩種響應(yīng)式 API ：

Mono：實(shí)現(xiàn)發(fā)布者纽哥，并返回 0 或 1 個(gè)元素
Flux：實(shí)現(xiàn)發(fā)布者，并返回 N 個(gè)元素

Spring Webflux

Spring Boot Webflux 就是基于 Reactor 實(shí)現(xiàn)的栖秕。Spring Boot 2.0 包括一個(gè)新的 spring-webflux 模塊春塌。該模塊包含對(duì)響應(yīng)式 HTTP 和 WebSocket 客戶(hù)端的支持，以及對(duì) REST簇捍，HTML 和 WebSocket 交互等程序的支持只壳。一般來(lái)說(shuō)，Spring MVC 用于同步處理暑塑，Spring Webflux 用于異步處理吼句。

Spring Boot Webflux 有兩種編程模型實(shí)現(xiàn)，一種類(lèi)似 Spring MVC 注解方式事格，另一種是使用其功能性端點(diǎn)方式惕艳。注解的會(huì)在第二篇文章講到，下面快速入門(mén)用 Spring Webflux 功能性方式實(shí)現(xiàn)驹愚。

Spring Boot 2.0 WebFlux 特性

常用的 Spring Boot 2.0 WebFlux 生產(chǎn)的特性如下：

響應(yīng)式 API
編程模型
適用性
內(nèi)嵌容器
Starter 組件

還有對(duì)日志远搪、Web、消息逢捺、測(cè)試及擴(kuò)展等支持谁鳍。

響應(yīng)式 API

Reactor 框架是 Spring Boot Webflux 響應(yīng)庫(kù)依賴(lài)，通過(guò) Reactive Streams 并與其他響應(yīng)庫(kù)交互劫瞳。提供了兩種響應(yīng)式 API : Mono 和 Flux倘潜。一般是將 Publisher 作為輸入，在框架內(nèi)部轉(zhuǎn)換成 Reactor 類(lèi)型并處理邏輯志于，然后返回 Flux 或 Mono 作為輸出窍荧。

適用性

file

一圖就很明確了，WebFlux 和 MVC 有交集恨憎，方便大家遷移。但是注意：

MVC 能滿(mǎn)足場(chǎng)景的郊楣，就不需要更改為 WebFlux憔恳。
要注意容器的支持，可以看看下面內(nèi)嵌容器的支持净蚤。
微服務(wù)體系結(jié)構(gòu)钥组，WebFlux 和 MVC 可以混合使用。尤其開(kāi)發(fā) IO 密集型服務(wù)的時(shí)候今瀑，選擇 WebFlux 去實(shí)現(xiàn)程梦。

編程模型

Spring 5 web 模塊包含了 Spring WebFlux 的 HTTP 抽象点把。類(lèi)似 Servlet API , WebFlux 提供了 WebHandler API 去定義非阻塞 API 抽象接口∮旄剑可以選擇以下兩種編程模型實(shí)現(xiàn)：

注解控制層郎逃。和 MVC 保持一致，WebFlux 也支持響應(yīng)性 @RequestBody 注解挺份。
功能性端點(diǎn)褒翰。基于 lambda 輕量級(jí)編程模型匀泊，用來(lái)路由和處理請(qǐng)求的小工具优训。和上面最大的區(qū)別就是，這種模型各聘，全程控制了請(qǐng)求 - 響應(yīng)的生命流程

內(nèi)嵌容器

跟 Spring Boot 大框架一樣啟動(dòng)應(yīng)用揣非，但 WebFlux 默認(rèn)是通過(guò) Netty 啟動(dòng)，并且自動(dòng)設(shè)置了默認(rèn)端口為 8080躲因。另外還提供了對(duì) Jetty早敬、Undertow 等容器的支持。開(kāi)發(fā)者自行在添加對(duì)應(yīng)的容器 Starter 組件依賴(lài)毛仪，即可配置并使用對(duì)應(yīng)內(nèi)嵌容器實(shí)例搁嗓。

但是要注意，必須是 Servlet 3.1+ 容器箱靴，如 Tomcat腺逛、Jetty；或者非 Servlet 容器衡怀，如 Netty 和 Undertow棍矛。

Starter 組件

跟 Spring Boot 大框架一樣，Spring Boot Webflux 提供了很多 “開(kāi)箱即用” 的 Starter 組件抛杨。Starter 組件是可被加載在應(yīng)用中的 Maven 依賴(lài)項(xiàng)够委。只需要在 Maven 配置中添加對(duì)應(yīng)的依賴(lài)配置，即可使用對(duì)應(yīng)的 Starter 組件怖现。例如丰包，添加 spring-boot-starter-webflux 依賴(lài)，就可用于構(gòu)建響應(yīng)式 API 服務(wù)蒿褂，其包含了 Web Flux 和 Tomcat 內(nèi)嵌容器等绩衷。

開(kāi)發(fā)中，很多功能是通過(guò)添加 Starter 組件的方式來(lái)進(jìn)行實(shí)現(xiàn)饶号。那么铁追，Spring Boot 2.x 常用的 Starter 組件有哪些呢？

Spring Boot 2.0 WebFlux 組件

Spring Boot WebFlux 官方提供了很多 Starter 組件茫船，每個(gè)模塊會(huì)有多種技術(shù)實(shí)現(xiàn)選型支持琅束，來(lái)實(shí)現(xiàn)各種復(fù)雜的業(yè)務(wù)需求：

Web：Spring WebFlux
模板引擎：Thymeleaf
存儲(chǔ)：Redis扭屁、MongoDB、Cassandra涩禀。不支持 MySQL
內(nèi)嵌容器：Tomcat料滥、Jetty、Undertow

快速入門(mén)

Spring Initializr 快速構(gòu)建項(xiàng)目骨架

Spring Boot Maven 工程埋泵，就是普通的 Maven 工程幔欧，加入了對(duì)應(yīng)的 Spring Boot 依賴(lài)即可。Spring Initializr 則是像代碼生成器一樣丽声，自動(dòng)就給你出來(lái)了一個(gè) Spring Boot Maven 工程礁蔗。Spring Initializr 有兩種方式可以得到 Spring Boot Maven 骨架工程：

start.spring.io 在線(xiàn)生成

Spring 官方提供了名為 Spring Initializr 的網(wǎng)站，去引導(dǎo)你快速生成 Spring Boot 應(yīng)用雁社。網(wǎng)站地址為：https://start.spring.io浴井，操作步驟如下：

第一步，選擇 Maven 或者 Gradle 構(gòu)建工具霉撵，開(kāi)發(fā)語(yǔ)言 Java 磺浙、Kotlin 或者 Groovy，最后確定 Spring Boot 版本號(hào)徒坡。這里默認(rèn)選擇 Maven 構(gòu)建工具撕氧、Java 開(kāi)發(fā)語(yǔ)言和 Spring Boot 2.0.1。

第二步喇完，輸入 Maven 工程信息伦泥，即項(xiàng)目組 groupId 和名字 artifactId。這里對(duì)應(yīng) Maven 信息為：

groupId：springboot
artifactId：sspringboot-webflux-1-quickstart
這里默認(rèn)版本號(hào) version 為 0.0.1-SNAPSHOT 锦溪。三個(gè)屬性在 Maven 依賴(lài)倉(cāng)庫(kù)是唯一標(biāo)識(shí)的不脯。

第三步，選擇工程需要的 Starter 組件和其他依賴(lài)刻诊。最后點(diǎn)擊生成按鈕防楷，即可獲得骨架工程壓縮包。這里快速入門(mén)则涯，只要選擇 Reactive Web 即可复局。如圖 1-8 所示。

配置 POM 依賴(lài)

檢查工程 POM 文件中粟判，是否配置了 spring-boot-starter-webflux 依賴(lài)肖揣。如果是上面自動(dòng)生成的，配置如下：

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-webflux</artifactId>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>io.projectreactor</groupId>
      <artifactId>reactor-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>

spring-boot-starter-webflux 依賴(lài)浮入，是我們核心需要學(xué)習(xí) webflux 的包，里面默認(rèn)包含了 spring-boot-starter-reactor-netty 羊异、spring 5 webflux 包事秀。也就是說(shuō)默認(rèn)是通過(guò) netty 啟動(dòng)的彤断。

reactor-test、spring-boot-starter-test 兩個(gè)依賴(lài)搭配是用于單元測(cè)試易迹。

spring-boot-maven-plugin 是 Spring Boot Maven 插件宰衙，可以運(yùn)行、編譯等調(diào)用睹欲。

編寫(xiě)處理器類(lèi) Handler

新建包 org.spring.springboot.handler 供炼，作為編寫(xiě)功能處理類(lèi)。新建城市（City）例子的處理類(lèi) CityHandler窘疮，代碼如下：

import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.BodyInserters;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import reactor.core.publisher.Mono;

@Component
public class CityHandler {

    public Mono<ServerResponse> helloCity(ServerRequest request) {
        return ServerResponse.ok().contentType(MediaType.TEXT_PLAIN)
                .body(BodyInserters.fromObject("Hello, City!"));
    }
}

ServerResponse 是對(duì)響應(yīng)的封裝袋哼，可以設(shè)置響應(yīng)狀態(tài)，響應(yīng)頭闸衫，響應(yīng)正文涛贯。比如 ok 代表的是 200 響應(yīng)碼、MediaType 枚舉是代表這文本內(nèi)容類(lèi)型蔚出、返回的是 String 的對(duì)象弟翘。

這里用 Mono 作為返回對(duì)象，是因?yàn)榉祷匕艘粋€(gè) ServerResponse 對(duì)象骄酗，而不是多個(gè)元素稀余。

編寫(xiě)路由器類(lèi) Router

新建 org.spring.springboot.router 包，作為編寫(xiě)路由器類(lèi)趋翻。新建城市（City）例子的路由類(lèi) CityRouter睛琳，代碼如下：

import org.spring.springboot.handler.CityHandler;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.reactive.function.server.RequestPredicates;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerResponse;

@Configuration
public class CityRouter {


    @Bean
    public RouterFunction<ServerResponse> routeCity(CityHandler cityHandler) {
        return RouterFunctions
                .route(RequestPredicates.GET("/hello")
                                .and(RequestPredicates.accept(MediaType.TEXT_PLAIN)),
                        cityHandler::helloCity);
    }

}

RouterFunctions 對(duì)請(qǐng)求路由處理類(lèi)，即將請(qǐng)求路由到處理器嘿歌。這里將一個(gè) GET 請(qǐng)求 /hello 路由到處理器 cityHandler 的 helloCity 方法上掸掏。跟 Spring MVC 模式下的 HandleMapping 的作用類(lèi)似。

RouterFunctions.route(RequestPredicate, HandlerFunction) 方法宙帝，對(duì)應(yīng)的入?yún)⑹钦?qǐng)求參數(shù)和處理函數(shù)丧凤，如果請(qǐng)求匹配，就調(diào)用對(duì)應(yīng)的處理器函數(shù)步脓。

到這里一個(gè)簡(jiǎn)單的服務(wù)就寫(xiě)好了愿待，下面怎么運(yùn)行該服務(wù)。

啟動(dòng)運(yùn)行項(xiàng)目

一個(gè)簡(jiǎn)單的 Spring Boot Webflux 工程就開(kāi)發(fā)完畢了靴患，下面運(yùn)行工程驗(yàn)證下仍侥。使用 IDEA 右側(cè)工具欄，點(diǎn)擊 Maven Project Tab 鸳君，點(diǎn)擊使用下 Maven 插件的 install 命令农渊。或者使用命令行的形式或颊，在工程根目錄下砸紊，執(zhí)行 Maven 清理和安裝工程的指令：

cd springboot-webflux-1-quickstart
mvn clean install

在控制臺(tái)中看到成功的輸出：

... 省略
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:30 min
[INFO] Finished at: 2017-10-15T10:00:54+08:00
[INFO] Final Memory: 31M/174M
[INFO] ------------------------------------------------------------------------

運(yùn)行工程

在 IDEA 中執(zhí)行 Application 類(lèi)啟動(dòng)传于，任意正常模式或者 Debug 模式∽硗纾可以在控制臺(tái)看到成功運(yùn)行的輸出：

... 省略
2018-04-10 08:43:39.932  INFO 2052 --- [ctor-http-nio-1] r.ipc.netty.tcp.BlockingNettyContext     : Started HttpServer on /0:0:0:0:0:0:0:0:8080
2018-04-10 08:43:39.935  INFO 2052 --- [           main] o.s.b.web.embedded.netty.NettyWebServer  : Netty started on port(s): 8080
2018-04-10 08:43:39.960  INFO 2052 --- [           main] org.spring.springboot.Application        : Started Application in 6.547 seconds (JVM running for 9.851)

一看沼溜，確實(shí)是 Netty 啟動(dòng)的。

打開(kāi)瀏覽器游添，訪(fǎng)問(wèn) /hello 地址系草，會(huì)看到如圖所示的返回結(jié)果：