Java对Restful接口的调用_java调用restful接口-CSDN博客

本文链接：https://blog.csdn.net/HeiSeHuoEr/article/details/144444192

Java对Restful接口的调用

一、课前准备

环境搭建：
- 确保每位学生都有一个配置好的Java开发环境，包括JDK（建议使用最新版本）、IDE（如IntelliJ IDEA或Eclipse），以及Maven构建工具。
- 安装并配置Spring Boot项目，确保能够正常运行Spring应用程序。

依赖管理：

在项目的pom.xml文件中添加Spring Web依赖。例如：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

示例API：
- 准备一个可用的RESTful API用于课堂演示和练习

二、课堂主题

本次课程的主题是“Java对Restful接口的调用”，我们将深入探讨如何使用Spring框架中的RestTemplate来简化与RESTful Web服务的交互。通过本课程的学习，学生将掌握RestTemplate的基本用法及其在Spring应用中的集成方式。

三、课堂目标

理解RESTful服务的基本概念和HTTP请求方法。
理解RestTemplate：了解RestTemplate的作用、特点及其在Spring框架中的地位。
掌握基本用法：学会使用RestTemplate发送GET、POST等HTTP请求，处理响应数据。
实践操作：通过实际编码练习，熟悉RestTemplate的常见配置和使用场景。

四、知识要点

1、RESTful接口

（1）概念：

RESTful（Representational State Transfer）是一种架构风格，用于设计网络应用程序。广泛用于构建分布式系统和跨平台应用。RESTful API 基于 HTTP 协议，使用标准的 HTTP 方法（如 GET、POST、PUT、DELETE）来操作资源，并利用 URL 来表示资源的标识。RESTful API 设计旨在使系统的架构简单、可扩展和可维护。

想象一下，你去超市买东西，每个商品都有一个唯一的编号（比如条形码），你可以通过这个编号找到并操作这个商品。RESTful接口就像这个超市系统，它让互联网上的资源（如用户信息、产品列表等）可以通过唯一的标识符（URL）进行访问和操作。

（2）RESTful接口的核心思想

资源导向：在RESTful接口中，一切都围绕“资源”展开。资源可以是任何东西，比如用户、订单、文章等。每个资源都有一个唯一的URL来标识它。例如：
- /users 表示所有用户的集合。
- /users/123 表示ID为123的用户。
无状态：每次请求都是独立的，服务器不会保存客户端的状态信息。这意味着每次请求都必须包含所有必要的信息，以便服务器能够正确处理。这类似于每次去超市购物时，你都需要带上你的购物清单，而不是依赖上次的记忆。
统一接口：RESTful接口使用标准的HTTP方法（如GET、POST、PUT、DELETE）来操作资源。这些方法对应于不同的操作：
- GET：获取资源（例如，查看某个用户的详细信息）。
- POST：创建新资源（例如，添加一个新用户）。
- PUT：更新现有资源（例如，修改用户的邮箱地址）。
- DELETE：删除资源（例如，删除某个用户）。
自描述消息：每个响应都包含了足够的信息来描述如何处理该响应。例如，服务器会告诉客户端响应的内容类型（如JSON或XML），这样客户端就知道如何解析和使用这些数据。
**可缓存：**资源可以被缓存，提高性能和响应速度。

（3）RESTful接口与普通Web接口的区别

为了更好地理解RESTful接口与普通Web接口的区别，我们可以从以下几个方面来比较：

1. 设计理念

普通Web接口：通常是一个功能驱动的接口，关注的是具体的业务逻辑。例如，一个普通的Web接口可能有一个URL /get-user-info?id=123 来获取用户信息，另一个URL /update-user-email?id=123&email=new@example.com 来更新用户的邮箱。这种设计方式往往会导致URL复杂且难以维护。
RESTful接口：关注的是资源本身，而不是具体的操作。所有的操作都通过标准的HTTP方法来实现。例如，/users/123 这个URL既可以用来获取用户信息（GET），也可以用来更新用户信息（PUT）。这种方式更加简洁、直观，也更容易扩展和维护。

2. URL设计

普通Web接口：URL往往包含了具体的动作或参数，导致URL变得冗长且不易理解。例如，/get-user-info?id=123 和 /update-user-email?id=123&email=new@example.com。
RESTful接口：URL只表示资源的位置，而不包含具体的动作。所有的操作都通过HTTP方法来实现。例如，/users/123 这个URL可以用于多种操作，具体取决于你使用的HTTP方法（GET、POST、PUT、DELETE）。

3. 无状态性

普通Web接口：有些Web接口可能会依赖于服务器端的状态，例如会话（session）信息。这意味着服务器需要保存一些关于客户端的状态，这可能会导致性能问题和扩展性问题。
RESTful接口：RESTful接口是无状态的，每次请求都必须包含所有必要的信息。服务器不会保存任何客户端的状态，这使得系统更加简单、可靠，并且更容易扩展。

4. 标准化

普通Web接口：不同开发者设计的Web接口可能差异很大，缺乏统一的标准。这使得调用这些接口时需要花费更多的时间来理解其工作原理。
RESTful接口：RESTful接口遵循一套标准化的设计原则，使用标准的HTTP方法和状态码。这意味着只要你熟悉了RESTful的设计模式，就可以轻松地调用任何符合RESTful规范的API。

5. 可扩展性和维护性

普通Web接口：由于URL设计复杂且功能分散，随着系统的增长，维护和扩展这些接口可能会变得非常困难。
RESTful接口：RESTful接口的设计更加模块化和灵活，新增功能时只需添加新的资源或操作，而不需要修改现有的URL结构。这使得系统更易于扩展和维护。

