Spring 调用 RESTful 服务

最新推荐文章于 2024-08-10 11:21:24 发布
最新推荐文章于 2024-08-10 11:21:24 发布
阅读量7.9k 收藏 5
点赞数 5
分类专栏： spring springboot 文章标签： spring RESTful 调用 Rest

RestTemplate 是客户端访问 RESTful 服务的核心类。它在概念上类似于 Spring 中的其他模板类，如 JdbcTemplate 和 JmsTemplate 及 其他 Spring 组合项目中的模板类。RestTemplate 的行为是通过提供回调方法及配置 HttpMessageConverter 进行自定义的，HttpMessageConverter 将对象封送到 Http 请求体中，并将任何响应解组成为一个对象。

1. RestTemplate

在 Java 中调用 RESTful 服务通常使用工具类来完成，例如 Apache HttpComponents 中的 HttpClient。对于常见的 REST 操作来说 ，这种方法太低级，如下所示：

String uri = "http://example.com/hotels/1/bookings";

PostMethod post = new PostMethod(uri);
String request = // create booking request content
post.setRequestEntity(new StringRequestEntity(request));

httpClient.executeMethod(post);

if (HttpStatus.SC_CREATED == post.getStatusCode()) {
    Header location = post.getRequestHeader("Location");
    if (location != null) {
        System.out.println("Created new booking at :" + location.getValue());
    }
}

RestTemplate 提供了更高级别的方法，这些方法与六种主要的 Http 方法一一对应，它使得大部分 RESTful 服务的调用在一行内完成，以获得最佳实践。

表格 1.1. RestTemplate 方法概述

HTTP 方法RestTemplate 方法
DELETEdelete
GETgetForObject getForEntity
HEADheadForHeaders(String url, String…​ uriVariables)
OPTIONSoptionsForAllow(String url, String…​ uriVariables)
POSTpostForLocation(String url, Object request, String…​ uriVariables)
postForObject(String url, Object request, Class responseType, String…​ uriVariables)
PUTput(String url, Object request, String…​uriVariables)
PATCH and othersexchange execute

RestTemplate 方法的名称遵循命名约定，第一部分指出正在调用什么HTTP方法，第二部分指出返回的内容。例如，getForObject() 方法将执行GET，将HTTP响应转换为指定的对象类型，并返回该对象。如果在处理 Http 请求的过程中出现问题，将抛出一个类型为 RestClientException 的异常；可以通过将一个 ResponseErrorHandler 实现插入到 RestTemplate 来更改此行为。

exchange 和 execute 方法是上面列出的方法的通用版本，可以支持其他组合和方法，如 HTTP PATCH。但是，请注意，底层HTTP库也必须支持所需的组合。JDK HttpURLConnection 不支持 PATCH 方法，但 Apache HttpComponents HttpClient 4.2以上版本支持。还可以使用 ParameterizedTypeReference（一个能够捕获和传递泛型信息的类）来让 RestTemplate 将响应读取为一个泛型类型对象。

这些方法的输入及输出对象与 HTTP 消息之间的相互转换由 HttpMessageConverter 实例来完成。主要的 mime 类型会注册默认的 Converters，你也可以编写自己的 Converters，并通过设置 messageConverters 属性进行注册。注册到模板的默认转换器实例有 ByteArrayHttpMessageConverter，StringHttpMessageConverter，FormHttpMessageConverter 和SourceHttpMessageConverter。如果使用 MarshallingHttpMessageConverter 或 MappingJackson2HttpMessageConverter，则需要设置 messageConverters 属性覆盖这些默认值。

每个方法都有两种形式的 URI 模板参数：与变量个数相同长度的 String 参数或 Map<String, String>。例如：

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

使用变量长度的参数及

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

使用一个 Map<String, String>。

你可以调用无参的构造方法来创建一个 RestTemplate 实例。这将使用 java.net 包中的标准Java类作为底层实现来创建HTTP请求。可以通过指定一个 ClientHttpRequestFactory 实现来进行覆盖。Spring 提供了 HttpComponentsClientHttpRequestFactory 实现来使用 Apache HttpComponents HttpClient 创建请求。

前面使用 Apache HttpComponents HttpClient 实现的例子可以直接使用 RestTemplate 重写为：

