Spring WebFlux入门

Spring WebFlux

一、SpringWebflux 介绍

Webflux 是 Spring5 中新添加的模块，用于 web 开发，功能和 SpringMVC 类似，Webflux 是一种响应式编程框架。

传统 web 框架，比如 SpringMVC，这些基于 Servlet 容器，Webflux 是一种异步非阻塞的框架，异步非阻塞的框架在 Servlet3.1 以后才支持，核心是基于 Reactor 的相关 API 实现的。

Webflux 特点：

1. 非阻塞式：在有限资源下，提高系统吞吐量和伸缩性，以 Reactor 为基础实现响应式编程
2. 函数式编程：Spring5 框架基于 java8，Webflux 使用 Java8 函数式编程方式实现路由请求

对比 SpringMVC

1. 两个框架都可以使用注解方式，都运行在 Tomcat 等容器中
2. SpringMVC 采用命令式编程，Webflux 采用异步响应式编程

二、响应式编程

响应式编程是一种面向数据流和变化传播的编程范式。这意味着可以在编程语言中很方便地表达静态或动态的数据流，而相关的计算模型会自动将变化的值通过数据流进行传播。

1. 响应式编程操作中，Reactor 是满足 Reactive 规范框架
2. Reactor 有两个核心类，Mono 和 Flux，这两个类实现接口 Publisher，提供丰富操作符。Flux 对象实现发布者，返回 N 个元素；Mono 实现发布者，返回 0 或者 1 个元素
3. Flux 和 Mono 都是数据流的发布者，使用 Flux 和 Mono 都可以发出三种数据信号： 元素值，错误信号，完成信号。错误信号和完成信号都代表终止信号，终止信号用于告诉订阅者数据流结束了，错误信号终止数据流同时把错误信息传递给订阅者

Mono

Flux

4. 代码演示 Flux 和 Mono

   引入依赖

   <dependency>
    <groupId>io.projectreactor</groupId>
    <artifactId>reactor-core</artifactId>
    <version>3.1.5.RELEASE</version>
   </dependency>
   

   示例代码

           //just 方法直接声明
           Flux.just(1,2,3,4).subscribe(System.out::println);
           Mono.just(1);
   
           //其他的方法
           Integer[] array = {1,2,3,4};
           Flux.fromArray(array);
           List<Integer> list = Arrays.asList(array);
           Flux.fromIterable(list);
           Stream<Integer> stream = list.stream();
           Flux.fromStream(stream);
   

   调用 just 或者其他方法只是声明数据流，数据流并没有发出，只有进行订阅之后才会触发数据流，不订阅什么都不会发生的。

5. 三种信号特点

   1. 错误信号和完成信号都是终止信号，不能共存
   2. 如果没有发送任何元素值，而是直接发送错误或者完成信号，表示是空数据流
   3. 如果没有错误信号，没有完成信号，表示是无限数据流

6. 操作符

   对数据流进行一道道操作，成为操作符，比如工厂流水线

   • map 元素映射为新元素

     

   • flatMap 元素映射为流

   把每个元素转换成流，把转换之后的多个流合并成大的流

   

三、SpringWebflux 执行流程和核心 API

SpringWebflux 基于 Reactor，默认使用容器是 Netty，Netty 是高性能的 NIO 框架，异步非阻塞的框架

BIO模型

NIO模型

SpringWebflux 执行过程和 SpringMVC 相似的：

SpringWebflux 核心控制器 DispatcherHandler，实现接口 WebHandler，接口 WebHandler 有一个handle方法处理web请求

handle方法在DispatcherHandler中的实现

• HandlerMapping：定义请求和处理对象的映射关系
• HandlerAdapter：请求处理
• HandlerResultHandler：响应结果处理

四、SpringWebflux（基于注解编程模型）

添加依赖

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

创建实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;
    private Integer age;
}

创建接口定义操作方法

public interface PersonService {
    //根据 id 查询用户
    Mono<Person> getPersonById(int id);
    //查询所有用户
    Flux<Person> getAllPerson();
    //添加用户
    Mono<Void> savePersonInfo(Mono<Person> Person);
}

接口实现

@Service
public class PersonServiceImpl implements PersonService {

    //创建 map 集合存储数据
    private final static Map<Integer,Person> users = new HashMap<>();
    static {
        users.put(1,new Person("lucy",20));
        users.put(2,new Person("mary",30));
        users.put(3,new Person("jack",50));
    }

    @Override
    public Mono<Person> getPersonById(int id) {
        return Mono.justOrEmpty(users.get(id));
    }

    @Override
    public Flux<Person> getAllPerson() {
        return Flux.fromIterable(users.values());
    }

    @Override
    public Mono<Void> savePersonInfo(Mono<Person> personMono) {
        return personMono.doOnNext(person -> {
            int id = users.size()+ 1;
            users.put(id, person);
        }).thenEmpty(Mono.empty());
    }
}

创建controller

@RestController
public class PersonController {

    @Autowired
    private PersonService personService;

    //id 查询
    @GetMapping("/person/{id}")
    public Mono<Person> getPersonId(@PathVariable int id) {
        return personService.getPersonById(id);
    }

    //查询所有
    @GetMapping("/person")
    public Flux<Person> getPersons() {
        return personService.getAllPerson();
    }
    
    //添加
    @PostMapping("/savePerson")
    public Mono<Void> savePerson(@RequestBody Person Person) {
        Mono<Person> PersonMono = Mono.just(Person);
        return personService.savePersonInfo(PersonMono);
    }

}

五、SpringWebflux（基于函数式编程模型）

基于函数式编程模型时候，有两个核心接口：

RouterFunction（实现路由功能，请求转发给对应的 handler）

HandlerFunction（处理请求生成响应）

创建handle

@Component
public class PersonHandle {

    @Autowired
    private PersonService personService;

    public Mono<ServerResponse> getPersonId(ServerRequest request) {
        //获取 id 值
        int userId = Integer.valueOf(request.pathVariable("id"));
        //空值处理
        Mono<ServerResponse> notFound = ServerResponse.notFound().build();
        //调用 service 方法得到数据
        Mono<Person> userMono = personService.getPersonById(userId);
        //把 userMono 进行转换返回
        //使用 Reactor 操作符 flatMap
        return userMono.flatMap(person -> ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(fromObject(person))
                .switchIfEmpty(notFound));
    }

    public Mono<ServerResponse> getAllPerson(ServerRequest request) {
        Flux<Person> allPerson = personService.getAllPerson();
        return ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(allPerson, Person.class);
    }

    public Mono<ServerResponse> savePerson(ServerRequest request) {
        Mono<Person> personMono = request.bodyToMono(Person.class);
        return ServerResponse.ok().build(personService.savePersonInfo(personMono));
    }
}

创建router

@Configuration
public class RouterConfig {

    @Autowired
    private PersonHandle personHandle;

    @Bean
    public RouterFunction<ServerResponse> testRouter() {
        return RouterFunctions.route(RequestPredicates.GET("fun/person/{id}"), personHandle::getPersonId)
                .andRoute(RequestPredicates.GET("fun/person"), personHandle::getAllPerson)
                .andRoute(RequestPredicates.POST("fun/savePerson"), personHandle::savePerson);
    }

}