4.13 使用RestTemplate调用REST服务

优质

小牛编辑

130浏览

2023-12-01

如果需要从应用程序调用远程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()

4.13.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。