SpringBoot3 实现webclient 通用方法

媒介：

Spring Boot WebClient 是 Spring Framework 5 中引入的一个新的响应式 Web 客户端，用于异步和响应式地与外部服务进行通信。它是基于 Project Reactor 的响应式编程模型构建的，提供了比传统的 RestTemplate 更现代和强盛的功能
先容：

• 响应式编程模型：WebClient 是基于响应式编程模型的，这意味着它可以非壅闭地执行网络哀求，并且可以或许与流式数据交互。这使得 WebClient 在处置惩罚大量并发哀求时具有更高的性能和可伸缩性。
  
• 异步操纵：WebClient 支持异步操纵，这意味着它可以在等待网络响应的同时继续执行其他任务。这有助于提高应用程序的响应本领和吞吐量。
  
• 强盛的 API：WebClient 提供了一个简洁而强盛的 API，用于构建 HTTP 哀求和接收响应。它支持多种 HTTP 方法（如 GET、POST、PUT、DELETE 等），并提供了丰富的功能来处置惩罚哀求头、哀求体、响应体等。
  
• 流式处置惩罚：WebClient 支持流式处置惩罚响应数据，这意味着它可以在接收响应数据的同时进行处置惩罚，而不必要将整个响应加载到内存中。这有助于处置惩罚大型响应数据，并淘汰内存使用。
  
• 错误处置惩罚：WebClient 提供了强盛的错误处置惩罚机制，可以方便地处置惩罚网络哀求中出现的错误和异常情况。它支持自界说错误处置惩罚器，可以根据必要界说错误处置惩罚逻辑。
  
• 集成性：WebClient 可以轻松地与 Spring Boot 的其他组件集成，如 Spring Data、Spring Security 等。这使得在构建基于微服务的响应式应用程序时更加方便和灵活。
  
• 替代 RestTemplate：虽然 RestTemplate 在以前的 Spring 版本中广泛使用，但 WebClient 被视为其现代替代品。WebClient 提供了更强盛和灵活的功能，并且更得当与响应式编程模型一起使用
  

一、引包

1. <parent>
2.         <groupId>org.springframework.boot</groupId>
3.         <artifactId>spring-boot-starter-parent</artifactId>
4.         <version>3.0.0</version>
5.     </parent>
7. <dependencies>
8.         <dependency>
9.             <groupId>org.springframework.boot</groupId>
10.             <artifactId>spring-boot-starter-web</artifactId>
11.         </dependency>
13.         <dependency>
14.             <groupId>org.springframework.boot</groupId>
15.             <artifactId>spring-boot-starter-tomcat</artifactId>
16.         </dependency>
18.         <dependency>
19.             <groupId>org.springframework.boot</groupId>
20.             <artifactId>spring-boot-starter-test</artifactId>
21.             <scope>test</scope>
22.         </dependency>
24.           <dependency>
25.             <groupId>org.springframework.boot</groupId>
26.             <artifactId>spring-boot-starter-webflux</artifactId>
27.         </dependency>
28. </dependencies>

复制代码

二、通用方法

1. package com.zc.util;
3. import org.springframework.beans.factory.annotation.Autowired;
4. import org.springframework.http.MediaType;
5. import org.springframework.stereotype.Component;
6. import org.springframework.web.reactive.function.client.WebClient;
8. import java.util.List;
10. /**
11. * @author zc
12. * @date 2024/4/15 16:52
13. * @desc
14. */
15. @Component
16. public class WebClientUtil {
18.     private final WebClient webClient;
20.     @Autowired
21.     public WebClientUtil(WebClient.Builder webClientBuilder) {
22.          this.webClient = webClientBuilder.
23.                 baseUrl("http://127.0.0.1:30003").
24.                 build();
25.     }
27.     /**
28.      * get方法
29.      * @param url
30.      * @param responseType
31.      * @return
32.      * @param
33.      */
34.     public <T> T get(String url, Class<T> responseType) {
35.         return webClient.get().
36.                 uri(url).
37.                 accept(MediaType.APPLICATION_JSON).
38.                 retrieve().
39.                 bodyToMono(responseType).
40.                 block();
41.     }
43.     /**
44.      * get多条数据
45.      * @param url
46.      * @param responseType
47.      * @return
48.      * @param <T>
49.      */
50.     public <T> List<T> list(String url, Class<T> responseType){
51.         return webClient.get().
52.                 uri(url).
53.                 accept(MediaType.APPLICATION_JSON).
54.                 retrieve().
55.                 bodyToFlux(responseType).collectList().block();
56.     }
58.     /**
59.      * post方法
60.      * @param url
61.      * @param requestBody
62.      * @param responseType
63.      * @return
64.      * @param
65.      */
66.     public <T> T post(String url, Object requestBody, Class<T> responseType) {
67.         return webClient.post().
68.                 uri(url).
69.                 contentType(MediaType.APPLICATION_JSON).
70.                 bodyValue(requestBody).
71.                 accept(MediaType.APPLICATION_JSON).
72.                 retrieve().
73.                 bodyToMono(responseType).
74.                 block();
75.     }
77.     /**
78.      * put方法
79.      * @param url
80.      * @param requestBody
81.      * @param responseType
82.      * @return
83.      * @param
84.      */
85.     public <T> T put(String url, Object requestBody, Class<T> responseType){
86.         return webClient.put().
87.                 uri(url).
88.                 contentType(MediaType.APPLICATION_JSON).
89.                 bodyValue(requestBody).
90.                 accept(MediaType.APPLICATION_JSON).
91.                 retrieve().
92.                 bodyToMono(responseType).
93.                 block();
94.     }
96.     /**
97.      * 删除方法
98.      * @param url
99.      * @param responseType
100.      * @return
101.      * @param
102.      */
103.     public <T> T delete(String url, Class<T> responseType){
104.         return webClient.delete().
105.                 uri(url).
106.                 accept(MediaType.APPLICATION_JSON).
107.                 retrieve().
108.                 bodyToMono(responseType).
109.                 block();
110.     }
111. }

