Spring Boot 参考指南(使用RestTemplate调用REST服务)
33. 使用RestTemplate
调用REST服务
如果需要从应用程序调用远程REST服务,你可以使用Spring框架的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.basicAuthorization("user", "password").build()
。33.1 RestTemplate定制
RestTemplate
定制有三种主要方法,取决于你希望定制应用到的范围有多广。
要使任何定制的范围尽可能狭窄,请注入自动配置的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。