Spring RestTemplate 利用攔截器配置 HTTP請求 Header的方法

本篇內(nèi)容主要講解“Spring RestTemplate 利用攔截器配置 HTTP請求 Header的方法”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學(xué)習(xí)“Spring RestTemplate 利用攔截器配置 HTTP請求 Header的方法”吧!

Spring RestTemplate經(jīng)常被用作客戶端向Restful API發(fā)送各種請求，也許你也碰到過這種需求，很多請求都需要用到相似或者相同的Http Header。如果在每次請求之前都把Header填入HttpEntity/RequestEntity，這樣的代碼會顯得十分冗余。

Spring提供了ClientHttpRequestInterceptor接口，可以對請求進(jìn)行攔截，并在其被發(fā)送至服務(wù)端之前修改請求或是增強相應(yīng)的信息。下面是一個簡單的例子：

實現(xiàn)ClientHttpRequestInterceptor接口

// 不是必要的
@Component
public class ActionTrackInterceptor implements ClientHttpRequestInterceptor {
  @Autowired
  ActionIdGenerator actionIdGenerator;

  @Override
  public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
      throws IOException {
    HttpHeaders headers = request.getHeaders();

    // 加入自定義字段
    headers.add("actionId", actionIdGenerator.generate());

    // 保證請求繼續(xù)被執(zhí)行
    return execution.execute(request, body);
  }
}

將自定義攔截器添加到RestTemplate實例

@Configuration
public class ClientConfig {

  // 注入攔截器。攔截器也可以不聲明為Bean, 直接在這里新建實例
  @Autowired
  ActionTrackInterceptor actionTrackInterceptor;

  // 聲明為Bean，方便應(yīng)用內(nèi)使用同一實例
  @Bean
  public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplate();

    // 把自定義的ClientHttpRequestInterceptor添加到RestTemplate，可添加多個
    restTemplate.setInterceptors(Collections.singletonList(actionTrackInterceptor));
    return restTemplate;
  }
}

前期的工作已經(jīng)完成了，現(xiàn)在使用這個RestTemplate實例發(fā)送請求，就會在Header中帶上“actionId”這個字段了，當(dāng)然你可以配置更多的諸如Accept, Content-Type等通用的字段。

// 客戶端代碼
restTemplate.getForObject(SERVER_URL, Example.class);

// 服務(wù)端代碼
// 如果服務(wù)端也是用Spring RestController/MVC 實現(xiàn)，利用@RequestHeader注解，即可獲取之前添加的actionId字段了
@RequestMapping(value = "/example")
public Example example(@RequestHeader("actionId") String actionId) {
    //業(yè)務(wù)邏輯
}

到此，相信大家對“Spring RestTemplate 利用攔截器配置 HTTP請求 Header的方法”有了更深的了解，不妨來實際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！