Spring RestTemplate全面详细的介绍如何使用 |
您所在的位置：网站首页 › 蜜思婷的防晒霜需要卸妆吗 › Spring RestTemplate全面详细的介绍如何使用 |
Spring RestTemplate全面详细的介绍如何使用
|
原创 Springboot实战案例锦集 SpringBoot Cloud实战案例锦集 2022-12-30 09:50 发表于新疆 环境：Spring5.3.23 REST EndpointsSpring框架为调用REST端点提供了两种选择。 RestTemplate 带有同步模板方法API的原始Spring REST客户端。 WebClient 一个非阻塞、响应式的替代方案，同时支持同步、异步和流场景。请阅读《Spring WebFlux中使用WebClient远程接口调用》 从5.0开始，RestTemplate处于维护模式，只有少量的更改请求和bug可以接受。推荐使用 WebClient，它提供了更现代的API，并支持同步、异步和流场景。 RestTemplate详细介绍RestTemplate通过HTTP客户端库提供了一个更高级别的API。它使在一行中调用REST端点变得容易。核心方法如下: 方法名 描述 getForObject 通过GET获取表示形式 getForEntity 使用GET获取ResponseEntity(即状态、Header和Body) headForHeaders 通过使用HEAD检索资源的所有HEAD postForLocation 使用POST创建一个新资源，并从响应中返回Location Header postForObject 通过使用POST创建一个新资源，并从响应中返回表示 postForEntity 通过使用POST创建一个新资源，并从响应中返回表示 put 使用PUT创建或更新资源 patchForObject 使用PATCH更新资源，并从响应中返回表示。注意，JDK HttpURLConnection不支持PATCH，但Apache HttpComponents和其他版本支持 delete 使用DELETE删除指定URI上的资源 optionsForAllow 通过OPTION请求判断是否支持资源获取 exchange 这是上述方法的一个更通用的版本，在需要时提供了额外的灵活性。它接受一个RequestEntity(包括HTTP方法、URL、headers和body作为输入)，并返回一个ResponseEntity。这些方法允许使用 ParameterizedTypeReference而不是Class来指定泛型的响应类型 execute 执行请求的最通用方式，通过回调接口完全控制请求准备和响应提取 初始化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 result = restTemplate.getForObject("https://pack.com/hotels/{hotel}/bookings/{booking}", String.class, "42", "21");下面的例子使用了一个Map: Map 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 requestEntity = RequestEntity.get(uri) .header("X-API-Version", "1") .build();ResponseEntity 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属性来覆盖它。 MessageConverter 描述 StringHttpMessageConverter 可以从HTTP请求和响应读取和写入字符串实例。默认情况下，这个转换器支持所有文本媒体类型(text/*)，并以text/plain的内容类型写入 FormHttpMessageConverter 可以从HTTP请求和响应读取和写入表单数据。默认情况下，这个转换器会读写 application/x-www-form-urlencoded媒体类型。表单数据从MultiValueMap中读取并写入。转换器还可以写入(但不能读取)从MultiValueMap读取的多部分数据。默认支持 multipart/form-data。从Spring Framework 5.2开始，可以支持额外的多部分子类型来写表单数据 ByteArrayHttpMessageConverter 可以从HTTP请求和响应中读写字节数组。默认情况下，这个转换器支持所有媒体类型(*/*)，并使用 application/octet-stream的Content-Type进行写入。你可以通过设置supportedMediaTypes属性和覆盖getContentType(byte[])来覆盖它 MarshallingHttpMessageConverter 可以通过使用来自org.springframework.oxm包的Spring的编组器和解组器抽象来读写XML。在使用此转换器之前，需要一个编组器和解组器。可以通过构造函数或bean属性注入它们 MappingJackson2HttpMessageConverter 可以使用Jackson的ObjectMapper读取和写入JSON。通过使用Jackson提供的注释，可以根据需要定制JSON映射。当需要进一步控制时(如果需要为特定类型提供自定义JSON序列化器/反序列化器)，可以通过ObjectMapper属性注入自定义ObjectMapper MappingJackson2XmlHttpMessageConverter 可以通过使用Jackson XML扩展的XmlMapper来读写XML。通过使用JAXB或Jackson提供的注释，您可以根据需要定制XML映射。当需要进一步控制时(对于需要为特定类型提供自定义XML序列化器/反序列化器的情况)，可以通过ObjectMapper属性注入自定义XmlMapper SourceHttpMessageConverter 可以从HTTP请求和响应读取和写入 javax.xml.transform.Source。只支持DOMSource、SAXSource和StreamSource BufferedImageHttpMessageConverter 可以从HTTP请求和响应中读写 java.awt.image.BufferedImage。这个转换器读取和写入Java I/O API支持的媒体类 可以指定Jackson JSON视图，只序列化对象属性的一个子集，如下面的例子所示。 MappingJacksonValue value = new MappingJacksonValue(new User("eric", "7!jd#h23"));value.setSerializationView(User.WithoutPasswordView.class);RequestEntity requestEntity = RequestEntity.post(new URI("https://pack.com/user")).body(value);ResponseEntity response = template.exchange(requestEntity, String.class); RestRemplate附件功能要发送multipart数据，您需要提供MultiValueMap，其值可以是部分内容的对象，文件部分的资源，或带头的部分内容的HttpEntity。例如: MultiValueMap 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 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。 完毕！！！ 给个关注长期更新
|
【本文地址】
今日新闻 |
推荐新闻 |