02：WebFlux 快速入门实践

文章工程：

• JDK 1.8

• Maven 3.5.2

• Spring Boot 2.1.3.RELEASE

• 工程名：springboot-webflux-1-quickstart

• 工程地址：见文末

一、Spring Boot 2.0

spring.io 官网有句醒目的话是：

BUILD ANYTHING WITH SPRING BOOT

Spring Boot （Boot 顾名思义，是引导的意思）框架是用于简化 Spring 应用从搭建到开发的过程。应用开箱即用，只要通过一个指令，包括命令行 java -jar 、SpringApplication 应用启动类 、 Spring Boot Maven 插件等，就可以启动应用了。另外，Spring Boot 强调只需要很少的配置文件，所以在开发生产级 Spring 应用中，让开发变得更加高效和简易。目前，Spring Boot 版本是 2.x 版本。Spring Boot 包括 WebFlux。

二、Spring Boot 2.0 WebFlux

了解 WebFlux ,首先了解下什么是 Reactive Streams。Reactive Streams 是 JVM 中面向流的库标准和规范：

• 处理可能无限数量的元素

• 按顺序处理

• 组件之间异步传递

• 强制性非阻塞背压（Backpressure）

2.1 Backpressure(背压)

背压是一种常用策略，使得发布者拥有无限制的缓冲区存储元素，用于确保发布者发布元素太快时，不会去压制订阅者。

2.2 Reactive Streams（响应式流）

一般由以下组成：

• 发布者：发布元素到订阅者

• 订阅者：消费元素

• 订阅：在发布者中，订阅被创建时，将与订阅者共享

• 处理器：发布者与订阅者之间处理数据

2.3 响应式编程有了 Reactive Streams 这种标准和规范，利用规范可以进行响应式编程。那再了解下什么是 Reactive programming 响应式编程。响应式编程是基于异步和事件驱动的非阻塞程序，只是垂直通过在 JVM 内启动少量线程扩展，而不是水平通过集群扩展。这就是一个编程范例，具体项目中如何体现呢？

响应式项目编程实战中，通过基于 Reactive Streams 规范实现的框架 Reactor 去实战。Reactor 一般提供两种响应式 API ：

• Mono：实现发布者，并返回 0 或 1 个元素

• Flux：实现发布者，并返回 N 个元素

2.4 Spring Webflux

Spring Boot Webflux 就是基于 Reactor 实现的。Spring Boot 2.0 包括一个新的 spring-webflux 模块。该模块包含对响应式 HTTP 和 WebSocket 客户端的支持，以及对 REST，HTML 和 WebSocket 交互等程序的支持。一般来说，Spring MVC 用于同步处理，Spring Webflux 用于异步处理。

Spring Boot Webflux 有两种编程模型实现，一种类似 Spring MVC 注解方式，另一种是使用其功能性端点方式。注解的会在第二篇文章讲到，下面快速入门用 Spring Webflux 功能性方式实现。

三、Spring Boot 2.0 WebFlux 特性

常用的 Spring Boot 2.0 WebFlux 生产的特性如下：

• 响应式 API

• 编程模型

• 适用性

• 内嵌容器

• Starter 组件

还有对日志、Web、消息、测试及扩展等支持。

3.1 响应式 API

Reactor 框架是 Spring Boot Webflux 响应库依赖，通过 Reactive Streams 并与其他响应库交互。提供了 两种响应式 API : Mono 和 Flux。一般是将 Publisher 作为输入，在框架内部转换成 Reactor 类型并处理逻辑，然后返回 Flux 或 Mono 作为输出。

3.2 适用性

一图就很明确了，WebFlux 和 MVC 有交集，方便大家迁移。但是注意：

• MVC 能满足场景的，就不需要更改为 WebFlux。

• 要注意容器的支持，可以看看下面内嵌容器的支持。

• 微服务体系结构，WebFlux 和 MVC 可以混合使用。尤其开发 IO 密集型服务的时候，选择 WebFlux 去实现。

