通过 Interceptor 或 HttpEntity 将 http 标头添加到 RestTemplate？

Question

如果我有一些静态标头应该应用于 任何 使用RestTemplate 发送的请求：应该如何添加这些标头？

在本例中，我总是希望发送 http 标头 accept=applicaton/json。 （它也可以是任何其他标题，也可以是多个标题）。

1) HttpEntity 直接在发送前：

HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON_VALUE);

ResponseEntity<Rsp> http = restTemplate.postForEntity(host, new HttpEntity<>(req, headers), type);

2)ClientHttpRequestInterceptor:

class MyInterceptor implements ClientHttpRequestInterceptor {
    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        request.getHeaders().set(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON_VALUE);
        return execution.execute(request, body);
    }
}

@Bean
public RestTemplateCustomizer customizer() {
    return restTemplate -> restTemplate.getInterceptors().add(new MyInterceptor());
}

然后发帖：

restTemplate.postForEntity(host, req, type);

哪一个比另一个有优势，因此应该被首选？

Answer 1

选项 1 似乎有点难以维护，因为开发人员需要记住每次都这样做。选项2会更好，我只会做以下更改：

你在哪里

restTemplate.getInterceptors().add(new MyInterceptor())

我愿意

List<ClientHttpRequestInterceptor> interceptors = restTemplate.getInterceptors();
if (CollectionUtils.isEmpty(interceptors)) {
    interceptors = new ArrayList<>();
}
interceptors.add(new MyInterceptor());
restTemplate.setInterceptors(interceptors);

这样你就可以初始化列表以防它为空。

另外，要小心，因为有人可以为 bean 设置一个新的拦截器列表而丢失你的。

Answer 2

Java 8 Lambda 使用拦截器的方式

new RestTemplateBuilder().interceptors(
   (HttpRequest request, byte[] body, ClientHttpRequestExecution execution) -> {
      request.getHeaders().set(AUTHORIZATION, token);
      return execution.execute(request, body);
   }
).build()

Answer 3

1)HttpEntity直接在发送前：对restTemplate的细粒度控制。它可以工作，但您必须在任何地方重复代码，开发人员可能会忘记它（DRY）

2) ClientHttpRequestInterceptor 和 RestTemplateCustomizer：从 restTemplateBuilder bean 创建的每个 restTemplate 都会有这个拦截器，适用于一般行为。