RestTemplate --学习笔记

最新推荐文章于 2024-10-28 20:04:54 发布

A泽予

最新推荐文章于 2024-10-28 20:04:54 发布

阅读量710

点赞数 22

分类专栏： JavaWeb学习笔记文章标签：学习笔记 RestTemplate

本文链接：https://blog.csdn.net/m0_71386740/article/details/139294716

版权

JavaWeb学习笔记专栏收录该内容

43 篇文章 0 订阅

订阅专栏

什么是RestTemplate？

想象一下你在一家快餐店点餐。你告诉服务员你想要的食物，服务员在系统中输入你的订单，然后厨房根据这个订单做餐。等待一会儿后，你拿到你的食物，整个过程既直接又高效。

在 Java 的世界里，RestTemplate 就像是你的收银员。当你的应用想要从另一个应用（厨房）获取数据时（比如点餐），你只需告诉 RestTemplate 你需要什么（发出 HTTP 请求），RestTemplate 会帮你处理这个请求，然后将其他应用的回应（做好的食物）交回给你。

简单来说，RestTemplate 是 Spring 提供的一个用于发送 HTTP 请求和获取 HTTP 回应的工具，使得和其他服务或 API 交互变得简单方便。

如何使用RestTemplate？

使用 RestTemplate 的过程可以简化为几个步骤，类似于在线订购商品时的流程：

创建 RestTemplate 实例：这就像是你要在线购物，首先需要一个浏览器或购物APP。在Spring应用中，你首先需要创建一个 RestTemplate 的实例。如果你使用的是 Spring Boot，可以通过配置一个Bean来实现。

   // 在你的配置类中定义一个RestTemplate的Bean
   @Bean
   public RestTemplate restTemplate() {
       return new RestTemplate();
   }

准备请求：确定你要请求的目标地址和所需数据。这就像是你在购物APP中浏览商品，选择你想要购买的商品并加入购物车。
发起请求：使用 RestTemplate 提供的方法发起请求，如 getForObject, postForObject 等。这些方法对应不同的HTTP操作，如GET, POST, DELETE等。这一步就像是你点击“结算”按钮，提交订单。

例如，如果你想要通过GET方法获取某个URL的资源，可以这样做：

   // 使用getForObject方法通过GET请求获取资源
   String result = restTemplate.getForObject("http://example.com/api/resource", String.class);

处理响应：收到的响应会被自动转换成你指定的类型。这步就像是收到购物网站发来的包裹，打开查看里面的商品是否是你所订购的。
异常处理：在请求过程中可能会遇到错误，如404 (资源未找到) 或 500（服务器错误）等。RestTemplate 会抛出相应的异常，例如 HttpClientErrorException 和 HttpServerErrorException。你需要准备好处理这些异常的逻辑。这就像是处理订单问题，可能是支付未成功，或者是地址填写错误等。

总的来说，使用 RestTemplate 的过程很像是在线购物的全过程，从选购商品到下单支付，再到最后收货，每一步都对应着发起HTTP请求的过程，只不过是在应用程序间进行数据交换。

exchange方法

RestTemplate 的 exchange 方法是一个非常灵活的方法，它允许您对 HTTP 请求进行详细的控制，并获取响应体(Response Entity)。这个方法通常用于执行需要自定义请求头，或者希望访问特定 HTTP 状态代码和响应头的场景。

exchange 方法的基本使用步骤如下：

创建 HttpHeaders 对象，并添加需要的HTTP请求头。

创建 HttpEntity 对象，将HTTP请求头和请求体(payload)组合在一起。（如果你没有任何请求参数，或者请求参数准备写在url中，可以省略一二步，直接将请求体设置为null，如果是在url中的请求参数可以通过{}拼接自定义字典，例：）

ResponseEntity<List<ItemDTO>> response = restTemplate.exchange(
//                serviceInstance.getUri() + "/items?ids={ids}",    //请求路径，请求参数拼接了下面定义的map
//                HttpMethod.GET,    //请求方式
//                null,    //请求体，为空
//                new ParameterizedTypeReference<List<ItemDTO>>() {    //复合返回值类型，使用ParameterizedTypeReference<>()表达
//                },
//                Map.of("ids", CollUtil.join(itemIds, ","))    //定义请求参数
//        );

确定要向其发送请求的URL地址以及HTTP方法（如 GET, POST, PUT, DELETE等）。
使用 RestTemplate 的 exchange 方法发送请求，并接收响应。

下面是一个使用 exchange 方法的例子，这个例子中我们发送一个GET请求，获取某个资源，同时设置了一些自定义的请求头。

import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;

// 1. 创建 HttpHeaders 对象，并设置请求头
HttpHeaders headers = new HttpHeaders();
headers.set("Authorization", "Bearer 你的token");
headers.set("Accept", "application/json");

// 2. 创建 HttpEntity 对象，没有请求体，只设置请求头
HttpEntity<String> entity = new HttpEntity<>(headers);

// 3. 准备 URL 和 HttpMethod
String url = "http://example.com/api/resource";
HttpMethod method = HttpMethod.GET;

// 4. 发送请求并获取响应
RestTemplate restTemplate = new RestTemplate();
ResponseEntity<String> response = restTemplate.exchange(url, method, entity, String.class);

// 5. 获取响应体
String responseBody = response.getBody();

// 6. 获取响应状态码
HttpStatus statusCode = response.getStatusCode();

在这个例子中，我们首先创建了一个 HttpHeaders 对象，并在其中设置了需要的请求头，例如认证信息和期望接收的数据类型。然后，我们创建了一个 HttpEntity 对象，其包含了我们的请求头。

在调用 exchange 方法时，我们传递URL，HTTP方法（例如 GET 或 POST），HttpEntity 对象（包含我们的请求头和请求体），以及我们希望响应被转换成的类类型。

exchange 方法返回一个 ResponseEntity 对象，这个对象包含了响应体和 HTTP 状态码等响应头信息，因此你可以非常精细地处理这个响应。