3.3 编程模型

Spring 5 web 模块包含了 Spring WebFlux 的 HTTP 抽象。类似 Servlet API , WebFlux 提供了 WebHandler API 去定义非阻塞 API 抽象接口。可以选择以下两种编程模型实现：

• 注解控制层。和 MVC 保持一致，WebFlux 也支持响应性 @RequestBody 注解。

• 功能性端点。基于 lambda 轻量级编程模型，用来路由和处理请求的小工具。和上面最大的区别就是，这种模型，全程控制了请求 - 响应的生命流程

3.4 内嵌容器

跟 Spring Boot 大框架一样启动应用，但 WebFlux 默认是通过 Netty 启动，并且自动设置了默认端口为 8080。另外还提供了对 Jetty、Undertow 等容器的支持。开发者自行在添加对应的容器 Starter 组件依赖，即可配置并使用对应内嵌容器实例。

但是要注意，必须是 Servlet 3.1+ 容器，如 Tomcat、Jetty；或者非 Servlet 容器，如 Netty 和 Undertow。

3.5 Starter 组件

跟 Spring Boot 大框架一样，Spring Boot Webflux 提供了很多 “开箱即用” 的 Starter 组件。Starter 组件是可被加载在应用中的 Maven 依赖项。只需要在 Maven 配置中添加对应的依赖配置，即可使用对应的 Starter 组件。例如，添加 spring-boot-starter-webflux 依赖，就可用于构建响应式 API 服务，其包含了 Web Flux 和 Tomcat 内嵌容器等。

开发中，很多功能是通过添加 Starter 组件的方式来进行实现。那么，Spring Boot 2.x 常用的 Starter 组件有哪些呢？

四、Spring Boot 2.0 WebFlux 组件

Spring Boot WebFlux 官方提供了很多 Starter 组件，每个模块会有多种技术实现选型支持，来实现各种复杂的业务需求：

• Web：Spring WebFlux

• 模板引擎：Thymeleaf

• 存储：Redis、MongoDB、Cassandra。不支持 MySQL

• 内嵌容器：Tomcat、Jetty、Undertow

五、快速入门

5.1 Spring Initializr 快速构建项目骨架

Spring Boot Maven 工程，就是普通的 Maven 工程，加入了对应的 Spring Boot 依赖即可。Spring Initializr 则是像代码生成器一样，自动就给你出来了一个 Spring Boot Maven 工程。Spring Initializr 有两种方式可以得到 Spring Boot Maven 骨架工程：

5.1.1 start.spring.io 在线生成

Spring 官方提供了名为 Spring Initializr 的网站，去引导你快速生成 Spring Boot 应用。网站地址为：https://start.spring.io，操作步骤如下：

第一步，选择 Maven 或者 Gradle 构建工具，开发语言 Java 、Kotlin 或者 Groovy，最后确定 Spring Boot 版本号。这里默认选择 Maven 构建工具、Java 开发语言和 Spring Boot 2.0.1。

第二步，输入 Maven 工程信息，即项目组 groupId 和名字 artifactId。这里对应 Maven 信息为：

• groupId：springboot

• artifactId：sspringboot-webflux-1-quickstart 这里默认版本号 version 为 0.0.1-SNAPSHOT 。三个属性在 Maven 依赖仓库是唯一标识的。

第三步，选择工程需要的 Starter 组件和其他依赖。最后点击生成按钮，即可获得骨架工程压缩包。这里快速入门，只要选择 Reactive Web 即可。如图 1-8 所示。

5.2 配置 POM 依赖

检查工程 POM 文件中，是否配置了 spring-boot-starter-webflux 依赖。如果是上面自动生成的，配置如下：

  <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 依赖，是我们核心需要学习 webflux 的包，里面默认包含了 spring-boot-starter-reactor-netty 、spring 5 webflux 包。也就是说默认是通过 netty 启动的。

reactor-test、spring-boot-starter-test 两个依赖搭配是用于单元测试。

