webflux 的使用总结

本文为博主原创，未经允许不得转载：

　　1. Servlet 3.0 简介

　　2. WebFlux 简介 及 特点

　　 3. 基于函数式的 WebFlux 开发

　　4. webFlux 全局异常

　　5. webFlux 过滤器的使用

 　　响应式编程（reactive programming）是一种基于数据流（data stream）和变化传递（propagation of change）的声明式（declarative）的  编程范式

1. Servlet 3.0 简介

　　1.1  Servlet 特点

　　Filter/Servlet 在生成响应之前 可能要等待一些资源的响应以完成请求处理，比如一个jdbc的查询，或者远程服务rpc调用。在Servlet中阻塞等待是一个低效的操作，这将导致受限系统资源的急剧紧张，比如线程，连接数。Servlet 3.0 引入了异步处理请求的能力，使得线程可以不用阻塞等待，提早返回到容器，从而执行更多的任务请求。把耗时的任务提交给另一个异步线程去执行，以及产生响应。

　　1.2  Servlet 异步原理

　　startAsync 方法其实就是创建了一个异步上下文 AsyncContext 对象，AsyncContext 对象的作用是保存请求的中间信息，比如 Request 和 Response 对象等上下文信息,Tomcat 的工作线程在request.startAsync调用之后，就直接结束回到线程池中了，线程本身不会保存任何信息。也就是说一个请求到服务端，执行到一半，你的 Web 应用正在处理，这个时候 Tomcat 的工作线程没了，这就需要有个缓存能够保存原始的 Request 和 Response 对象，而这个缓存就是 AsyncContext。 startAsync 还需要告诉 Tomcat 当前的 Servlet 处理方法返回时，不要把响应发到浏览器，因为这个时候，响应还没生成呢；并且不能把 Request 对象和 Response 对象销毁，因为后面 Web 应用还要用呢。

2. WebFlux 简介 及 特点

　　传统的Web框架，springmvc 等都是基于Servlet API并在Servlet容器基础之上运行的，在Servlet3.1之后才有了异步非阻塞的支持。而WebFlux是一个典型异步非阻塞的框架，它的核心是基于Reactor的相关API实现的。相对于传统的web框架来说，它可以运行在诸如Netty，Undertow及支持Servlet3.1的容器上，因此它的运行环境的可选择行要比传统web框架多的多。

　　根据官方的说法，webflux主要在如下两方面体现出独有的优势：

　　1）非阻塞式

　　　　其实在servlet3.1提供了非阻塞的API，WebFlux提供了一种比其更完美的解决方案。使用非阻塞的方式可以利用较小的线程或硬件资源来处理并发进而提高其可伸缩性

　　2) 函数式编程端点

　　　　老生常谈的编程方式了，Spring5必须让你使用java8，那么函数式编程就是java8重要的特点之一，而WebFlux支持函数式编程来定义路由端点处理请求。

 3. 基于函数式的 WebFlux 开发

　　添加 maven 依赖：

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

　　HandlerFunction: 相当于Controller中的具体处理方法，输入为请求，输出封装在Mono中的响应

@FunctionalInterface
public interface HandlerFunction<T extends ServerResponse> {

    Mono<T> handle(ServerRequest request);
}

　　

　　RouterFunction: 相当于RequestMapping,将Url映射到具体的HandlerFunction,输入为请求，输出为封装在Mono中的HandlerFunction

　　

  @FunctionalInterface
       public interface RouterFunction<T extends ServerResponse> {
    Mono<HandlerFunction<T>> route(ServerRequest request);}

响应式编程中的Flux和Mono 使用可以看这篇文章： https://blog.csdn.net/qq_28089993/article/details/89461814

4. webFlux 全局异常

　　重写实现 WebExceptionHandler ：

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.Order;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.core.io.buffer.DataBufferFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebExceptionHandler;
import reactor.core.publisher.Mono;

@Component
@Order(-2)
public class MyWebExceptionHandler implements WebExceptionHandler {

    @Autowired
    private ObjectMapper objectMapper;

    @Override
    public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
        ResultWrapper resultWrapper = ResultWrapper.builder().message("unknown").build();
        if (ex instanceof RuntimeException){
            resultWrapper.setMessage(ex.getMessage());
        }
        byte[] bytes =null;
        try {
             bytes= objectMapper.writeValueAsBytes(resultWrapper);

        } catch (JsonProcessingException e) {
            e.printStackTrace();
            bytes="".getBytes();
        }

        DataBufferFactory dataBufferFactory = exchange.getResponse().bufferFactory();
        DataBuffer wrap = dataBufferFactory.wrap(bytes);
        return exchange.getResponse().writeWith(Mono.just(wrap));
    }
}

5. webFlux 过滤器的使用：

　　WebFlux中过滤器的使用方法和SpringMVC中相似，都是实现接口中的filter方法。

　　SpringMVC中使用WebFliter接口，而在WebFlux中使用的是HandlerFilterFunction接口

　　@Order注解，表示过滤器会按添加的顺序进行顺序调用

@Order
@Component
public class AuthFilter implements HandlerFilterFunction {

    @Override
    public Mono filter(ServerRequest request, HandlerFunction next) {
        if (request.queryParam("token").isPresent()) {
            return next.handle(request);
        } else {
            return ServerResponse.status(HttpStatus.BAD_REQUEST).build());
        }
    }
}

6. 业务应用

　　　　由于 已有业务代码开发及上手使用的熟练程度，使用webFlux 都需要一定的过度及学习时间。为了使用 webFlux 以及提高系统性能，

　　在网关模块中使用 webflux ，提高系统的并发以及处理的速度。

　　　　需要注意的是 webflux 启动依赖的 是 netty。 不兼容 tomcat，所以在 微服务中如果依赖 webflux ，则需要排除 tomcat 相关的依赖。