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

程序员文章站 2023-10-28 23:13:16

本文为实战SpringCloud响应式微服务系列教程第九章，讲解使用Spring WebFlux构建响应式RESTful服务。建议没有之前基础的童鞋，先看之前的章节，章节目录放在文末。从本节开始我们将正式进入构建响应式服务的世界。在Spring boot的基础上，我们将引入全新的Spring We ......

本文为实战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进行代码依赖管理。

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

打开所下载项目中的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的响应内容。

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

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

从以上代码可以看到使用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)
}
}

本章节完