spring-boot-maven-plugin 是 Spring Boot Maven 插件，可以运行、编译等调用。

5.3 编写处理器类 Handler

新建包 org.spring.springboot.handler ，作为编写功能处理类。新建城市（City）例子的处理类 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;
@Componentpublic class CityHandler {
    public Mono<ServerResponse> helloCity(ServerRequest request) {        return ServerResponse.ok().contentType(MediaType.TEXT_PLAIN)                .body(BodyInserters.fromObject("Hello, City!"));    }}

ServerResponse 是对响应的封装，可以设置响应状态，响应头，响应正文。比如 ok 代表的是 200 响应码、MediaType 枚举是代表这文本内容类型、返回的是 String 的对象。

这里用 Mono 作为返回对象，是因为返回包含了一个 ServerResponse 对象，而不是多个元素。

5.4 编写路由器类 Router

新建 org.spring.springboot.router 包，作为编写路由器类。新建城市（City）例子的路由类 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;
@Configurationpublic class CityRouter {

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

RouterFunctions 对请求路由处理类，即将请求路由到处理器。这里将一个 GET 请求 /hello 路由到处理器 cityHandler 的 helloCity 方法上。跟 Spring MVC 模式下的 HandleMapping 的作用类似。

RouterFunctions.route(RequestPredicate, HandlerFunction) 方法，对应的入参是请求参数和处理函数，如果请求匹配，就调用对应的处理器函数。

到这里一个简单的服务就写好了，下面怎么运行该服务。

5.5 启动运行项目

一个简单的 Spring Boot Webflux 工程就开发完毕了，下面运行工程验证下。使用 IDEA 右侧工具栏，点击 Maven Project Tab ，点击使用下 Maven 插件的 install 命令。或者使用命令行的形式，在工程根目录下，执行 Maven 清理和安装工程的指令：

cd springboot-webflux-1-quickstartmvn clean install

在控制台中看到成功的输出：

... 省略[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] ------------------------------------------------------------------------

5.5.1 运行工程

在 IDEA 中执行 Application 类启动，任意正常模式或者 Debug 模式。可以在控制台看到成功运行的输出：

... 省略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:80802018-04-10 08:43:39.935  INFO 2052 --- [           main] o.s.b.web.embedded.netty.NettyWebServer  : Netty started on port(s): 80802018-04-10 08:43:39.960  INFO 2052 --- [           main] org.spring.springboot.Application        : Started Application in 6.547 seconds (JVM running for 9.851)

一看，确实是 Netty 启动的。

打开浏览器，访问 /hello 地址，会看到如图所示的返回结果：

六、总结

本文主要讲了 Spring Boot 2.0 WebFlux 背景和快速入门使用。用的是基于功能性端点去创建一个服务，但这个有点代码偏多。下一章一个 CRUD 我们使用注解控制层，让开发更方便。

系列教程目录

• 《01：WebFlux 系列教程大纲》

• 《02：WebFlux 快速入门实践》

• 《03：WebFlux Web CRUD 实践》

• 《04：WebFlux 整合 Mongodb》

• 《05：WebFlux 整合 Thymeleaf》

• 《06：WebFlux 中 Thymeleaf 和 Mongodb 实践》

• 《07：WebFlux 整合 Redis》

• 《08：WebFlux 中 Redis 实现缓存》

• 《09：WebFlux 中 WebSocket 实现通信》

• 《10：WebFlux 集成测试及部署》

• 《11：WebFlux 实战图书管理系统》

代码示例

本文示例读者可以通过查看下面仓库的中的模块工程名: 2-x-spring-boot-webflux-handling-errors：

• Github：https://github.com/JeffLi1993/springboot-learning-example
  

• Gitee：https://gitee.com/jeff1993/springboot-learning-example
  

如果您对这些感兴趣，欢迎 star、follow、收藏、转发给予支持！

参考资料

• Spring Boot 2.x WebFlux 系列：https://www.bysocket.com/archives/2290

• spring.io 官方文档