复制代码

三、测试

客户端：

1. import com.alibaba.fastjson.JSON;
2. import com.zc.Application;
3. import com.zc.bean.HostDiffBean;
4. import com.zc.util.WebClientUtil;
5. import org.junit.jupiter.api.Test;
6. import org.springframework.beans.factory.annotation.Autowired;
7. import org.springframework.boot.test.context.SpringBootTest;
9. import java.util.Date;
10. import java.util.List;
12. /**
13. * @author zc
14. * @date 2024/2/23 10:40
15. * @desc
16. */
17. @SpringBootTest(classes = Application.class)
18. public class TestFF {
20.     @Autowired
21.     private WebClientUtil webClientUtil;
23.     @Test
24.     public void test(){
25.         List<HostDiffBean> list= webClientUtil.list("compare/hostInfo?pageSize=10&pageNum=1", HostDiffBean.class);
26.         System.out.println(JSON.toJSON(list));
28.         HostDiffBean hostDiffBean = new HostDiffBean();
29.         hostDiffBean.setIp("127.0.0.1");
30.         hostDiffBean.setHIp("127.0.0.2");
31.         hostDiffBean.setCreateTime(new Date());
32.         hostDiffBean.setSerialNumber("123");
33.         hostDiffBean.setHDeviceNo("no123");
34.         hostDiffBean.setDeviceNo("NO456");
35.         String result = webClientUtil.post("compare/hostInfo/add", hostDiffBean, String.class);
36.         System.out.println(result);
37.     }
38. }

复制代码

服务端：

1. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
2. import com.neusoft.bean.*;
3. import com.neusoft.service.HostDataCompareService;
4. import io.swagger.annotations.*;
5. import org.springframework.beans.factory.annotation.Autowired;
6. import org.springframework.validation.annotation.Validated;
7. import org.springframework.web.bind.annotation.*;
9. import java.util.List;
11. /**
12. * @author zc
13. * @date 2024/3/14 15:00
14. * @desc
15. */
16. @RestController
17. @RequestMapping("/compare")
18. @Api(value = "数据对比接口", tags = "数据对比接口")
19. public class DataCompareController {
21.     @Autowired
22.     private HostDataCompareService hostDataCompareService;
24.     @GetMapping("/hostInfo")
25.     @ApiOperation(value = "宿主机数量差异查询", notes = "宿主机数量差异查询")
26.     public List<HostInfoBean> getHostInfoBeans(@RequestParam(name = "pageSize") @Validated @ApiParam(value = "每页数", required = true) Integer pageSize,
27.                                                @RequestParam(name = "pageNum") @Validated @ApiParam(value = "页数", required = true) Integer pageNum) {
28.         Page<HostInfoBean> list = hostDataCompareService.getHostInfoBeans(pageSize, pageNum);
29.         return list.getRecords();
30.     }
32.     @PostMapping("/hostInfo/add")
33.     @ApiOperation(value = "宿主机数量差异查询", notes = "宿主机数量差异查询")
34.     public String addHostInfoBeans(@RequestBody HostDiffBean hostDiffBean){
35.         return "success";
36.     }
37. }

复制代码

结果：

四、参考

SpringBoot - 网络哀求客户端WebClient使用详解_springboot webclient-CSDN博客

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。