spring webflux详细介绍

原创 已于 2024-07-29 08:54:41 修改 · 568 阅读 · 9 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring #java #后端 #webflux

于 2024-07-28 21:51:50 首次发布

Spring WebFlux 是 Spring Framework 的一部分，它提供了构建响应式 Web 应用程序的能力。WebFlux 支持非阻塞 I/O，使得应用程序能够高效地处理大量并发请求。下面来详细介绍 Spring WebFlux。

1. 入门指南

1.1 安装和设置

为了开始使用 Spring WebFlux，你需要先安装 Java 和 Maven 或 Gradle。然后，你可以使用 Spring Initializr 来创建一个新的项目。以下是使用 Maven 的示例 pom.xml 文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>webflux-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>webflux-demo</name>
    <description>Demo project for Spring WebFlux</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.1.1</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
1.2 创建一个简单的 REST API

接下来，我们创建一个简单的 REST API。

import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.ServerResponse;

import static org.springframework.web.reactive.function.server.RequestPredicates.GET;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;
import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.web.reactive.function.server.ServerResponse.ok;

import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Mono;

@Component
public class GreetingRouter {

    @Bean
    public RouterFunction<ServerResponse> routes(GreetingHandler greetingHandler) {
        return route(GET("/greeting"), greetingHandler::greet);
    }
}

@Component
class GreetingHandler {

    public Mono<ServerResponse> greet(ServerRequest request) {
        return ok()
                .contentType(APPLICATION_JSON)
                .body(Mono.just(new Greeting("Hello, World!")), Greeting.class);
    }
}

record Greeting(String message) {}

2. 响应式编程基础

2.1 Mono 和 Flux
  • Mono：表示单个结果的容器，类似于 Future<T>。
  • Flux：表示零个、一个或多个结果的容器，类似于 Stream<T>。
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

public class ReactiveBasics {

    public static void main(String[] args) {
        // Mono example
        Mono.just("Hello")
            .subscribe(System.out::println);

        // Flux example
        Flux.range(1, 10)
            .map(i -> i * 2)
            .subscribe(System.out::println);
    }
}

3. 控制器与路由

3.1 使用 @RestController

使用 @RestController 和 @GetMapping 等注解来定义 RESTful 控制器。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Mono;

@RestController
public class GreetingController {

    @GetMapping("/greeting")
    public Mono<Greeting> greet() {
        return Mono.just(new Greeting("Hello, World!"));
    }
}

4. 处理表单和请求体

4.1 处理 POST 请求

使用 @PostMapping 注解来处理 POST 请求，并通过 @RequestBody 注解来读取请求体。

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Mono;

@RestController
public class ItemController {

    @PostMapping("/items")
    public Mono<Item> createItem(@RequestBody Mono<Item> itemMono) {
        return itemMono
            .map(item -> {
                // Perform some operation on the item
                return item;
            });
    }
}

record Item(String name, String description) {}

如果要使用Spring Data R2DBC和数据库交互，则Item定义如下：

import org.springframework.data.annotation.Id;
import org.springframework.data.relational.core.mapping.Table;
import reactor.core.publisher.Mono;

@Table("items")
public record Item(
    @Id
    Long id,
    String name,
    String description
) {
    public Item {
        // 如果没有提供 id，则默认为 null
        this.id = (this.id == null) ? null : this.id;
    }
}

pom.xml添加依赖：

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

application.yml添加配置：

spring: 
  r2dbc: 
    url: r2dbc:postgresql://localhost:5432/mydb
    username: myuser 
    password: mypassword 
    database: mydb

5. 异常处理

5.1 使用 @ExceptionHandler

使用 @ControllerAdvice 和 @ExceptionHandler 来处理异常。

import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import reactor.core.publisher.Mono;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = IllegalArgumentException.class)
    public Mono<ResponseEntity<String>> handleIllegalArgumentException(IllegalArgumentException ex) {
        return Mono.just(new ResponseEntity<>(ex.getMessage(), HttpStatus.BAD_REQUEST));
    }
}

6. 数据访问

6.1 使用 Spring Data R2DBC

使用 Spring Data R2DBC 来访问关系型数据库。

