Spring RestTemplate經(jīng)常被用作客戶端向Restful API發(fā)送各種請(qǐng)求,也許你也碰到過(guò)這種需求隙袁,很多請(qǐng)求都需要用到相似或者相同的Http Header。如果在每次請(qǐng)求之前都把Header填入HttpEntity/RequestEntity,這樣的代碼會(huì)顯得十分冗余状原。
Spring提供了ClientHttpRequestInterceptor接口聋呢,可以對(duì)請(qǐng)求進(jìn)行攔截,并在其被發(fā)送至服務(wù)端之前修改請(qǐng)求或是增強(qiáng)相應(yīng)的信息颠区。下面是一個(gè)簡(jiǎn)單的例子:
實(shí)現(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());
// 保證請(qǐng)求繼續(xù)被執(zhí)行
return execution.execute(request, body);
}
}
將自定義攔截器添加到RestTemplate實(shí)例
@Configuration
public class ClientConfig {
// 注入攔截器削锰。攔截器也可以不聲明為Bean, 直接在這里新建實(shí)例
@Autowired
ActionTrackInterceptor actionTrackInterceptor;
// 聲明為Bean,方便應(yīng)用內(nèi)使用同一實(shí)例
@Bean
public RestTemplate restTemplate() {
RestTemplate restTemplate = new RestTemplate();
// 把自定義的ClientHttpRequestInterceptor添加到RestTemplate毕莱,可添加多個(gè)
restTemplate.setInterceptors(Collections.singletonList(actionTrackInterceptor));
return restTemplate;
}
}
前期的工作已經(jīng)完成了器贩,現(xiàn)在使用這個(gè)RestTemplate實(shí)例發(fā)送請(qǐng)求,就會(huì)在Header中帶上“actionId”這個(gè)字段了央串,當(dāng)然你可以配置更多的諸如Accept, Content-Type等通用的字段磨澡。
// 客戶端代碼
restTemplate.getForObject(SERVER_URL, Example.class);
// 服務(wù)端代碼
// 如果服務(wù)端也是用Spring RestController/MVC 實(shí)現(xiàn),利用@RequestHeader注解质和,即可獲取之前添加的actionId字段了
@RequestMapping(value = "/example")
public Example example(@RequestHeader("actionId") String actionId) {
//業(yè)務(wù)邏輯
}
歡迎各路高手留言討論稳摄!