环境：Spring5.3.23

REST Endpoints

Spring框架为调用REST端点提供了两种选择。

1. RestTemplate
   带有同步模板方法API的原始Spring REST客户端。
2. WebClient
   一个非阻塞、响应式的替代方案，同时支持同步、异步和流场景。
   请阅读《Spring WebFlux中使用WebClient远程接口调用》

从5.0开始，RestTemplate处于维护模式，只有少量的更改请求和bug可以接受。推荐使用 WebClient，它提供了更现代的API，并支持同步、异步和流场景。

RestTemplate详细介绍

RestTemplate通过HTTP客户端库提供了一个更高级别的API。它使在一行中调用REST端点变得容易。核心方法如下:

初始化RestTemplate

默认的构造函数使用java.net.HttpURLConnection来执行请求。你可以通过ClientHttpRequestFactory的实现切换到其他HTTP库。它内置支持以下内容:

• Apache HttpComponents
• Netty
• OkHttp

例如，要切换到Apache HttpComponents，你可以使用以下命令:

RestTemplate template = new RestTemplate(new HttpComponentsClientHttpRequestFactory());

每个ClientHttpRequestFactory都公开了特定于底层HTTP客户端库的配置选项——例如，用于凭据、连接池和其他细节。

注意，HTTP请求的java.net实现在访问表示错误的响应状态(如401)时可能引发异常。如果这是一个问题，请切换到另一个HTTP客户端库。

RestTemplate中URI使用

许多RestTemplate方法接受URI模板和URI模板变量，要么使用字符串变量参数，要么使用Map<String,String>。

下面的例子使用了一个字符串变量参数:

String result = restTemplate.getForObject("https://pack.com/hotels/{hotel}/bookings/{booking}", String.class, "42", "21");

下面的例子使用了一个Map<String, String>:

Map<String, String> vars = Collections.singletonMap("hotel", "42");
String result = restTemplate.getForObject("https://pack.com/hotels/{hotel}/rooms/{hotel}", String.class, vars);

请记住，URI模板是自动编码的，如下面的例子所示:

restTemplate.getForObject("https://pack.com/hotel list", String.class);
// Results in request to "https://example.com/hotel%20list"

你可以使用RestTemplate的uriTemplateHandler属性来定制uri的编码方式。或者，你可以准备一个java.net.URI，并将它传递给一个接受URI的RestTemplate方法。

RestTemplate中Header使用

你可以使用exchange()方法来指定请求头，如下面的例子所示:

String uriTemplate = "https://pack.com/hotels/{hotel}";
URI uri = UriComponentsBuilder.fromUriString(uriTemplate).build(666);
RequestEntity<Void> requestEntity = RequestEntity.get(uri)
  .header("X-API-Version", "1")
  .build();
ResponseEntity<String> response = template.exchange(requestEntity, String.class);
String responseHeader = response.getHeaders().getFirst("MyResponseHeader");
String body = response.getBody();

你可以通过许多返回ResponseEntity的RestTemplate方法变体来获取响应头。

RestTemplate中Body处理

在HttpMessageConverter的帮助下，传递给RestTemplate方法和从RestTemplate方法返回的对象与原始内容之间进行转换。

在POST请求中，输入对象被序列化为请求体，如下面的例子所示:

URI location = template.postForLocation("https://pack.com/hotels", hotel);

不需要显式设置请求的Content-Type头信息。在大多数情况下，可以根据源对象类型找到兼容的消息转换器，并且所选择的消息转换器相应地设置内容类型。如果有必要，可以使用交换方法显式地提供内容类型请求头，进而影响选择的消息转换器。

在GET中，响应体被反序列化为输出对象，如下面的例子所示:

Person person = restTemplate.getForObject("https://pack.com/people/{id}", Person.class, 66);

请求的Accept头信息不需要显式设置。在大多数情况下，可以根据预期的响应类型找到兼容的消息转换器，然后帮助填充Accept标头。如果有必要，可以使用exchange方法显式地提供Accept头信息。

默认情况下，RestTemplate会注册所有内置的消息转换器，这取决于classpath检查来帮助确定存在哪些可选的转换库。您还可以设置消息转换器以显式使用。

Http消息转换

spring-web模块包含HttpMessageConverter协议，用于通过InputStream和OutputStream读写HTTP请求和响应的主体。HttpMessageConverter实例用于客户端(例如，在RestTemplate中)和服务器端(例如，在Spring MVC REST控制器中)。

框架中提供了主要媒体(MIME)类型的具体实现，默认情况下，在客户端用RestTemplate注册，在服务器端用RequestMappingHandlerAdapter注册(参见配置消息转换器)。

HttpMessageConverter的实现将在以下描述。所有转换器都使用默认媒体类型，但可以通过设置supportedMediaTypes bean属性来覆盖它。

可以指定Jackson JSON视图，只序列化对象属性的一个子集，如下面的例子所示。

MappingJacksonValue value = new MappingJacksonValue(new User("eric", "7!jd#h23"));
value.setSerializationView(User.WithoutPasswordView.class);
RequestEntity<MappingJacksonValue> requestEntity = RequestEntity.post(new URI("https://pack.com/user")).body(value);
ResponseEntity<String> response = template.exchange(requestEntity, String.class);

RestRemplate附件功能

要发送multipart数据，您需要提供MultiValueMap<String, Object>，其值可以是部分内容的对象，文件部分的资源，或带头的部分内容的HttpEntity。例如:

MultiValueMap<String, Object> parts = new LinkedMultiValueMap<>();
parts.add("fieldPart", "fieldValue");
parts.add("filePart", new FileSystemResource("...logo.png"));
parts.add("jsonPart", new Person("Jason"));
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_XML);
parts.add("xmlPart", new HttpEntity<>(myBean, headers));

在大多数情况下，不必为每个部分指定内容类型。内容类型是根据选择用于序列化它的 HttpMessageConverter自动确定的，或者在基于文件扩展名的资源的情况下。如果有必要，你可以显式地提供带有HttpEntity包装器的MediaType。

一旦MultiValueMap准备好了，你就可以将它传递给RestTemplate，如下所示:

MultiValueMap<String, Object> parts = ...;
template.postForObject("https://pack.com/upload", parts, Void.class);

如果MultiValueMap包含至少一个非字符串值，则FormHttpMessageConverter将Content-Type设置为multipart/form-data。如果MultiValueMap是字符串值，Content-Type默认为application/x-www-form-urlencoded。如果有必要，也可以显式设置Content-Type。

完毕！！！

给个关注长期更新

Spring MVC 异常处理方式
SpringMVC参数统一验证方法
Spring MVC 异步请求方式
SpringMVC内嵌Tomcat零配置
Spring MVC 异常处理方式
SpringMVC跨域CORS的各种解决方式
SpringMVC请求原理源码分析
完全自定义实现SpringMVC核心组件
SpringBoot对Spring MVC都做了哪些事？（四）
SpringMVC跨域CORS的各种解决方式
SpringBoot对Spring MVC都做了哪些事？（一）
SpringMVC中的这些接口注解属性你都了解了吗？

关注