uri = "http://example.com/hotels/{id}/bookings";
RestTemplate template = new RestTemplate();
Booking booking = // create booking object
URI location = template.postForLocation(uri, booking, "1");

如果要使用 Apache HttpComponents 代替原生的 java.net 的话，请按如下所示构建 RestTemplate：

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

Apache HttpClient 支持 gzip 编码。如果要使用它，按如下所示构建 HttpComponentsClientHttpRequestFactory：

HttpClient httpClient = HttpClientBuilder.create().build();
ClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
RestTemplate restTemplate = new RestTemplate(requestFactory);

常见的回调接口为 RequestCallback ，它在 execute 方法执行时被调用。

public <T> T execute(String url, HttpMethod method, RequestCallback requestCallback,
        ResponseExtractor<T> responseExtractor, String... uriVariables)

// also has an overload with uriVariables as a Map<String, String>.

RequestCallback 接口定义如下：

public interface RequestCallback {
 void doWithRequest(ClientHttpRequest request) throws IOException;
}

它可以操作请求头，并写入请求体。当使用 execute 方法时，你不需要再担心资源的管理，模板将始终关闭请求并处理所有错误。

1.1. URI 的使用

对每一个主要的 Http 方法，RestTemplate 提供了 String 类型的 URI 或 java.net.URI 两种类型作为方法的第一个参数。

String 类型的 URI 可以接受的模板参数分为两种，一种是与变量个数相同的 String 参数，另一种是 Map<String, String>。同时，它假定 URL 字符串没有被编码过且需要进行编码。示例如下：

restTemplate.getForObject("http://example.com/hotel list", String.class);

将在 http://example.com/hotel%20list 上执行 GET 请求。这意味着，如果输入的 URL 已经被编码过，那它可能会被再次编码，如：http://example.com/hotel%20list 将会成为 http://example.com/hotel%2520list。如果这个结果不符合预期，请使用 java.net.URI 替换字符串类型的 URI。

UriComponentsBuilder 类可以用来构建和编码URI，包括对 URI 模板的支持。例如：

UriComponents uriComponents = UriComponentsBuilder.fromUriString(
        "http://example.com/hotels/{hotel}/bookings/{booking}").build()
        .expand("42", "21")
        .encode();

URI uri = uriComponents.toUri();

或者分别指定每个 URI 组件：

UriComponents uriComponents = UriComponentsBuilder.newInstance()
        .scheme("http").host("example.com").path("/hotels/{hotel}/bookings/{booking}").build()
        .expand("42", "21")
        .encode();

URI uri = uriComponents.toUri();

1.2. 处理请求及响应头

除了上述方法之外，RestTemplate 还具有 exchange() 方法，可以用于基于 HttpEntity 类的任意 HTTP 方法执行。

最重要的是，exchange() 可以用户添加请求头并读取响应头。例如：

HttpHeaders requestHeaders = new HttpHeaders();
requestHeaders.set("MyRequestHeader", "MyValue");
HttpEntity<?> requestEntity = new HttpEntity(requestHeaders);

HttpEntity<String> response = template.exchange(
        "http://example.com/hotels/{hotel}",
        HttpMethod.GET, requestEntity, String.class, "42");

String responseHeader = response.getHeaders().getFirst("MyResponseHeader");
String body = response.getBody();

在上面的例子中，我们首先准备了一个包含 MyRequestHeader 头的请求实体。接着我们接收到响应，并读取 MyResponseHeader 及响应体。

1.3. Jackson JSON 视图支持

可以指定一个 Jackson JSON View 来序列化对象的部分属性。例如：

MappingJacksonValue value = new MappingJacksonValue(new User("eric", "7!jd#h23"));
value.setSerializationView(User.WithoutPasswordView.class);
HttpEntity<MappingJacksonValue> entity = new HttpEntity<MappingJacksonValue>(value);
String s = template.postForObject("http://example.com/user", entity, String.class);

2. HTTP 消息转换

方法 getForObject()，postForLocation() 及 put() 中的输入输出对象与 HTTP 消息之间的相互转换都需要使用到 HttpMessageConverters。HttpMessageConverter 接口的定义如下，你可以更好地理解其功能：

public interface HttpMessageConverter<T> {

    // Indicate whether the given class and media type can be read by this converter.
    boolean canRead(Class<?> clazz, MediaType mediaType);