（4）总结

RESTful接口是一种基于资源的设计方式，它使用标准的HTTP方法来操作资源，并且具有无状态、自描述和可扩展的特点。相比传统的普通Web接口，RESTful接口更加简洁、直观、易于理解和维护。

用大白话来说，就是通过URL就知道要什么资源，通过HTTP method就知道要干什么，通过HTTP status code就知道结果如何

总结：用URL定义资源，用HTTP描述操作

URL	HTTP	描述
/book	GET	查询
/book	POST	新增
/book	PUT	修改
/book	DELETE	删除

2、Spring RestTemplate 用法详细介绍

RestTemplate 是 Spring 框架提供的一个同步的 REST 客户端，用于简化与 RESTful Web 服务的交互。它支持多种 HTTP 方法（如 GET、POST、PUT、DELETE 等），并提供了自动转换响应体为 Java 对象的功能。以下是 RestTemplate 的详细用法介绍。

1. 创建 `RestTemplate` 实例

RestTemplate 可以通过直接实例化或通过 Spring 容器注入来使用。

直接实例化：

RestTemplate restTemplate = new RestTemplate();

2. 发送 GET 请求

RestTemplate 提供了多种方法来发送 GET 请求，具体选择取决于你希望如何处理响应数据。

RestTemplate有两个核心方法来执行Get请求

RestTemplate.getForObject方法可以获取对象
RestTemplate.getForEntity方法不仅可以获取对象，还可以获取Http状态码，请求头等详细信息。

方法：

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

示例：

getForObject()：用于获取资源并将其转换为指定类型的对象。

String url = "http://example.com/api/resource";
String result = restTemplate.getForObject(url, String.class);
System.out.println("Response: " + result);

getForEntity()：返回一个 ResponseEntity<T> 对象，包含状态码、响应头和响应体。

ResponseEntity<String> response = restTemplate.getForEntity(url, String.class);
System.out.println("Status Code: " + response.getStatusCode());
System.out.println("Headers: " + response.getHeaders());
System.out.println("Body: " + response.getBody());

带有路径参数的 GET 请求：

String url = "http://example.com/api/users/{id}";
Map<String, String> params = Collections.singletonMap("id", "123");
User user = restTemplate.getForObject(url, User.class, params);
System.out.println("User: " + user);

3. 发送 POST 请求

RestTemplate 支持发送 POST 请求以创建新资源或提交数据。

RestTemplate的Post方法与Get方法的区别是Post方法传参Map必须是MultiValueMap
Post方法的MultiValueMap既支持基本类型分开传参，也支持实体传参。类似下面的形式。

postForObject()：用于发送 POST 请求并将响应转换为指定类型的对象。

String url = "http://example.com/api/users";
User newUser = new User("Alice", "alice@example.com");
User createdUser = restTemplate.postForObject(url, newUser, User.class);
System.out.println("Created User: " + createdUser);

postForEntity()：返回一个 ResponseEntity<T> 对象，包含状态码、响应头和响应体。

ResponseEntity<User> response = restTemplate.postForEntity(url, newUser, User.class);
System.out.println("Status Code: " + response.getStatusCode());
System.out.println("Created User: " + response.getBody());

带有自定义请求头的 POST 请求：

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

HttpEntity<User> request = new HttpEntity<>(newUser, headers);
ResponseEntity<User> response = restTemplate.postForEntity(url, request, User.class);

4. 发送 PUT 和 DELETE 请求

RestTemplate 也支持发送 PUT 和 DELETE 请求，用于更新和删除资源。

put()：用于发送 PUT 请求以更新现有资源。

String url = "http://example.com/api/users/123";
User updatedUser = new User("Alice", "new.email@example.com");
restTemplate.put(url, updatedUser);

delete()：用于发送 DELETE 请求以删除资源。

String url = "http://example.com/api/users/123";
restTemplate.delete(url);

带有路径参数的 PUT 和 DELETE 请求：

String url = "http://example.com/api/users/{id}";
Map<String, String> params = Collections.singletonMap("id", "123");
restTemplate.put(url, updatedUser, params);
restTemplate.delete(url, params);

5. 处理复杂请求

有时你需要发送更复杂的请求，例如包含查询参数、请求体和自定义头部的请求。RestTemplate 提供了 exchange() 方法来处理这种情况。

Exchange方法既可以发送Get请求，也可以发送Post请求。
Exchange方法既可以做getForEntity，也可以做postForEntity。
Exchange 使用时，返回使用ResponseEntity，请求使用HttpEntity。

exchange()：用于发送任意类型的 HTTP 请求，并返回 ResponseEntity<T>。

String url = "http://example.com/api/resource?param1=value1&param2=value2";
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

HttpEntity<String> request = new HttpEntity<>("{\"key\":\"value\"}", headers);
ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.POST, request, String.class);

带有 URI 模板变量的 exchange()：

String url = "http://example.com/api/users/{id}/orders/{orderId}";
Map<String, String> uriVariables = new HashMap<>();
uriVariables.put("id", "123");
uriVariables.put("orderId", "456");

ResponseEntity<Order> response = restTemplate.exchange(url, HttpMethod.GET, null, Order.class, uriVariables);

总结

RestTemplate 是一个强大且易于使用的工具，适用于大多数 RESTful API 调用场景。通过掌握其基本用法和高级功能，你可以高效地与外部服务进行交互，并确保代码的可维护性和性能。然而，随着技术的发展，建议在新项目中考虑使用 WebClient 或其他现代的 REST 客户端库，以获得更好的异步支持和性能优化。