八卦阵 发表于 2024-8-16 07:30:38

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 提供了更强盛和灵活的功能,并且更得当与响应式编程模型一起使用
一、引包

<parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>3.0.0</version>
    </parent>

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

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

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

          <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
      </dependency>
</dependencies>
二、通用方法

package com.zc.util;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.client.WebClient;

import java.util.List;

/**
* @author zc
* @date 2024/4/15 16:52
* @desc
*/
@Component
public class WebClientUtil {

    private final WebClient webClient;

    @Autowired
    public WebClientUtil(WebClient.Builder webClientBuilder) {
         this.webClient = webClientBuilder.
                baseUrl("http://127.0.0.1:30003").
                build();
    }

    /**
   * get方法
   * @param url
   * @param responseType
   * @return
   * @param
   */
    public <T> T get(String url, Class<T> responseType) {
      return webClient.get().
                uri(url).
                accept(MediaType.APPLICATION_JSON).
                retrieve().
                bodyToMono(responseType).
                block();
    }

    /**
   * get多条数据
   * @param url
   * @param responseType
   * @return
   * @param <T>
   */
    public <T> List<T> list(String url, Class<T> responseType){
      return webClient.get().
                uri(url).
                accept(MediaType.APPLICATION_JSON).
                retrieve().
                bodyToFlux(responseType).collectList().block();
    }

    /**
   * post方法
   * @param url
   * @param requestBody
   * @param responseType
   * @return
   * @param
   */
    public <T> T post(String url, Object requestBody, Class<T> responseType) {
      return webClient.post().
                uri(url).
                contentType(MediaType.APPLICATION_JSON).
                bodyValue(requestBody).
                accept(MediaType.APPLICATION_JSON).
                retrieve().
                bodyToMono(responseType).
                block();
    }

    /**
   * put方法
   * @param url
   * @param requestBody
   * @param responseType
   * @return
   * @param
   */
    public <T> T put(String url, Object requestBody, Class<T> responseType){
      return webClient.put().
                uri(url).
                contentType(MediaType.APPLICATION_JSON).
                bodyValue(requestBody).
                accept(MediaType.APPLICATION_JSON).
                retrieve().
                bodyToMono(responseType).
                block();
    }

    /**
   * 删除方法
   * @param url
   * @param responseType
   * @return
   * @param
   */
    public <T> T delete(String url, Class<T> responseType){
      return webClient.delete().
                uri(url).
                accept(MediaType.APPLICATION_JSON).
                retrieve().
                bodyToMono(responseType).
                block();
    }
}
三、测试

客户端:
import com.alibaba.fastjson.JSON;
import com.zc.Application;
import com.zc.bean.HostDiffBean;
import com.zc.util.WebClientUtil;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Date;
import java.util.List;

/**
* @author zc
* @date 2024/2/23 10:40
* @desc
*/
@SpringBootTest(classes = Application.class)
public class TestFF {

    @Autowired
    private WebClientUtil webClientUtil;

    @Test
    public void test(){
      List<HostDiffBean> list= webClientUtil.list("compare/hostInfo?pageSize=10&pageNum=1", HostDiffBean.class);
      System.out.println(JSON.toJSON(list));

      HostDiffBean hostDiffBean = new HostDiffBean();
      hostDiffBean.setIp("127.0.0.1");
      hostDiffBean.setHIp("127.0.0.2");
      hostDiffBean.setCreateTime(new Date());
      hostDiffBean.setSerialNumber("123");
      hostDiffBean.setHDeviceNo("no123");
      hostDiffBean.setDeviceNo("NO456");
      String result = webClientUtil.post("compare/hostInfo/add", hostDiffBean, String.class);
      System.out.println(result);
    }
}
服务端:
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.neusoft.bean.*;
import com.neusoft.service.HostDataCompareService;
import io.swagger.annotations.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import java.util.List;

/**
* @author zc
* @date 2024/3/14 15:00
* @desc
*/
@RestController
@RequestMapping("/compare")
@Api(value = "数据对比接口", tags = "数据对比接口")
public class DataCompareController {

    @Autowired
    private HostDataCompareService hostDataCompareService;

    @GetMapping("/hostInfo")
    @ApiOperation(value = "宿主机数量差异查询", notes = "宿主机数量差异查询")
    public List<HostInfoBean> getHostInfoBeans(@RequestParam(name = "pageSize") @Validated @ApiParam(value = "每页数", required = true) Integer pageSize,
                                             @RequestParam(name = "pageNum") @Validated @ApiParam(value = "页数", required = true) Integer pageNum) {
      Page<HostInfoBean> list = hostDataCompareService.getHostInfoBeans(pageSize, pageNum);
      return list.getRecords();
    }

    @PostMapping("/hostInfo/add")
    @ApiOperation(value = "宿主机数量差异查询", notes = "宿主机数量差异查询")
    public String addHostInfoBeans(@RequestBody HostDiffBean hostDiffBean){
      return "success";
    }
} 结果:
https://i-blog.csdnimg.cn/blog_migrate/038c306c228ed12fef8c27b15bbdb023.png

四、参考

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

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。
页: [1]
查看完整版本: SpringBoot3 实现webclient 通用方法