    // Indicate whether the given class and media type can be written by this converter.
    boolean canWrite(Class<?> clazz, MediaType mediaType);

    // Return the list of MediaType objects supported by this converter.
    List<MediaType> getSupportedMediaTypes();

    // Read an object of the given type from the given input message, and returns it.
    T read(Class<T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;

    // Write an given object to the given output message.
    void write(T t, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;

}

针对主要媒体（mime）类型的实现在框架中已经提供，默认情况下会注册到客户端的 RestTemplate 及服务器端的 AnnotationMethodHandlerAdapter 中。以下部分将介绍 HttpMessageConverters 的实现。对于所有转换器，默认的媒体类型都可以通过设置 supportedMediaTypes 属性进行覆盖。

2.1. StringHttpMessageConverter

一个可以从 HTTP 请求和响应中读取和写入 Strings 的 HttpMessageConverter 实现。默认情况下，此转换器支持所有文本媒体类型（text/ *），并使用 text/plain 的 Content-Type 进行写入。

2.2. FormHttpMessageConverter

一个可以从 HTTP 请求和响应中读取和写入表单数据的 HttpMessageConverter 实现。默认情况下，此转换器读取和写入媒体类型 application/x-www-form-urlencoded。表单数据会读入及写出到一个 MultiValueMap<String, String>中。

2.3. ByteArrayHttpMessageConverter

一个可以从 HTTP 请求和响应中读取和写入字节数组的 HttpMessageConverter 实现。默认情况下，此转换器支持所有媒体类型（*/*），并以Content-Type 为 application/octet-stream 的形式进行写入。可以通过设置 supportedMediaTypes 属性进行覆盖，同时重写 getContentType(byte[]) 方法。

2.4. MarshallingHttpMessageConverter

一个可以读写 XML 的 HttpMessageConverter 实现。该转换器需要使用 org.springframework.oxm 中的 Marshaller 及 Unmarshaller 接口，这些可以通过构造函数及 bean 属性进行注入。默认情况下，此转换器支持（text/xml）和（application/xml）。

2.5. MappingJackson2HttpMessageConverter

一个可以使用 Jackson 的 ObjectMapper 读取和写入 JSON 的 HttpMessageConverter 实现。可以根据需要使用 Jackson 提供的注释来定制 JSON 映射。需要进一步控制时，可以通过 ObjectMapper 属性注入自定义 ObjectMapper，以便为特定类型提供自定义的 JSON 序列化器/反序列化器。默认情况下，此转换器支持（application/json）。

2.6. MappingJackson2XmlHttpMessageConverter

一个可以使用 Jackson XML 扩展的 XmlMapper 来读写 XML 的 HttpMessageConverter 实现。可以根据需要通过使用 JAXB 或 Jackson 提供的注释来定制 XML 映射。需要进一步控制时，可以通过 ObjectMapper 属性注入自定义的 XmlMapper，以便为特定类型提供自定义的 XML 序列化器/反序列化器。默认情况下，此转换器支持（application/xml）。

2.7. SourceHttpMessageConverter

一个可以从 HTTP 请求和响应读取和写入 javax.xml.transform.Source 的 HttpMessageConverter 实现。只支持DOMSource，SAXSource 和 StreamSource。 默认情况下，此转换器支持（text/xml）和（application/xml）。

2.8. BufferedImageHttpMessageConverter

一个可以从 HTTP 请求和响应中读取和写入 java.awt.image.BufferedImage 的 HttpMessageConverter 实现。该转换器使用 Java/IO API 实现媒体类型的读取和写入。

3. 异步 RestTemplate

Web 应用程序通常需要调用外部的 REST 服务。HTTP 特性和同步调用可能会在为这些需求扩展应用程序时带来挑战：可能会阻塞多个线程，等待远程 HTTP 响应。

AsyncRestTemplate 与 RestTemplate 的 API 非常相似，这些 API 之间的主要区别是 AsyncRestTemplate 返回的是 ListenableFuture 包装器，而不是具体的结果 。

之前的 RestTemplate 示例可以转换为：

// async call
Future<ResponseEntity<String>> futureEntity = template.getForEntity(
    "http://example.com/hotels/{hotel}/bookings/{booking}", String.class, "42", "21");

// get the concrete result - synchronous call
ResponseEntity<String> entity = futureEntity.get();

ListenableFuture 接收完成时的回调：

ListenableFuture<ResponseEntity<String>> futureEntity = template.getForEntity(
    "http://example.com/hotels/{hotel}/bookings/{booking}", String.class, "42", "21");

// register a callback
futureEntity.addCallback(new ListenableFutureCallback<ResponseEntity<String>>() {
    @Override
    public void onSuccess(ResponseEntity<String> entity) {
        //...
    }

    @Override
    public void onFailure(Throwable t) {
        //...
    }
});

默认情况下，AsyncRestTemplate 构造函数会注册一个 SimpleAsyncTaskExecutor 来执行 HTTP 请求。 当处理大量 short-lived 请求时，线程池的 TaskExecutor 实现（如ThreadPoolTaskExecutor）可能是一个不错的选择。

参考链接： http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#rest-client-access

qchery
关注
专栏目录
Spring中访问Restful接口
真一居士的博客
11-27 1170
目录 Spring中调用Restful接口 RestTemplate 简介 使用 AsyncRestTemplate 简介 使用 注意 Spring中调用Restful接口 RestTemplate 简介 RestTemplate类可用于在应用中调用rest服务，它简化了与http服务的通信方式，统一了RESTful的标准，封装了http链接， 我们只需要传入url及返回...
jeesz分布式架构-RestFul服务
civtsbiqr522632413的博客
06-06 103
1. REST介绍 REpresentational State Transfer (REST)是一种架构原则，其中将web服务视为资源，可以由其URL唯一标识。 RESTful Web服务的关键...
SpringBoot 第三方接口调用
最新发布
330553352的专栏
08-10 573
无论是RESTful API调用、Feign声明式HTTP客户端、Apache HttpClient等调用方式，每种方式都有其适用场景和优势，选择最适合的方式将有助于提高开发效率和系统性能。RestTemplate是我们项目中最为常用的接口调用方式了，它以经典 Spring Template 类的形式为 HTTP 客户端库提供了高级 API。Apache HttpClient 5是一个支持HTTP/2、高度可定制、支持异步请求的开源HTTP工具包，提供了丰富的API和扩展特性。方法的 Java 接口。
springboot调用restful接口_SpringBoot2.0基础案例(01)：环境搭建和RestFul风格接口
weixin_39535217的博客
12-09 226
一、SpringBoot 框架的特点1、聊聊 Springboot2.0 特点1)SpringBoot继承了Spring优秀的基因，上手难度小2)简化配置，提供各种默认配置来简化项目配置3)内嵌式容器简化Web项目，简化编码Spring Boot 则会帮助开发着快速启动一个 web 容器，在 Spring Boot 中，只需要在 pom 文件中添加如下一个 starter-web 依赖即可. or...
SpringBoot整合Spring Data JPA
天乔巴夏丶
11-28 492
文章目录本篇要点JPA是啥？Spring Data JPA快速SpringBoot快速整合JPA引入依赖配置ymlddl-auto的几种属性值实体类常见的主键生成策略启动项目，生成表数据访问层测试JPA五、源码下载参考阅读 本篇要点 简单介绍JPA。 介绍快速SpringBoot快速整合JPA JPA是啥？ The Java Persistence API is a standard technology that lets you “map” objects to relational da
springboot调用restful接口_SpringBoot使用快速构建restful应用，学废了吗
weixin_39722188的博客
12-09 253
本篇要点Spring Data REST的基本介绍。SpringBoot快速构建restful风格接口。Spring Data REST概述REST Web服务已经成为Web上应用程序集成的第一大手段。 REST的核心是定义一个包含与客户端进行交互资源的系统。 这些资源以超媒体驱动的方式实现。Spring MVC和Spring WebFlux各自提供了构建REST服务的坚实基础。 但是，即使为mu...
Spring实现RESTful Web 服务Demo
12-30
本教程将通过一个名为"spring-mvc-demo"的项目，详细介绍如何使用Spring框架来实现RESTful Web服务。 一、Spring MVC与RESTful Web服务 Spring MVC是Spring框架的一部分，专门用于处理Web请求和响应。RESTful Web...
浅谈java调用Restful API接口的方式
08-28
本文将详细介绍Java调用Restful API接口的方式，包括使用HttpURLConnection、HttpClient和Spring的RestTemplate等方式，并对每种方式进行详细的分析和比较。 首先，介绍了使用HttpURLConnection实现Restful接口的...
使用Spring构建Restful的Web服务.pdf
03-20
#### Spring框架与RESTful服务 - **Spring框架**：Spring是一个开源的Java平台，提供了全面的基础框架支持，包括依赖注入、面向切面编程、事务管理等。 - **Spring MVC**：Spring MVC框架用于构建Web应用程序，支持...
如何使用Spring RestTemplate访问restful服务
08-26
"使用Spring RestTemplate访问restful服务" Spring RestTemplate是Spring框架中的一种轻量级客户端，用于访问restful服务。它提供了一种简洁的方式来访问restful接口，简化了HTTP请求和响应处理的过程。 什么是...
基于 Java Spring 将上述类的方法对外提供 RESTful 服务并调用
12-23
在本教程中，我们将探讨如何基于 Java Spring 框架将一个特定的类的方法对外提供 RESTful 服务并进行调用。首先，我们有一个名为 `Person` 的类，包含姓名 (name)、年龄 (age) 和性别 (gender) 属性，以及对应的 ...
使用 Spring 3 来创建 RESTful Web Services
04-03
NULL 博文链接：https://liyaxi.iteye.com/blog/1463595
spring boot restful 接口示例项目
12-14
spring boot restful 接口示例项目，很详细，希望对大家有帮助。
SpringBoot Restful接口 Demo
08-04
SpringBoot+jpa Restful接口 无配置，最简单实现 jpa增删改差实现Restful 接口返回数据
RestFul服务介绍
11-21
1. REST介绍 REpresentational State Transfer (REST) 是一种架构原则，其中将 web 服务视为资源，可以由其 URL 唯一标识。 RESTful Web 服务的关键特点是明确使用 HTTP 方法来表示不同的操作的调用。 REST 的基本设计原则对典型 CRUD 操作使用 HTTP 协议方法： POST - 创建资源 GET - 检索资源 PUT – 更新资源 DELETE - 删除资源
SpringMVC实现RESTful服务
热门推荐
Learning
12-30 1万+
1、SpringMVC实现RESTful服务 SpringMVC原生态的支持了REST风格的架构设计。所涉及到的注解和类 @RequestMapping@PathVariable@ResponseBodyResponseEntity HttpStatus …… 2、查询资源      2.1 查询资源的代码实现 @RequestMapping(value = "{
springBoot远程调用restFul接口(RestTemplate)
hyj
04-15 3519
1、需求说明 有两个springBoot项目： 项目A将数据读到HashMap内存中并提供restFul接口供其他程序调用获取map数据； 项目B则负责先读取A中的map数据，再做其他逻辑操作； 下面则只介绍项目B的具体实现； 2、测试代码 使用springBoot自带的RestTemplate，来远程调用restFul接口并返回json数据； (1)restFul接口存在的测试数据...
SpringBoot实现RESTful服务接口
m0_58559010的博客
08-24 4319
在实际使用SpringBoot开发项目的过程中，后端服务经常会遇到跨模块访问的需求，这就需要我们的服务接口有同一的开发规范，这样在跨模块调用时才能更方便、高效。而Spring Boot也为我们创建Web服务提供了非常强大的组件化支持，简单而方便，我们一起来看一下。 RESTful服务 在当下的分布式系统及微服务架构中，RESTful风格是一种非常流行的Web服务表现方式，RESTful，即Representational State Transfer，表述性状态转移，其本质上只是一种架构风格而不是一.
Restful服务
懒散的蜗牛
10-16 1294
Restful Web API应该严格遵守Http的四个操作：             1、GET对应查询操作；             2、POST对应创建操作；             3、PUT对应更新操作；             4、DELETE对应删除操作。 从HttpClient发过来的Request类型只能是上述四种之一。 下面是我做的一个例子，这样可以更快的理解 ...
Spring构建RESTful Web服务入门
Maven的依赖管理和Gradle的灵活性都为开发RESTful服务提供了便利。 接着，文档深入到Spring框架与RESTful Web服务的结合，阐述了Spring如何支持RESTful架构。通过Spring，开发者可以轻松创建处理HTTP请求的控制器，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值