实战SpringCloud响应式微服务系列教程（第九章）使用Spring WebFlux构建响应式RESTful服务

本文为实战SpringCloud响应式微服务系列教程第九章，讲解使用Spring WebFlux构建响应式RESTful服务。建议没有之前基础的童鞋，先看之前的章节，章节目录放在文末。

从本节开始我们将正式进入构建响应式服务的世界。在Spring boot的基础上，我们将引入全新的Spring WebFlux框架。

WebFlux名称中的Flux来源于上章节介绍的来自Reactor框架中的Flux组件。该框架中包含了对响应式HTTP、服务器推送事件以及Websocket的客户端和服务端的支持。

在构架响应式服务上，WebFlux支持两种不同的编程模型：

• 第一种是与SpringMvc中同样使用的基于java注解的方式；
• 第二种是基于java8中提供的lambda表达式的函数式编程模型。

1.1使用 Spring Initializer初始化响应式web应用

创建WebFlux应用最简单的方式便是使用Spring boot提供的Spring Initializer初始化模板。

直接访问Spring Initializer网站（http://start.spring.io），选择创建一个maven或者Gradle项目并制定相应的Group和Artifact，然后在添加依赖中选择maven进行代码依赖管理。

打开所下载项目中的pom文件，会找到如下依赖。

• spring-boot-starter-webflux构成响应式web程序开发的基础；
• spring-boot-starter-test是包含JUnit、Spring boot Test、Mockito、AssertJ、JSONAssert以及Hamcerst等工具在内的测试组件库；
• reactor-test则是用来测试Reactor框架的测试组件；
• spring-boot-starter-data-mongodb-reactive和spring-boot-starter-data-redis-reactive则是响应式数据访问组件。

 

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
<!--Lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
<version>1.16.22</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb-reactive</artifactId>
</dependency>
<!--  redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis-reactive</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>

 

至此，使用Spring WebFlux构架响应式服务的基础环境已经准备完毕。

关于Spring WebFlux和传统的SpringMvc的关系可以自行百度了解，这里不做过多介绍。

1.2使用注解编程模型创建响应式RESTful服务

基于注解编程模型来创建响应式RESTful服务与使用传统SpringMvc非常类似。通过掌握响应式编程的基本概念和技巧，在webflux中使用这种编程模型几乎没有任何学习成本。

构建第一个响应式RESTful服务

第一个响应式RESTful服务来自于对之前HelloController示例进行改造，改造之后的代码如下：

 

@RestController
public class Helloontroller{
@GetMapping("/")
public Mono<String> index(){
return Mono.just("Hello Spring Boot");
}
}

 

以上代码只有一个地方值得注意，即

index()

方法的返回值类型是

Mono<String>

类型，其中包含的字符串"Hello Spring Boot"或作为HTTP的响应内容。

在浏览器中访问会得到如下结果：

从以上代码可以看到使用Spring WebFlux和使用 Spring Mvc的不同在于，WebFlux所使用的类型是与响应式编程相对应的Flux和Mono对象，而不是简单的POJO，对于简单的Hello Word实力来说，这两个之间并没有什么太大的差别。

但是对于复杂的应用来说，响应式编程的背压机制就会体现出来，可以带来整体性能的提升。在后续讲解中会有完整示例代码。

1.3使用函数式模型创建响应式RESTful服务

这部分内容与传统的SpringMvc构建RESTful服务有较大的差别。

（1）函数式编程模型

在Spring WebFlux中，函数式编程模型的核心概念是Router Functions，对标

@Controller

、

@RequestMapping

等标准的Spring Mvc注解。

Router Functions提供一套函数式的API，用于创建Router和Handler对象。其中我们可以简单的把Handler对应为Controller，把Router对应为RequestMapping。

当我们发起一个远程调用时，传入的HTTP请求由HandlerFunction处理，HandlerFunction本质上是一个接收ServerRequest并返回一个

Mono<ServerResponse>

的函数。ServerRequest和ServerResponse是一个不可变的接口，用来提供对底层HTTTP消息的友好访问。

具体代码示例如下：

 

public class HelloWordHandlerFunction impllements HandlerFunction<ServerResponse>{
@Override
public Mono<ServerResponse> handle(ServerRequest request){
return ServerResponse.ok().body(BodyInserters.fromObject("Hello Word"))
}
}

 

关于ServerRequest和ServerResponse我们在这里不做过多介绍，详细了解可查阅相关资料。

以上代码将ServerRequest和ServerResponse组合到一起创建了HandlerFunction。HandlerFunction是一个接口，可以通过实现该接口中的

handl()

方法来创建定制化的请求响应处理机制。

通常我们会针对某个领域实体对象编写多个处理函数，所以推荐将多个处理函数分组到一个专门的Handler类中。例如我们编写一个PersonHandler专门实现各种针对Person领域对象的处理函数。

代码如下：

 

public class PersonHandler{
@Autowired
private PersonService personService;
public Mono<ServerResponse> getPersons(ServerRequest request){
return ServerResponse.ok().body(this.personService.getPersons(),Person.class)
}
}

 

（2）RouterFunction

上面我们已经通过HandlerFunction创建了请求的逻辑处理，接下来需要把具体的逻辑关联起来，RouterFunction可以帮助我们实现这一个目标。RouterFunction将传入的请求路由传入到具体的函数，它接收ServerRequest 并返回一个

Mono<ServerResponse>

。

如果请求与特定路由匹配则返回处理函数的结果，否则返回一个空的Mono对象。RouterFunction与@ReuestMapping类似。代码如下：

 

public class personRouter{
@Bean
public RouterFunction<ServerResponse> routerPerson(PersonHandler personHandler){
return RouterFunctions.route(RequestPredicates.GET("/person")
.add(RequestPredicates.accept(MediaType.APPLICATION_JSON)),
personHandler::getPersons)
}
}

 

本章节完

系列章节目录

实战SpringCloud响应式微服务系列教程（第一章）

实战SpringCloud响应式微服务系列教程（第二章）

实战SpringCloud响应式微服务系列教程（第三章）

实战SpringCloud响应式微服务系列教程（第四章）

实战SpringCloud响应式微服务系列教程（第五章）

实战SpringCloud响应式微服务系列教程（第六章）

实战SpringCloud响应式微服务系列教程（第七章）

实战SpringCloud响应式微服务系列教程（第八章）