Spring RestTemplate具体使用详解

简介

RestTemplate是Spring提供的专门用于调用Restful风格的Web服务的客户端工具，它封装了底层的HTTP连接以及常用的HTTP请求方法，包括GET、POST、PUT、DELETE等，可以大大简化我们调用Web服务的代码量。

基本用法

使用RestTemplate最基本的用法是通过创建一个RestTemplate对象实例来发送HTTP请求，例如：

RestTemplate restTemplate = new RestTemplate();
String result = restTemplate.getForObject("http://example.com/api/getData", String.class);

这个例子中，我们首先创建一个RestTemplate对象实例，然后使用getForObject方法发送了一个GET请求，并将响应转为字符串类型的结果。

GET请求

发送GET请求的方法有两种，分别是getForObject和getForEntity。其中前者返回的是响应体的内容，后者则返回一个ResponseEntity对象，它包含了完整的响应信息，如状态码、响应头、响应体等。例子如下：

RestTemplate restTemplate = new RestTemplate();
//使用getForObject发送GET请求，并将响应转为字符串
String result = restTemplate.getForObject("http://example.com/api/getData", String.class);

//使用getForEntity发送GET请求，并返回一个ResponseEntity对象
ResponseEntity<String> response = restTemplate.getForEntity("http://example.com/api/getData", String.class);
int statusCode = response.getStatusCodeValue();
String responseBody = response.getBody();

上面的例子中，我们使用了两种不同的方法发送了一个GET请求，并获取了不同类型的响应。需要注意的是，getForObject方法只返回响应体的内容，没有响应头和状态码等信息，而getForEntity方法则可以获取到完整的响应信息。

POST请求

发送POST请求的方法有两种，分别是postForObject和postForEntity。其中前者返回的是响应体的内容，后者则返回一个ResponseEntity对象，它包含了完整的响应信息，如状态码、响应头、响应体等。例子如下：

RestTemplate restTemplate = new RestTemplate();
//创建请求体
MultiValueMap<String, String> requestBody = new LinkedMultiValueMap<>();
requestBody.add("username", "user");
requestBody.add("password", "pass");

//使用postForObject发送POST请求，并将响应转为字符串
String result = restTemplate.postForObject("http://example.com/api/login", requestBody, String.class);

//使用postForEntity发送POST请求，并返回一个ResponseEntity对象
ResponseEntity<String> response = restTemplate.postForEntity("http://example.com/api/login", requestBody, String.class);
int statusCode = response.getStatusCodeValue();
String responseBody = response.getBody();

上面的例子中，我们使用了两种不同的方法发送了一个POST请求，并获取了不同类型的响应。需要注意的是，发送POST请求需要创建一个请求体requestBody，这里我们使用了一个MultiValueMap对象将请求参数封装起来。

示例1：获取GitHub上的用户信息

下面我们通过一个实际的例子，来演示如何使用RestTemplate调用GitHub的API接口，获取用户信息。

首先，我们需要注册一个GitHub账号，然后创建一个Access Token，用于调用API接口。创建方法如下：

1. 登录GitHub账号
2. 点击右上角的头像，选择Settings
3. 选择Developer settings，然后选择Personal access tokens
4. 点击Generate new token，并填写相应的信息、选择权限后，点击生成
5. 把生成的Token值复制到剪贴板中

有了AccessToken后，我们就可以使用RestTemplate来调用GitHub的API接口了。例如，我们要获取用户名为octocat的用户信息，可以使用以下代码：

RestTemplate restTemplate = new RestTemplate();
//设置Authorization头信息，用于验证用户身份
HttpHeaders headers = new HttpHeaders();
headers.set("Authorization", "Bearer c14b313827354c2f0f83ef8d2abc2d7d69a12d34");

//设置请求参数和类型
HttpEntity<String> request = new HttpEntity<>(headers);
String url = "https://api.github.com/users/octocat";

//使用exchange方法发送GET请求，并返回一个ResponseEntity对象
ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.GET, request, String.class);
int statusCode = response.getStatusCodeValue();
String responseBody = response.getBody();

上面的例子中，我们设置了Authorization头信息，用于验证用户身份。然后，我们使用了exchange方法发送了一个GET请求，并获取了完整的响应信息。

示例2：POST发送JSON数据

下面我们通过一个实际的例子，来演示如何使用RestTemplate向服务端发送JSON数据。

我们假设有一个服务端API接口，需要接收一个JSON格式的用户对象，然后将其存入数据库。客户端代码如下：

RestTemplate restTemplate = new RestTemplate();
//设置请求头信息，指定Content-Type为application/json
HttpHeaders headers = new HttpHeaders();
headers.set("Content-Type", "application/json");

//构造请求的JSON数据
User user = new User("John", "Doe");
ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(user);

//构造请求实体对象
HttpEntity<String> request = new HttpEntity<>(json, headers);

//发送POST请求，并获取响应信息
String url = "http://localhost:8080/api/user";
String response = restTemplate.postForObject(url, request, String.class);

上面的例子中，我们首先构造了一个用户对象User，然后使用ObjectMapper来将其转为JSON格式的字符串。接着，我们设置了请求头信息，指定Content-Type为application/json，并将转换后的JSON字符串设置为请求体。最后，使用postForObject方法发送POST请求，并获取响应信息。

以上就是RestTemplate的具体使用方法和示例，希望对你有所帮助。