响应式编程实战(08)-WebFlux，使用注解编程模式构建异步非阻塞服务

古城微笑少年丶 2024-03-17 17:49 37阅读 0赞

### 1 引言 ###

明确了 Spring 家族中 WebFlux 组件诞生的背景和意义。作为一款新型的 Web 服务开发组件：

*  充分考虑了与原有 Spring MVC 在开发模式上的兼容性，开发人员仍然可以使用基于注解的编程方式来创建响应式 Web 服务
 *  WebFlux 也引入了基于函数式编程的全新开发模式

先关注基于注解的编程模型。

### 2 引入 Spring WebFlux ###

如果你是第一次创建 WebFlux 应用，最简单使用 Spring 所提供的 Spring Initializer 初始化模板。直接访问 Spring Initializer 网站（[http://start.spring.io/][http_start.spring.io]），选择创建一个 Maven 项目并指定相应的配置项，然后在添加的依赖中选择 Spring Reactive Web，我们就可以获取一个可运行的 WebFlux 模版项目。

[![Drawing 0.png][]][Drawing 0.png 1]

使用 Spring Initializer 初始化响应式 Web 应用示意图。

#### 模板项目中的 pom 文件 ####

<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>

*  最核心的就是 spring-boot-starter-webflux，构成响应式 Web 应用程序开发的基础
 *  spring-boot-starter-test 是包含 JUnit、Spring Boot Test、Mockit 等常见测试工具类在内的测试组件库
 *  reactor-test 则是用来测试 Reactor 框架的测试组件库

当然，你也可以新建一个任意的 Maven 项目，然后添加这些依赖。这样，使用 Spring WebFlux 构建响应式 Web 服务的初始化环境就准备好了。

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

*  基于 Java 注解的方式，这种编程模型与传统的 Spring MVC 一致
 *  使用函数式编程模型

先介绍第一种实现方式。

#### 3.1 RESTful 服务与传统创建方法 ####

在创建响应式 Web 服务之前，我们先来回顾一下传统 RESTful 服务的创建方法。

REST（Representational State Transfer，表述性状态转移）本质只是一种架构风格而非规范。这种架构风格把位于服务器端的访问入口看作是一种资源，每个资源都使用一个 URI 来表示唯一的访问地址。而在请求过程上使用的就是标准的 HTTP 方法，如GET、PUT、POST 和 DELETE。

使用 Spring Boot 来构建一个传统的 RESTful 服务，创建一个 Bootstrap 启动类。Bootstrap 类结构简单且比较固化：

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
     
    @SpringBootApplication
    public class HelloApplication {
        
     
        public static void main(String[] args) {
        
            SpringApplication.run(HelloApplication.class, args);
        }
    }

@SpringBootApplication 注解的类就是整个应用程序的入口类，通过这个类相当于启动了 Spring 容器。一旦 Spring 容器已经启动，我们就可以通过提供一系列的 Controller 类来构建 HTTP 端点，最简单的 Controller 类如下所示。

@RestController
    public class HelloController {
        
     
        @GetMapping("/")
        public String hello() {
        
            return "Hello World!";
        }
    }

@RestController 注解继承自 Spring MVC 中的 @Controller 注解。与传统的 @Controller 注解相比，@RestController 注解内置基于 JSON 的序列化/反序列化方式，专门用于构建轻量级的 RESTful 端点。通过这个特性，我们在构建 RESTful 服务时可以使用 @RestController 注解来代替 @Controller 注解以简化开发。

@GetMapping 注解也与 Spring MVC 中的 @RequestMapping 注解类似。Spring Boot 2 中引入一批新注解，@PutMapping、@PostMapping、@DeleteMapping 等注解，方便开发人员显式指定 HTTP 的请求方法。当然，你也可以继续使用原先的 @RequestMapping 实现同样的效果。

##### 典型的 Controller #####

实现了一个根据订单编号 OrderNumber 获取订单信息的 HTTP 端点。这个端点的访问 URI 为“orders/\{orderNumber\}”，由根路径“orders”+子路径“/\{orderNumber\}”构成，还指定了对应的 HTTP 请求方法和所需传入的参数：

@RestController
    @RequestMapping(value="orders")
    public class OrderController {
        
      
        @Autowired
        private OrderService orderService;       
        
        @GetMapping(value = "/{orderNumber}")
        public Order getOrderByOrderNumber(@PathVariable String orderNumber) {
           
            Order order = orderService.getOrderByOrderNumber(orderNumber);
            
            return order；
        }
    }

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

#### 3.2 通过注解构建响应式 RESTful 服务 ####

针对前面介绍的两个 RESTful 服务示例，展示如何就响应式编程模型给出它们的响应式版本。

第一个响应式 RESTful 服务来自对原有 HelloController 示例响应式改造，

改造后：

@RestController
    public class HelloController {
        
     
        @GetMapping("/")
        public Mono<String> hello() {
        
            return Mono.just("Hello World!");
        }
    }

hello() 方法的返回值从普通的 String 对象转化为一个 Mono 对象。

Spring WebFlux 与 Spring MVC 的不同之处在于，前者使用的类型都是 Reactor 中提供的 Flux 和 Mono 对象，而非 POJO。

第一个响应式 RESTful 服务非常简单，在接下来的内容中，我们将更进一步，构建带有一个 Service 层实现的响应式 RESTful 服务。而 Service 层中一般都会使用具体的数据访问层来实现数据操作，但因为响应式数据访问是一个独立的话题，所以我会在后续的“14 | 响应式全栈：响应式编程能为数据访问过程带来什么样的变化？”中进行展开。

这一讲我们还是尽量屏蔽响应式数据访问所带来的复杂性，数据层采用打桩（Stub）的方式来实现这个 Service 层组件。我们将针对常见的订单服务构建一个桩服务 StubOrderService，如下所示。

@Service
    public class StubOrderService {
        
     
        private final Map<String, Order> orders = new ConcurrentHashMap<>();
     
        public Flux<Order> getOrders() {
        
            return Flux.fromIterable(this.orders.values());
        }
     
        public Flux<Order> getOrdersByIds(final Flux<String> ids) {
        
            return ids.flatMap(id -> Mono.justOrEmpty(this.orders.get(id)));
        }
     
        public Mono<Order> getOrdersById(final String id) {
        
            return Mono.justOrEmpty(this.orders.get(id));
        }
     
        public Mono<Void> createOrUpdateOrder(final Mono<Order> productMono) {
        
            return productMono.doOnNext(product -> {
        
                orders.put(product.getId(), product);
            }).thenEmpty(Mono.empty());
        }
     
        public Mono<Order> deleteOrder(final String id) {
        
            return Mono.justOrEmpty(this.orders.remove(id));
        }
    }

StubOrderService 用来对 Order 数据进行基本 CRUD 操作。我们使用一个位于内存中的 ConcurrentHashMap 对象来保存所有的 Order 对象信息，从而提供一种桩代码实现方案。

这里的 getOrdersByIds() 方法具有代表性，它接收 Flux 类型的参数 ids。Flux 类型的参数代表有多个对象需要处理，这里使用“07 | Reactor 操作符（上）：如何快速转换响应式流？”中所介绍的 flatMap 操作符来对传入的每个 id 进行处理，这也是 flatMap 操作符的一种非常典型的用法。

另外 createOrUpdateOrder() 方法使用 Mono.doOnNext() 方法，将 Mono 对象转换为普通 POJO 对象并进行保存。doOnNext() 方法相当于在响应式流每次发送 onNext 通知时，为消息添加了定制化的处理。

有了桩服务 StubOrderService，我们就可以创建 StubOrderController 来构建具体的响应式 RESTful 服务，它使用 StubOrderService 来完成具体的端点。

StubOrderController 暴露端点都很简单，只是把具体功能代理给 StubOrderService 对应方法：

@RestController
    @RequestMapping("/orders")
    public class StubOrderController {
        
     
        @Autowired
        private StubOrderService orderService;
     
        @GetMapping("")
        public Flux<Order> getOrders() {
        
            return this.orderService.getOrders();
        }
     
        @GetMapping("/{id}")
        public Mono<Order> getOrderById(@PathVariable("id") final String id) {
        
            return this.orderService.getOrderById(id);
        }
     
        @PostMapping("")
        public Mono<Void> createOrder(@RequestBody final Mono<Order> order) {
        
            return this.orderService.createOrUpdateOrder(order);
        }
     
        @DeleteMapping("/{id}")
        public Mono<Order> delete(@PathVariable("id") final String id) {
        
            return this.orderService.deleteOrder(id);
        }
    }

WebFlux 中支持使用与 Spring MVC 相同的注解，主要区别在底层通信方式是否阻塞：

*  简单场景，这两者之间并没有什么太大差别
 *  复杂应用，响应式编程和背压的优势就会体现出来，可以带来整体性能的提升

### 4 案例集成：ReactiveSpringCSS 中的 Web 服务 ###

作为客服系统，核心业务流程是生成客服工单，而工单的生成通常需要使用到用户账户信息和所关联的订单信息。

案例包含三个独立的 Web 服务：

*  管理订单的 order-service
 *  管理用户账户的 account-service
 *  核心的客服服务 customer-service

服务之间的交互方式：

![ca3802d609064751a752c637d39bfed9.png][]

ReactiveSpringCSS 案例系统中三个服务的交互方式图

通过这个交互图，已能梳理工单生成的核心流程的伪代码：

generateCustomerTicket {
        
     
      创建 CustomerTicket 对象
     
    	从远程 account-service 中获取 Account 对象
     
    	从远程 order-service 中获取 Order 对象
     
    	设置 CustomerTicket 对象属性
     
    	保存 CustomerTicket 对象并返回
    }

*  【从远程 account-service 中获取 Account 对象】
 *  【从远程 order-service 中获取 Order 对象】

都涉及远程 Web 服务的访问。

先要分别在 account-service 和 order-service 服务中创建对应的 HTTP 端点。

先基于注解编程模型给出 account-service 中 AccountController 的实现过程，完整的 AccountController：

@RestController
    @RequestMapping(value = "accounts")
    public class AccountController {
        
     
        @Autowired
        private AccountService accountService;
     
        @GetMapping(value = "/{accountId}")
        public Mono<Account> getAccountById(@PathVariable("accountId") String accountId) {
        
     
            Mono<Account> account = accountService.getAccountById(accountId);
            return account;
        }
     
        @GetMapping(value = "accountname/{accountName}")
        public Mono<Account> getAccountByAccountName(@PathVariable("accountName") String accountName) {
        
     
            Mono<Account> account = accountService.getAccountByAccountName(accountName);
            return account;
        }
     
        @PostMapping(value = "/")
        public Mono<Void> addAccount(@RequestBody Mono<Account> account) {
        
            
            return accountService.addAccount(account);
        }
     
        @PutMapping(value = "/")
        public Mono<Void> updateAccount(@RequestBody Mono<Account> account) {
        
            
            return accountService.updateAccount(account);
        }
    }

这里的几个 HTTP 端点都比较简单，基本都是基于 AccountService 完成的 CRUD 操作。需要注意的是，在 addAccount 和 updateAccount 这两个方法中，输入的参数都是一个 Mono 对象，而不是 Account 对象，这意味着 AccountController 将以响应式流的方式处理来自客户端的请求。

### 总结 ###

从今天开始，我们将引入 Spring WebFlux 来构建响应式的 RESTful Web 服务。作为一款全新的开发框架，WebFlux 具有广泛的应用场景，同时也支持两种不同的开发模型。本讲针对注解编程模型给出了 RESTful 服务的开发方法。

### FAQ ###

使用 Spring WebFlux 和 Spring MVC 开发 RESTful 服务有什么联系和区别？

使用 Spring WebFlux 和 Spring MVC 开发 RESTful 服务都是基于 Spring 框架的，它们有以下联系和区别：

联系：

1.  都可以用于开发 RESTful 服务，支持 HTTP 协议的 GET、POST、PUT、DELETE 等请求方式。
2.  都可以使用 Spring 提供的注解来简化开发，如 @RequestMapping、@GetMapping、@PostMapping 等。
3.  都可以使用 Spring 提供的拦截器来处理请求前、请求后的逻辑。

区别：

1.  编程模型不同：Spring WebFlux 基于响应式编程模型，使用 Reactor 库来处理异步和非阻塞的 I/O 操作，而 Spring MVC 则是基于传统的 Servlet API，使用阻塞式 I/O 操作。
2.  线程模型不同：Spring WebFlux 使用少量的线程来处理大量的并发请求，通过 Reactor 库提供的事件循环机制来实现非阻塞式 I/O 操作。而 Spring MVC 则是使用线程池来处理请求，并且每个请求都会占用一个线程。
3.  响应式支持不同：Spring WebFlux 支持响应式编程，可以使用 Mono 和 Flux 类型来处理异步操作和流式数据。而 Spring MVC 则不支持响应式编程。
4.  异常处理不同：Spring WebFlux 中的异常处理机制不同于 Spring MVC，它使用函数式编程模型来处理异常。在 WebFlux 中，异常处理器是一个函数，它接收一个 ServerRequest 对象和一个 Throwable 对象，并返回一个 Mono 对象。而在 Spring MVC 中，异常处理器是一个类，需要实现 HandlerExceptionResolver 接口。
5.  性能和并发性不同：由于 Spring WebFlux 使用少量的线程来处理大量的并发请求，因此它可以更好地保护系统免受拒绝服务攻击。而 Spring MVC 则需要使用线程池来处理请求，容易受到拒绝服务攻击的影响。

总之，选择使用 Spring WebFlux 还是 Spring MVC 取决于具体的应用场景和需求。如果需要处理大量的并发请求，并希望使用响应式编程模型来实现高性能和高并发，可以选择 Spring WebFlux；如果应用场景相对简单，可以选择 Spring MVC。

下一文会继续讨论 Spring WebFlux 的应用，我们将分析全新的函数式编程模型中的编程组件，并完成与 ReactiveSpringCSS 的集成。

[http_start.spring.io]: http://start.spring.io/?fileGuid=xxQTRXtVcqtHK6j8
[Drawing 0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/4baa86d85abb419eba6c643d4767dce6.png
[Drawing 0.png 1]: https://camo.githubusercontent.com/92ee5933923df26b9828fae13aa26cdfae215ca22dc3dcd6745929ac02dd8e25/68747470733a2f2f73302e6c677374617469632e636f6d2f692f696d616765362f4d30312f33312f31412f43696f504f57427347774341586371564141426f726e454b4268413038342e706e67
[ca3802d609064751a752c637d39bfed9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/9f12083cd5cd4985be79c7110c0c8b73.png