import org.springframework.data.repository.reactive.ReactiveCrudRepository;
import org.springframework.stereotype.Repository;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

@Repository
public interface ItemRepository extends ReactiveCrudRepository<Item, Long> {
    Flux<Item> findByName(String name);
}

// 在 ItemController 中使用 ItemRepository
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Flux;

@RestController
public class ItemController {

    private final ItemRepository itemRepository;

    @Autowired
    public ItemController(ItemRepository itemRepository) {
        this.itemRepository = itemRepository;
    }

    @GetMapping("/items")
    public Flux<Item> getItems() {
        return itemRepository.findAll();
    }
}

7. 安全性和认证

7.1 使用 Spring Security

使用 Spring Security 来保护你的 WebFlux 应用程序。

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.web.server.ServerHttpSecurity;
import org.springframework.security.web.server.SecurityWebFilterChain;

@Configuration
public class SecurityConfig {

    @Bean
    public SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
        return http
            .authorizeExchange()
                .pathMatchers("/greeting").permitAll()
                .anyExchange().authenticated()
                .and()
            .formLogin()
                .and()
            .build();
    }
}

8. 高级主题

8.1 非阻塞 I/O

使用非阻塞 I/O 来提高性能。

import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;

public class NonBlockingIOExample {

    public static void main(String[] args) {
        WebClient client = WebClient.create("https://api.example.com");

        Mono<String> response = client.get()
            .uri("/data")
            .retrieve()
            .bodyToMono(String.class);

        response.subscribe(System.out::println);
    }
}
8.2 自定义函数式路由

使用函数式编程风格来定义路由。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerResponse;

import static org.springframework.web.reactive.function.server.RequestPredicates.GET;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;

@Configuration
public class FunctionalRoutingConfig {

    @Bean
    public RouterFunction<ServerResponse> routerFunction() {
        return RouterFunctions
            .route(GET("/greeting"), req -> ServerResponse.ok().bodyValue("Hello, World!"))
            .andRoute(GET("/items"), req -> ServerResponse.ok().bodyValue("List of items"));
    }
}

9. 性能优化

9.1 缓存

使用 Spring Cache 或其他缓存机制来提高性能。

import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;
import reactor.core.publisher.Mono;

@Service
public class ItemService {

    @Cacheable(value = "items", key = "#id")
    public Mono<Item> getItem(Long id) {
        // Fetch the item from the database or other source
        return Mono.just(new Item("Name", "Description"));
    }
}
9.2 并发处理

利用并行处理来提高并发能力。

import org.springframework.stereotype.Service;
import reactor.core.publisher.Flux;
import reactor.core.scheduler.Schedulers;

@Service
public class ItemService {

    public Flux<Item> fetchItemsInParallel() {
        return Flux.range(1, 100)
            .parallel(10)
            .runOn(Schedulers.boundedElastic())
            .map(i -> new Item("Name " + i, "Description " + i))
            .sequential();
    }
}

10. 测试

10.1 单元测试

使用 JUnit 和 MockWebServer 进行单元测试。

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
import org.springframework.test.web.reactive.server.WebTestClient;
import reactor.core.publisher.Mono;

@WebFluxTest
public class GreetingControllerTest {

    @Autowired
    private WebTestClient webTestClient;

    @Test
    public void shouldReturnDefaultGreeting() {
        webTestClient.get().uri("/greeting")
            .exchange()
            .expectStatus().isOk()
            .expectBody(String.class).isEqualTo("Hello, World!");
    }
}

11. 部署

11.1 生产部署

使用 Spring Boot 打包工具将应用打包成可执行的 JAR 文件。

mvn clean package
java -jar target/webflux-demo-0.0.1-SNAPSHOT.jar

12. 进阶主题

12.1 WebSocket 支持

使用 WebSockets 实现实时通信。

import org.springframework.web.reactive.socket.WebSocketHandler;
import org.springframework.web.reactive.socket.WebSocketMessage;
import org.springframework.web.reactive.socket.WebSocketSession;
import reactor.core.publisher.Mono;

public class ChatWebSocketHandler implements WebSocketHandler {

