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);
}
}
Tip
RestTemplateBuilder
包含许多可用于快速配置RestTemplate
的有用方法。例如,要添加 BASIC 身份验证支持,可以使用builder.basicAuthentication("user", "password").build()
。
34.1 RestTemplate 自定义
RestTemplate
自定义有三种 Main 方法,具体取决于您希望自定义应用的范围。
要使所有自定义项的范围尽可能缩小,请注入自动配置的RestTemplateBuilder
,然后根据需要调用其方法。每个方法调用都返回一个新的RestTemplateBuilder
实例,因此自定义仅影响构建器的使用。
要进行应用程序范围的附加自定义,请使用RestTemplateCustomizer
bean。所有此类 bean 都会自动注册到自动配置的RestTemplateBuilder
中,并应用于使用它构建的任何模板。
以下示例显示了一个定制程序,该定制程序为除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。