SpringWebFlux介绍
1、是Spring5添加新的模块,用于web开发的,功能与SpringMVC类似的,webflux使用当前一种比较流程响应时编程出现的框架。
2、使用传统web框架,比如SpringMVC,这些基于Servlet容器,Webflux是一种异步非阻塞的框架,异步非阻塞的框架在Servlet3.1以后才支持,核心是基于Reactor的相关API进行实现的
3、异步非阻塞
- 异步和同步:针对调用者,调用者发送请求,如果等着对方回应之后才做其他事情就是同步,如果发送请求之后不用等着对方回应就去做其他事情就是异步
- 非阻塞和阻塞:针对被调用者,被调用者收到请求后,做完操作才给出反馈就是阻塞,收到操作立即给出反馈就是非阻塞
4、特点 - 1、异步非阻塞
在有限资源下,提高系统吞吐量和伸缩性,以Reactor为基础实现响应式编程 - 2、函数式编程
Spring5 框架基于java8,Webflux可以用使用Java8函数式编程方式实现路由请求
5、与SpringMVC比较
- 1、都可以使用注解方式,都可以运行在Tomcat等容器中
- 2、SpringMVC采用命令式编程,WebFlux采用异步响应式编程
响应式编程
1、什么是响应式编程
响应式编程时一种面相数据流和变化传播的编程范式。这意味着可以在编程语言中很方便地表达静态或动态的数据流,而相关的 计算模型会自动将变化的值通过数据流进行传播。
例如:使用Excel表格求某一列表格的值时,某一单元格内的数值的变化,都会导致和产生变化。
2、Java8及其之前版本
- 提供的观察者模式两个类Observer和Observable,其实是伪响应
public class ObserverJdk8 extends Observable {
public static void main(String[] args) {
ObserverJdk8 observer = new ObserverJdk8();
// Observer 是一个函数式接口,可以直接使用lambda表达式
observer.addObserver((o, arg)->{
System.out.println("发生了变化");
});
// 设置数据已发生变化
observer.setChanged();
// 通知所有观察者
observer.notifyObservers();
}
}
3、JDK9及之后的版本
- 提供了一个Flow类,类中有两个内部类Publisher和Subscriber,Publisher是发布类,Subscriber是订阅类
public class ObserverJdk11 {
public static void main(String[] args) {
Flow.Publisher<String> publisher = subscriber -> {
subscriber.onNext("1");
subscriber.onNext("2");
subscriber.onError(new RuntimeException("异常"));
};
publisher.subscribe(new Flow.Subscriber<String>() {
@Override
public void onSubscribe(Flow.Subscription subscription) {
subscription.cancel();
}
@Override
public void onNext(String item) {
System.out.println(item);
}
@Override
public void onError(Throwable throwable) {
throw new RuntimeException(throwable);
}
@Override
public void onComplete() {
System.out.println("已完成");
}
});
}
}
Reactor实现响应式编程
1、响应式编程操作中,Reactor是满足Reactive规范框架
2、Reactor有两个核心类,Mono和Flux,这两个类实现了Publisher,提供丰富操作符。Flux对象实现发布者,返回N个元素;Mono实现发布者,返回0或者1个元素
3、Flux和Mono都是数据流的发布者,使用Flux和Mono都可以发出三种数据信号:元素值,错误信号,完成信号,错误信号和完成信号都代表终止信号,完成信号用于告诉订阅者数据流结束了,错误信号终止数据流同时吧错误信息传递给订阅者
4、Flux和Mono代码演示
- 1、引入依赖
<dependency>
<groupId>io.projectreactor</groupId>
<artifactId>reactor-core</artifactId>
<version>3.1.5.RELEASE</version>
</dependency>
2、代码
public class TestReactor {
public static void main(String[] args) {
// just方法直接声明
Flux.just(1,2,3,4);
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);
}
}
5、三种信号特点
- 错误信号和完成信号都是终止信号,不能共存
- 如果没有发送任何元素值,而是直接发送错误或者完成信号,表示是空数据流
- 如果没有错误信号,没有完成信号,表示是无限数据流
6、调用just或者其他方法只是声明数据流,数据流并没有发出,只有订阅之后才会发送数据流,不订阅什么都不会发生
7、操作符 - 对数据流进行一道道操作,称为操作符,比如工厂流水线
map:将元素映射为新元素
flatmap:将元素映射为流
SpringWebflux执行流程和核心API
SpringWebflux基于Reactor,默认使用容器时Netty,Netty是高性能的NIO框架,异步非阻塞的框架
(1)Netty
- BIO
- NIO
(2)SpringWebflux执行过程和SpringMVC相似的 - SpringWebflux 核心控制器DispatcherHandler,实现接口WebHandler
- WebHandler中的handle方法
public interface WebHandler {
Mono<Void> handle(ServerWebExchange var1);
}
在DispatcherHandler中的具体实现
// exchange-> 用于存放Http请求响应信息
public Mono<Void> handle(ServerWebExchange exchange) {
return this.handlerMappings == null ? this.createNotFoundError() : Flux.fromIterable(this.handlerMappings).concatMap((mapping) -> {
// 根据请求地址获取对应mapping
return mapping.getHandler(exchange);
}).next().switchIfEmpty(this.createNotFoundError()).flatMap((handler) -> {
// 调用具体的业务方法
return this.invokeHandler(exchange, handler);
}).flatMap((result) -> {
// 处理结果返回
return this.handleResult(exchange, result);
});
}
(3)SpringWebflux里面DispatcherHandler三个属性,负责请求的处理
@Nullable
private List<HandlerMapping> handlerMappings;
@Nullable
private List<HandlerAdapter> handlerAdapters;
@Nullable
private List<HandlerResultHandler> resultHandlers;
- HandlerMapping:请求查询到处理的方法
- HandlerAdapter:真正负责请求处理
- HandlerResultHandler:响应结果处理
(4)SpringWebflux实现函数式编程,两个接口:RouterFunction(路由处理)和HandlerFunction(处理函数)
基于注解编程模型
使用注解编程模型方式,和之前SpringMVC使用相似的,只需要把相关依赖配置到项目中,SpringBoot自动配置相关运行容器,默认情况下使用Netty容器
- 1、创建SpringBoot项目,引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
- 2、创建packge层级
3、代码实现
public class User {
private String name;
private String gender;
private Integer age;
public User() {
}
public User(String name, String gender, Integer age) {
this.name = name;
this.gender = gender;
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getGender() {
return gender;
}
public void setGender(String gender) {
this.gender = gender;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "User{" +
"name='" + name + '\'' +
", gender='" + gender + '\'' +
", age=" + age +
'}';
}
}
public interface UserService {
Mono<User> queryById(int id);
Flux<User> getAllUser();
Mono<Void> addUser(Mono<User> userMono);
}
@Service
public class UserServiceImpl implements UserService {
@Autowired
private UserDao userDao;
@Override
public Mono<User> queryById(int id) {
return userDao.queryById(id);
}
@Override
public Flux<User> getAllUser() {
return userDao.getAllUser();
}
@Override
public Mono<Void> addUser(Mono<User> userMono) {
return userDao.addUser(userMono);
}
}
@Repository
public class UserDao {
private final Map<Integer, User> map = new HashMap<>();
public UserDao() {
map.put(1, new User("zhangsan", "男", 20));
map.put(2, new User("lisi", "男", 25));
map.put(3, new User("wangwu", "女", 23));
}
public Mono<User> queryById(int id) {
return Mono.just(map.get(id));
}
public Flux<User> getAllUser() {
return Flux.fromIterable(map.values());
}
public Mono<Void> addUser(Mono<User> userMono) {
return userMono.doOnNext(e->{
map.put(map.size() + 1, e);
}).thenEmpty(Mono.empty());
}
}
@RestController
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/queryById/{id}")
public Mono<User> queryById(@PathVariable int id) {
return userService.queryById(id);
}
@GetMapping("/getAllUser")
public Flux<User> getAllUser() {
return userService.getAllUser();
}
@PostMapping("/addUser")
public Mono<Void> addUser(@RequestBody User user) {
return userService.addUser(Mono.just(user));
}
}
- 4、接口测试,与SpringMVC测试方式一样
- 说明:
SpringMVC方式实现,同步阻塞的方式,基于SpringMVC+Servlet+Tomcat
SpringWebflux方式实现,异步非阻塞方式,基于SpringWebflux+Reactor+Netty
基于函数式编程模型
- 1 在使用函数式编程模型操作的时候,需要自己初始化服务器
- 2 基于函数式编程模型的时候,有两个核心接口:RouterFunction(实现路由,将请求转发给对应的Handler)和HandlerFunction(处理请求生成响应的函数)。核心任务定义这两个函数式接口的实现,并且启动需要的服务器
- 3 SpringWebflux请求和响应不再是ServletRequest和ServletResponse,而是ServerRequest和ServerResponse
创建Hadnler处理器
public class UserHandler {
private UserService userService;
public UserHandler(UserService userService) {
this.userService = userService;
}
public Mono<ServerResponse> queryById(ServerRequest request) {
// 获取path中的参数
int id = Integer.parseInt(request.pathVariable("id"));
Mono<User> mono = this.userService.queryById(id);
// flatMap 将一类元素转换为另一类元素
return mono.flatMap(user -> {
// 构造响应体
return ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(fromObject(user));
// 如果user为空,则返回 404
}).switchIfEmpty(ServerResponse.notFound().build());
// 可以替换为以下逻辑
// return ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(mono, User.class);
}
public Mono<ServerResponse> getAllUser(ServerRequest request) {
Flux<User> allUser = this.userService.getAllUser();
return ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(allUser, User.class);
}
public Mono<ServerResponse> addUser(ServerRequest request) {
Mono<User> userMono = request.bodyToMono(User.class);
return ServerResponse.ok().build(this.userService.addUser(userMono));
}
}
创建服务器
public class Server {
public static void main(String[] args) throws IOException {
Server server = new Server();
// 调用createReactorServer创建Reactor服务器
server.createReactorServer();
System.out.println("enter to exit");
// 卡住主线程,防止直接结束
System.in.read();
}
// 1、创建Router路由
public RouterFunction<ServerResponse> routingFunction() {
UserService userService = new UserServiceImpl();
UserHandler handler = new UserHandler(userService);
// 设置路由
// 将/user/{id}映射为handler中的queryById方法
return RouterFunctions.route(GET("/user/{id}")
.and(accept(MediaType.APPLICATION_JSON)), handler::queryById)
.andRoute(GET("/users")
// 将/users映射为handler中的getAllUser方法
.and(accept(MediaType.APPLICATION_JSON)),handler::getAllUser);
}
// 2、创建服务器完成适配
public void createReactorServer() {
// 路由和handler适配
RouterFunction<ServerResponse> route = routingFunction();
// 将路由至于httpHandler中
HttpHandler httpHandler = toHttpHandler(route);
// 创建reactor处理器器
ReactorHttpHandlerAdapter adapter = new ReactorHttpHandlerAdapter(httpHandler);
// 创建服务器
HttpServer httpServer = HttpServer.create();
// 利用适配器创建httpServer服务器
httpServer.handle(adapter).bindNow();
}
}
启动之后进行测试
调用/user/{id}和/users接口
SpringWebflux接口调用方式
public class WebClientMain {
public static void main(String[] args) {
WebClient webClient = WebClient.create("http://127.0.0.1:51603");
User user = webClient.get().uri("/user/{id}", 1).accept(MediaType.APPLICATION_JSON)
.retrieve().bodyToMono(User.class).block();
System.out.println(user.toString());
}
}
总结
1、webflux应用场景
Spring WebFlux 是一个异步非阻塞式的 Web 框架,所以,它特别适合应用在 IO 密集型的服务中,比如微服务网关这样的应用中。
2、优势和性能
WebFlux 内部使用的是响应式编程(Reactive Programming),以 Reactor 库为基础, 基于异步和事件驱动,可以让我们在不扩充硬件资源的前提下,提升系统的吞吐量和伸缩性。
注:WebFlux 并不能使接口的响应时间缩短,它仅仅能够提升吞吐量和伸缩性。