    @Override
    public Mono<Void> handle(WebSocketSession session) {
        return session.receive()
            .map(WebSocketMessage::getPayloadAsText)
            .doOnNext(message -> System.out.println("Received message: " + message))
            .then(session.send(Mono.just(session.textMessage("Echo: " + message))))
            .then();
    }
}
12.2 客户端支持

使用 Spring WebFlux Client 来实现客户端逻辑。

import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;

public class WebClientExample {

    public static void main(String[] args) {
        WebClient client = WebClient.create("https://api.example.com");

        Mono<String> response = client.get()
            .uri("/data")
            .retrieve()
            .bodyToMono(String.class);

        response.subscribe(System.out::println);
    }
}

13. 结论

Spring WebFlux 提供了强大的工具来构建响应式的 Web 应用程序。随着你对这些特性的熟悉程度加深，你可以根据自己的需求来扩展和定制你的应用程序。

Spring WebFlux 介绍与效果演示示例
oscar999的专栏
07-21 504
响应式编程Spring WebFlux 使用响应式编程的理念，其中数据流和异步操作是核心概念。这种编程范式适用于高并发、高吞吐量的场景，允许应用程序以非阻塞的方式处理请求，并有效地利用服务器资源。它使用 Reactor 框架作为响应式编程的核心库，通过事件驱动和异步操作来处理请求和数据流。非阻塞和异步处理Spring WebFlux 支持异步和非阻塞的处理方式，这使得它能够处理高负载的情况，如即时通讯、实时数据推送等。
Spring的webFlux
胡云峰的博客
10-22 762
webFlux简介
Spring5---新特性(WebFlux)
m0_53157173的博客
08-12 1061
WebFluxSpringWebflux介绍二级目录三级目录 SpringWebflux介绍 Spring WebFlux是随Spring 5推出的响应式Web框架。 二级目录 三级目录
构建高性能Web应用：深入Spring WebFlux
最新发布
weixin_35750483的博客
07-17 906
Spring WebFlux 是 Spring Framework 5.0 引入的响应式编程的 Web 框架。与传统的 Spring MVC 相比，WebFlux 提供了非阻塞的处理方式，能够在有限的线程上处理大量并发连接，特别适合运行在现代的云原生环境和函数式编程范式下。反应式编程是一种编程范式，它关注于数据流和变化的传播。在反应式编程中，数据流和变化可以被看作是一个连续的事件流。开发者可以通过声明式地描述这些数据流的转换，来构建应用程序。在反应式编程模型中，操作通常是异步和非阻塞的。
spring webflux
08-23
最近在学习研究spring webflux，上网翻阅了几十篇博客并且下载了10几个项目，将各种案例整合了一下，写成了一个demo案例，里面有flux，mono，webclient调用，serverSendEvent案例，上传到csdn上一方面是为了分享经验，另一方面赚积分，本人整理的代码绝对物有所值。
六、Spring5之Webflux
qq_41231318的博客
07-30 922
Spring5 框架新功能（Webflux） 1、SpringWebflux 介绍 （1）是 Spring5 添加新的模块，用于 web 开发的，功能和 SpringMVC 类似的，Webflux 使用 当前一种比较流行的响应式编程出现的框架。 （2）使用传统 web 框架，比如 SpringMVC，这些基于 Servlet 容器，Webflux 是一种异步非阻 塞的框架，异步非阻塞的框架在 Servlet3.1 以后才支持，核心是基于 Reactor （响应式编程）的相关 API 实现 的。 （3）解释
spring webFlux
songchenglu123的博客
06-24 449
一个大神对flux与mvc访问数据库的效率对比报告 1、与传统的Spring MVC相比 webFlux是异步非阻塞线程模型，它能够充分利用多核 CPU 的硬件资源，springMVC使用的是同步的阻塞的线程模型，一个请求对应一个线程。 因为Spring MVC使用的是一个请求一个线程所以，对于单次请求来说Spring MVC的响应时间更短（毕竟你复用线程的过程中是有上下文切换，而且Flux也不是为了加快单次请求而出现的） 但是 因为Flux的线程模型，所以Flux在吞吐量上更有优势，也就是单位时间会处理
Spring WebFlux
xharvard的专栏
07-14 8233
Spring WebFlux
spring webflux使用的详细代码
10-26
Spring WebFlux是Spring Framework 5.0引入的一个全新模块，它是对传统Spring MVC的补充，专注于非阻塞式、反应式编程模型。这个模型特别适用于高并发、低延迟的现代Web应用程序。在这个主题中，我们将深入探讨...
Java reactive programming - Reactor 3 and Spring WebFlux
07-03
### Java响应式编程：Reactor 3 和 Spring WebFlux #### 一、响应式编程简介 响应式编程（Reactive Programming）是一种编程范式，它允许开发者通过声明式的方式处理异步数据流和事件。这种编程模式的核心在于能够...
Spring WebFlux 教程
kalle2021的博客
03-24 1089
Spring WebFlux 是 Spring Framework 5 的反应式编程框架，基于 Reactor ，以非阻塞、事件驱动模型提升资源利用率，适配高并发与实时数据处理。 本文介绍基础概念，对比 WebFlux 与 Web MVC ；阐述环境搭建与依赖配置。通过多个示例展示简单 WebFlux 应用构建，涵盖控制器、数据模型。深入分析高级特性，如反应式数据库操作、异常处理、实时数据流、与 Spring Security 集成。还以反应式博客系统为例，并给出常见问题解决方案 。
spring-webflux-5.3.15-API文档-中文版.zip
05-09
赠送jar包：spring-webflux-5.3.15.jar； 赠送原API文档：spring-webflux-5.3.15-javadoc.jar； 赠送源代码：spring-webflux-5.3.15-sources.jar； 赠送Maven依赖信息文件：spring-webflux-5.3.15.pom； 包含翻译后...
Spring框架之WebFlux
励志成为一名优秀的全能型软件开发工程师。
04-02 1419
根据前面的代码，第一个发出的事件必须是与订阅相关的事件，紧跟其后的事件必须是 foo 和bar 字符串。最后， StepVerifier#expectCompletion 定义终止信号的存在。在此例中，必须是 Subscriber#onComplete 的调用，或者成功完成给定的 Flux。要执行验证，或者说对创建流进行订阅，就必须调用 .verify() 方法。verify() 是一个阻塞调用，它阻塞执行，直到流发出所有预期的事件。
SpringWebflux 入门
qq_42315935的博客
01-15 1817
> 是Spring Framework提供的一种用户构建响应式Web应用程序的模块。它基于Reactive Streams标准，并使用了Reactor库来实现非阻塞、异步的编程模型 > > 与传统的Spring MVC相比，Spring WebFlux采用了一种基于事件驱动的架构，可以处理更高的并发请求和负载。它不再依赖于Servlet容器，而是使用自己的服务器，例如Netty或Undertow，以实现异步、高效的请求处理
Spring WebFlux介绍
耗子窝
06-12 380
关于概念，这里不多做介绍，原理之前写过，也不多说了。 关于Servlet servlet分为同步和异步两种。同步使我们常见的，当请求进来后，tomcat分给每个请求一个线程处
Spring学习(六)：WebFlux
我可能在扯淡
05-12 8842
WebFlux概述 简介 WebFlux是Spring5 新添加的模块以用于web开发，功能和SpringMVC 类似。 Webflux使用响应式编程的框架。 Webflux 是一种异步非阻塞的框架，异步非阻塞的框架在 Servlet3.1 以后才支持，核心是基于Reactor的相关 API 实现的。 异步非阻塞 异步和同步针对调用者，调用者发送请求，如果等着对方回应之后才去做其他事情就是同步，如果发送请求之后不等着对方回应就去做其他事情就是异步。 阻塞和非阻塞针对被调用者阻塞和非阻塞针对被调用者，被调
spring webflux介绍
10-10
Spring WebFlux是Spring框架的一个模块，用于构建响应式的Web应用程序。它基于Reactive Streams规范，提供了一种非阻塞、异步的编程模型，能够处理高并发的请求。相比传统的基于Servlet的Spring MVC框架，WebFlux更...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

svygh123

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值