Spring WebClient 作为 RestTemplate 的替代品

Posted 2023-02-27

【中文标题】Spring WebClient 作为 RestTemplate 的替代品

【英文标题】：Spring WebClient as an alternative to RestTemplate

【发布时间】：2019-04-04 15:28:57

【问题描述】：

RestTemplate 的当前 javadoc 状态：

注意：从 5.0 开始，非阻塞、反应式 org.springframework.web.reactive.client.WebClient 提供了 RestTemplate 的现代替代方案，有效支持同步和异步以及流式场景。 RestTemplate 将在未来的版本中被弃用，并且未来不会添加主要的新功能。

我们正在使用 spring boot 2.0.6 和 spring 5.0.10 编写一个新项目。

看到restTemplate 将被弃用，我们决定使用新的WebClient，它也应该支持同步调用。但我找不到任何关于如何实现这一目标的文档。

我在下面的代码中使用了块：

ResponseEntity<String> response = webClient.get()
            .uri(url)
            .exchange()
            .flatMap(r -> r.toEntity(String.class))
            .block();

但是，当从弹簧控制器调用时，这会引发以下异常

java.lang.IllegalStateException: block()/blockFirst()/blockLast() are blocking, which is not supported in thread

那么究竟应该如何以同步方式使用WebClient呢？

编辑：我的 pom.xml 看起来像这样：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-webflux</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>

【参考方案1】：

如果您的应用程序仅使用spring-boot-starter-webflux，则意味着服务器和客户端都将使用 Spring WebFlux。在这种情况下，禁止在 Controller 处理程序中调用 block 运算符，因为它会阻塞少数服务器线程之一，并会产生重要的运行时问题。

如果这背后的主要驱动是使用WebClient，那么您可以同时依赖spring-boot-starter-web 和spring-boot-starter-webflux。您的 Spring Boot 应用程序仍将在服务器端使用 Spring MVC，并且您将能够使用 WebClient 作为客户端。 在这种情况下，您可以调用block 运算符，甚至可以使用Flux 或Mono 作为控制器中的返回类型as Spring MVC supports that。你甚至可以gradually introduce WebClient in an existing Spring MVC application。

【讨论】：

所以丢失的spring-boot-starter-web 是罪魁祸首。现在工作。谢谢！

我们是否添加了spring-boot-starter-web 以使用同步WebClient？看来我可以使用同步 WebClient 而不添加它。

哦.. 我们仍然需要spring-boot-starter-we 来使用同步WebClient。似乎spring-cloud-starter-netflix-eureka-server 包括spring-boot-starter-web 所以.. 我误解了。