34、使用 RestTemplate
调用 REST 服务
如果您的应用程序需要调用远程 REST 服务,这可以使用 Spring Framework 的 RestTemplate
类。由于 RestTemplate
实例在使用之前通常需要进行自定义,因此 Spring Boot 不提供任何自动配置的 RestTemplate
bean。但是,它会自动配置 RestTemplateBuilder
,可在需要时创建 RestTemplate
实例。自动配置的 RestTemplateBuilder
确保将合适的 HttpMessageConverters
应用于 RestTemplate
实例。
以下代码展示了一个典型示例:
@Service
public class MyService {
private final RestTemplate restTemplate;
public MyService(RestTemplateBuilder restTemplateBuilder) {
this.restTemplate = restTemplateBuilder.build();
}
public Details someRestCall(String name) {
return this.restTemplate.getForObject("/{name}/details", Details.class, name);
}
}
提示
RestTemplateBuilder
包含许多可用于快速配置 ·RestTemplate· 的方法。例如,要添加 BASIC auth 支持,可以使用builder.basicAuthentication("user", "password").build()
。
34.1、自定义 RestTemplate
RestTemplate
自定义有三种主要方法,具体取决于您希望自定义的程度。
要想自定义的范围尽可能地窄,请注入自动配置的 RestTemplateBuilder
,然后根据需要调用其方法。每个方法调用都返回一个新的 RestTemplateBuilder
实例,因此自定义只会影响当前构建器。
要在应用程序范围内添加自定义配置,请使用 RestTemplateCustomizer
bean。所有这些 bean 都会自动注册到自动配置的 RestTemplateBuilder
,并应用于使用它构建的所有模板。
以下示例展示了一个 customizer,它为除 192.168.0.5
之外的所有主机配置代理:
static class ProxyCustomizer implements RestTemplateCustomizer {
@Override
public void customize(RestTemplate restTemplate) {
HttpHost proxy = new HttpHost("proxy.example.com");
HttpClient httpClient = HttpClientBuilder.create()
.setRoutePlanner(new DefaultProxyRoutePlanner(proxy) {
@Override
public HttpHost determineProxy(HttpHost target,
HttpRequest request, HttpContext context)
throws HttpException {
if (target.getHostName().equals("192.168.0.5")) {
return null;
}
return super.determineProxy(target, request, context);
}
}).build();
restTemplate.setRequestFactory(
new HttpComponentsClientHttpRequestFactory(httpClient));
}
}
最后,最极端(也很少使用)的选择是创建自己的 RestTemplateBuilder
bean。这样做会关闭 RestTemplateBuilder
的自动配置,并阻止使用任何 RestTemplateCustomizer
bean。