33. 调用 REST 服务

如果您需要从应用程序中调用远程 REST 服务,则可以使用 Spring Framework 的RestTemplate类。由于RestTemplate实例在使用前通常需要自定义,因此 Spring Boot 不提供任何单个自动配置的RestTemplate bean。但是,它会自动配置RestTemplateBuilder,可以在需要时用于创建RestTemplate实例。自动配置的RestTemplateBuilder将确保将明智的HttpMessageConverters应用于RestTemplate实例。

这是一个典型的例子:

@Service
public class MyBean {

    private final RestTemplate restTemplate;

    public MyBean(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.basicAuthorization("user", "password").build()

33.1 RestTemplate 定制

RestTemplate自定义有三种 Main 方法,具体取决于您希望自定义应用的范围。

要使所有自定义项的范围尽可能缩小,请注入自动配置的RestTemplateBuilder,然后根据需要调用其方法。每个方法调用都返回一个新的RestTemplateBuilder实例,因此自定义设置只会影响对构建器的使用。

要在整个应用程序范围内使用附加的自定义RestTemplateCustomizer bean。所有此类 Bean 都会自动注册到自动配置的RestTemplateBuilder中,并将应用于使用该 Bean 构建的任何模板。

这是一个定制器的示例,该定制器为除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。