Spring Boot WebFlux 快速入门实践

  • 时间:
  • 浏览:1

Spring Boot 2.0

spring.io 官网有句醒目语录是:

BUILD ANYTHING WITH SPRING BOOT

Spring Boot (Boot 顾名思义,是引导的意思)框架是用于错综复杂 Spring 应用从搭建到开发的过程。应用开箱即用,假若通过一一1个指令,包括命令行 java -jarSpringApplication 应用启动类 、 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)

Backpressure(背压)

背压是四种 常用策略,使得发布者拥否是限制的缓冲区存储元素,用于确保发布者发布元素那末来越快时,那末多去压制订阅者。

Reactive Streams(响应式流)

一般由以下组成:

  • 发布者:发布元素到订阅者
  • 订阅者:消费元素
  • 订阅:在发布者中,订阅被创建时,将与订阅者共享
  • 除理器:发布者与订阅者之间除理数据

响应式编程

有了 Reactive Streams 什么都有有标准和规范,利用规范能够 进行响应式编程。那再了解下哪些是 Reactive programming 响应式编程。响应式编程是基于异步和事件驱动的非阻塞应用应用程序,假若垂直通过在 JVM 内启动一定量应用应用程序扩展,而都是水平通过集群扩展。这假若一一1个编程范例,具体项目中如保体现呢?

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

  • Mono:实现发布者,并返回 0 或 1 个元素
  • Flux:实现发布者,并返回 N 个元素

Spring Webflux

Spring Boot Webflux 假若基于 Reactor 实现的。Spring Boot 2.0 包括一一1个新的 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、消息、测试及扩展等支持。

响应式 API

Reactor 框架是 Spring Boot Webflux 响应库依赖,通过 Reactive Streams 并与什么都有有响应库交互。提供了 四种 响应式 API : Mono 和 Flux。一般是将 Publisher 作为输入,在框架内内外部转添加 Reactor 类型并除理逻辑,否则返回 Flux 或 Mono 作为输出。

适用性

一图就很明确了,WebFlux 和 MVC 有交集,方便他们迁移。否则注意:

  • MVC 能满足场景的,就不能够 更改为 WebFlux。
  • 要注意容器的支持,能够 看看下面内嵌容器的支持。
  • 微服务体系型态,WebFlux 和 MVC 能够 混合使用。尤其开发 IO 密集型服务的前一天,选取 WebFlux 去实现。

编程模型

Spring 5 web 模块包含了 Spring WebFlux 的 HTTP 抽象。同类 Servlet API , WebFlux 提供了 WebHandler API 去定义非阻塞 API 抽象接口。能够 选取以下四种 编程模型实现:

  • 注解控制层。和 MVC 保持一致,WebFlux 也支持响应性 @RequestBody 注解。
  • 功能性端点。基于 lambda 轻量级编程模型,用来路由和除理请求的小工具。和上面最大的区别假若,什么都有有模型,全程控制了请求 - 响应的生命流程

内嵌容器

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

否则要注意,能够 是 Servlet 3.1+ 容器,如 Tomcat、Jetty;可能非 Servlet 容器,如 Netty 和 Undertow。

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

快速入门

Spring Initializr 快速构建项目骨架

Spring Boot Maven 工程,假若普通的 Maven 工程,加入了对应的 Spring Boot 依赖即可。Spring Initializr 则是像代码生成器一样,自动就你能够 出来了一一1个 Spring Boot Maven 工程。Spring Initializr 有四种 法子能够 得到 Spring Boot Maven 骨架工程:

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 。一一1个属性在 Maven 依赖仓库是唯一标识的。

第三步,选取工程能够 的 Starter 组件和什么都有有依赖。最后点击生成按钮,即可获得骨架工程压缩包。这里快速入门,假若选取 Reactive Web 即可。如图 1-8 所示。

配置 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 一一1个依赖搭配是用于单元测试。

spring-boot-maven-plugin 是 Spring Boot Maven 插件,能够 运行、编译等调用。

编写除理器类 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;

@Component
public class CityHandler {

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

ServerResponse 是对响应的封装,能够 设置响应具体情况,响应头,响应正文。比如 ok 代表的是 150 响应码、MediaType 枚举是代表这文本内容类型、返回的是 String 的对象。

这里用 Mono 作为返回对象,是可能返回包含了一一1个 ServerResponse 对象,而都是多个元素。

编写路由器类 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;

@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 对请求路由除理类,即将请求路由到除理器。这里将一一1个 GET 请求 /hello 路由到除理器 cityHandler 的 helloCity 法子上。跟 Spring MVC 模式下的 HandleMapping 的作用同类。

RouterFunctions.route(RequestPredicate, HandlerFunction) 法子,对应的入参是请求参数和除理函数,可能请求匹配,就调用对应的除理器函数。

到这里一一1个简单的服务就写好了,下面为什么运行该服务。

启动运行项目

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

cd springboot-webflux-1-quickstart
mvn clean install

在控制台中就看成功的输出:

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

运行工程

在 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:150150
2018-04-10 08:43:39.935  INFO 2052 --- [           main] o.s.b.web.embedded.netty.NettyWebServer  : Netty started on port(s): 150150
2018-04-10 08:43:39.9150  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 背景和快速入门使用。用的是基于功能性端点去创建一一1个服务,但什么都有有怪怪的代码偏多。下一章一一1个 CRUD 他们使用注解控制层,让开发更方便。