Spring WebFlux使用指南

Spring WebFlux是spring5的一部分，它为web应用程序提供反应式编程支持。

在本教程中，我们将使用RestController和WebClient创建一个小型响应式REST应用程序。

我们还将研究如何使用Spring安全保护我们的反应端点。

Spring-WebFlux框架

Spring WebFlux在内部使用Project Reactor及其发布者实现Flux和Mono。

新框架支持两种编程模型：

• 基于注释的反应元件
• 功能路由和处理

依赖项

让我们从spring boot starter webflux依赖项开始，它包含所有其他必需的依赖项：

• spring boot和spring boot starter，用于基本的spring boot应用程序设置
• spring-webflux框架
• reactor-core我们需要的反应流，也需要reactor-netty

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
    <version>2.2.6.RELEASE</version>
</dependency>

响应式应用

我们现在将使用Spring WebFlux构建一个非常简单的REST EmployeeManagement应用程序：

• 我们将使用一个简单的域模型-带有id和name字段的Employee
• 我们将使用RestController构建restapi，以将员工资源作为单个资源和集合发布
• 我们将使用WebClient构建一个客户端来检索相同的资源
• 我们将使用WebFlux和Spring Security创建一个安全的被动端点

响应式RestController

springwebflux支持基于注释的配置，方式与springwebmvc框架相同。

首先，在服务器上，我们创建一个带注释的控制器，它发布员工资源的反应流。

让我们创建带注释的EmployeeController：

@RestController
@RequestMapping("/employees")
public class EmployeeController {

    private final EmployeeRepository employeeRepository;
    
    // constructor...
}

EmployeeRepository可以是任何支持非阻塞反应流的数据存储库。

单一资源

让我们在控制器中创建一个端点，用于发布单个员工资源：

@GetMapping("/{id}")
private Mono<Employee> getEmployeeById(@PathVariable String id) {
    return employeeRepository.findEmployeeById(id);
}

我们在Mono中包装一个Employee资源，因为我们最多返回一个Employee。

集合资源

我们还要添加一个端点来发布所有雇员的集合资源：

@GetMapping
private Flux<Employee> getAllEmployees() {
    return employeeRepository.findAllEmployees();
}

对于集合资源，我们使用类型为Employee的流量，因为它是0..n元素的发布者。

反应式Web客户端

Spring5中引入的WebClient是一个支持反应流的非阻塞客户端。

我们可以使用WebClient创建一个客户端，从EmployeeController提供的端点检索数据。

让我们创建一个简单的EmployeeWebClient：

public class EmployeeWebClient {

    WebClient client = WebClient.create("http://localhost:8080");

    // ...
}

在这里，我们使用工厂方法create创建了一个WebClient。它会指向localhost:8080，所以我们可以使用或相对的URL来调用这个客户端实例。

检索单个资源

要从endpoint/employee/{id}检索Mono类型的单个资源，请执行以下操作：

Mono<Employee> employeeMono = client.get()
  .uri("/employees/{id}", "1")
  .retrieve()
  .bodyToMono(Employee.class);

employeeMono.subscribe(System.out::println);

检索集合资源

类似地，要从endpoint/employees检索Flux类型的集合资源，请执行以下操作：

Flux<Employee> employeeFlux = client.get()
  .uri("/employees")
  .retrieve()
  .bodyToFlux(Employee.class);
        
employeeFlux.subscribe(System.out::println);

Spring WebFlux安全性

我们可以使用Spring Security来保护我们的反应端点。

假设我们在EmployeeController中有一个新的端点。此端点更新员工详细信息并发回更新的员工。

由于这允许用户更改现有员工，因此我们希望仅将此端点限制为管理员角色用户。

让我们为EmployeeController添加一个新方法：

@PostMapping("/update")
private Mono<Employee> updateEmployee(@RequestBody Employee employee) {
    return employeeRepository.updateEmployee(employee);
}

现在，为了限制对该方法的访问，让我们创建SecurityConfig并定义一些基于路径的规则以仅允许管理员用户：

@EnableWebFluxSecurity
public class EmployeeWebSecurityConfig {

    // ...

    @Bean
    public SecurityWebFilterChain springSecurityFilterChain(
      ServerHttpSecurity http) {
        http.csrf().disable()
          .authorizeExchange()
          .pathMatchers(HttpMethod.POST, "/employees/update").hasRole("ADMIN")
          .pathMatchers("/**").permitAll()
          .and()
          .httpBasic();
        return http.build();
    }
}

此配置将限制对/employees/update的访问。因此，只有具有ADMIN角色的用户才能访问此端点并更新现有员工。

最后，注解@EnableWebFluxSecurity添加了一些默认配置的Spring-Security-WebFlux支持。

结论

在本文中，我们探讨了如何创建和使用springwebflux框架支持的反应式web组件。例如，我们构建了一个小型的REST应用程序。

除了Reactive RestController和WebClient之外，WebFlux框架还支持Reactive WebSocket和对应的WebSocketClient，以进行套接字样式的Reactive流。

最后，在Github上提供了本文中使用的完整源代码：https://github.com/eugenp/tutorials/tree/master/spring-5-reactive-security