Spring RestTemplate 利用拦截器配置 HTTP

Spring RestTemplate经常被用作客户端向Restful API发送各种请求，也许你也碰到过这种需求，很多请求都需要用到相似或者相同的Http Header。如果在每次请求之前都把Header填入HttpEntity/RequestEntity，这样的代码会显得十分冗余。

Spring提供了ClientHttpRequestInterceptor接口，可以对请求进行拦截，并在其被发送至服务端之前修改请求或是增强相应的信息。下面是一个简单的例子：

实现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());

    // 保证请求继续被执行
    return execution.execute(request, body);
  }
}

将自定义拦截器添加到RestTemplate实例

@Configuration
public class ClientConfig {

  // 注入拦截器。拦截器也可以不声明为Bean, 直接在这里新建实例
  @Autowired
  ActionTrackInterceptor actionTrackInterceptor;

  // 声明为Bean，方便应用内使用同一实例
  @Bean
  public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplate();

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

前期的工作已经完成了，现在使用这个RestTemplate实例发送请求，就会在Header中带上“actionId”这个字段了，当然你可以配置更多的诸如Accept, Content-Type等通用的字段。

// 客户端代码
restTemplate.getForObject(SERVER_URL, Example.class);

// 服务端代码
// 如果服务端也是用Spring RestController/MVC 实现，利用@RequestHeader注解，即可获取之前添加的actionId字段了
@RequestMapping(value = "/example")
public Example example(@RequestHeader("actionId") String actionId) {
    //业务逻辑
}

欢迎各路高手留言讨论！