springBoot设置url头

转载

云中谁寄锦书来 2024-11-27 17:51:20

文章标签 springBoot设置url头 webclient设置header spring 返回结果 github 文章分类 架构后端开发

springBoot设置url头_webclient设置header

【SpringBoot WEB 系列】WebClient 之 retrieve 与 exchange 的使用区别介绍

前面介绍了几篇 WebCilent 的使用姿势博文，其中大部分的演示 case，都是使用retrieve来获取返回 ResponseBody，我国我们希望获取更多的返回信息，比如获取返回头，这个时候 exchange 则是更好的选择；

本文将主要介绍一下，在 WebClient 中 retrieve 和 exchange 的各自使用场景

I. 项目环境

本项目借助SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA进行开发

1. 依赖

使用 WebClient，最主要的引入依赖如下(省略掉了 SpringBoot 的相关依赖，如对于如何创建 SpringBoot 项目不太清楚的小伙伴，可以关注一下我之前的博文)

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-webfluxartifactId>
dependency>

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-webfluxartifactId>
dependency>

2. REST 接口

添加一个简单的 Rest 接口，用于后续的测试

@GetMapping(path = "get")
public Mono get(String name, Integer age) {
    return Mono.just("req: " + name + " age: " + age);
}

@GetMapping(path = "get")
public Mono get(String name, Integer age) {
    return Mono.just("req: " + name + " age: " + age);
}

II. 实例演示

通过前面的几篇学习，我们知道 WebClient 发起请求的一般使用姿势如下

Mono res = webCient.get().uri(xxx).exchange()
WebClient.ResponseSpec responseSpec = webClient.get().uri(xxx).retrieve()
Mono res = webCient.get().uri(xxx).exchange()
WebClient.ResponseSpec responseSpec = webClient.get().uri(xxx).retrieve()

这两个方法都是用来获取返回结果的，最大的区别在于通过 exchange 接收完整的 ResponseEntity；而 retrieve 接收的则是 ResponseBody

1. exchange 使用实例

The exchange() method provides more control than the retrieve method, provides access to the ClientResponse

下面给出一个简单的，获取返回的状态码，cookies 等请求头信息的 case

WebClient webClient = WebClient.create("http://127.0.0.1:8080");

  // 返回结果
  Mono res = webClient.get().uri("/get?name={1}&age={2}", "一灰灰", 18).exchange();
  res.subscribe(s -> {
      HttpStatus statusCode = s.statusCode();
      ClientResponse.Headers headers = s.headers();
      MultiValueMap ans = s.cookies();
      s.bodyToMono(String.class).subscribe(body -> {
          System.out.println("response detail: \nheader: " + headers.asHttpHeaders() + "\ncode: " + statusCode + "\ncookies: " + ans +"\nbody:" + body);
      });
  });
WebClient webClient = WebClient.create("http://127.0.0.1:8080");

  // 返回结果
  Mono res = webClient.get().uri("/get?name={1}&age={2}", "一灰灰", 18).exchange();
  res.subscribe(s -> {
      HttpStatus statusCode = s.statusCode();
      ClientResponse.Headers headers = s.headers();
      MultiValueMap ans = s.cookies();
      s.bodyToMono(String.class).subscribe(body -> {
          System.out.println("response detail: \nheader: " + headers.asHttpHeaders() + "\ncode: " + statusCode + "\ncookies: " + ans +"\nbody:" + body);
      });
  });

上面这段代码中，主要的核心点就是ClientResponse的解析，可以直接通过它获取返回头，响应状态码，其次提供了一些对 ResponseBody 的封装调用

返回结果

response detail:
header: [Content-Type:"text/plain;charset=UTF-8", Content-Length:"22"]
code: 200 OK
cookies: {}
body:req: 一灰灰 age: 18

response detail:
header: [Content-Type:"text/plain;charset=UTF-8", Content-Length:"22"]
code: 200 OK
cookies: {}
body:req: 一灰灰 age: 18

如果我们只关注 ResponseBody，用 exchange 也是可以直接写的，如下，相比 retrieve 稍微饶了一道

Mono result = client.get()
        .uri("/get?name={1}&age={2}", "一灰灰", 18).accept(MediaType.APPLICATION_JSON)
        .exchange()
        .flatMap(response -> response.bodyToMono(String.class));
Mono result = client.get()
        .uri("/get?name={1}&age={2}", "一灰灰", 18).accept(MediaType.APPLICATION_JSON)
        .exchange()
        .flatMap(response -> response.bodyToMono(String.class));

另外一个更加推荐的写法是直接返回Mono>，更友好的操作姿势，返回结果如下

response detail2:
code: 200 OK
headers: [Content-Type:"text/plain;charset=UTF-8", Content-Length:"22"]
body: req: 一灰灰 age: 18

response detail2:
code: 200 OK
headers: [Content-Type:"text/plain;charset=UTF-8", Content-Length:"22"]
body: req: 一灰灰 age: 18

2. retrieve 使用实例

The retrieve() method is the easiest way to get a response body and decode it.

前面已经多次演示 retrieve 的使用姿势，基本上是在后面带上bodyToMono或bodyToFlux来实现返回实体的类型转换

WebClient webClient = WebClient.create("http://127.0.0.1:8080");

Mono ans = webClient.get().uri("/get?name={1}", "一灰灰").retrieve().bodyToMono(String.class);
ans.subscribe(s -> System.out.println("basic get with one argument res: " + s));
WebClient webClient = WebClient.create("http://127.0.0.1:8080");

Mono ans = webClient.get().uri("/get?name={1}", "一灰灰").retrieve().bodyToMono(String.class);
ans.subscribe(s -> System.out.println("basic get with one argument res: " + s));