【java】Spring RestTemplate 简介

Spring RestTemplate 是 Spring 提供的用于发送 HTTP 请求并处理响应的较方便的工具类。通过 RestTemplate，我们可以简单地发送 GET、POST、DELETE 等常见的 HTTP 请求，并解析响应体。在本文中，我将详细介绍 RestTemplate 的使用方法，并给出一些关于 GET、POST、DELETE 和文件上传下载的示例。

一、RestTemplate 的概述

RestTemplate 是 Spring Framework 4.0 以后提供的一个 API，它是 Spring 对 HttpClient 和 HttpURLConnection 的封装，让开发者可以更加简单地进行 HTTP 请求和响应的处理。

在 Spring 中，我们可以使用 RestTemplate 发送 GET、POST、PUT、DELETE、OPTIONS、HEAD 等请求，并且支持 JSON、XML、字符串等多种类型的请求数据和响应数据。

以下是 RestTemplate 主要的几个方法：

• getForObject(url, responseType, uriVariables)：发送 GET 请求并获取响应体
• postForObject(url, request, responseType, uriVariables)：发送 POST 请求并获取响应体
• delete(url, uriVariables)：发送 DELETE 请求
• execute(url, HttpMethod, requestCallback, responseExtractor, uriVariables)：发送自定义请求并处理响应体

二、GET 请求示例

以下是一个使用 RestTemplate 发送 GET 请求的示例代码：

RestTemplate restTemplate = new RestTemplate();
String url = "http://localhost:8080/user?id={id}";
Map<String, String> params = new HashMap<>();
params.put("id", "1");
User user = restTemplate.getForObject(url, User.class, params);

上述代码中，我们创建了一个 RestTemplate 的实例，并定义了请求的 URL 和参数。然后使用 getForObject 方法发送 GET 请求，并将响应体转换为 User 对象。

三、POST 请求示例

以下是一个使用 RestTemplate 发送 POST 请求的示例代码：

RestTemplate restTemplate = new RestTemplate();
String url = "http://localhost:8080/user";
User user = new User("Tom", 20);
User result = restTemplate.postForObject(url, user, User.class);

上述代码中，我们创建了一个 RestTemplate 的实例，并定义了请求的 URL 和请求体。然后使用 postForObject 方法发送 POST 请求，并将响应体转换为 User 对象。

四、DELETE 请求示例

以下是一个使用 RestTemplate 发送 DELETE 请求的示例代码：

RestTemplate restTemplate = new RestTemplate();
String url = "http://localhost:8080/user?id={id}";
Map<String, String> params = new HashMap<>();
params.put("id", "1");
restTemplate.delete(url, params);

上述代码中，我们创建了一个 RestTemplate 的实例，并定义了请求的 URL 和参数。然后使用 delete 方法发送 DELETE 请求。

五、文件上传示例

以下是一个使用 RestTemplate 进行文件上传的示例代码：

public void uploadFile() {
    RestTemplate restTemplate = new RestTemplate();
    String url = "http://localhost:8080/file/upload";

    MultiValueMap<String, Object> body = new LinkedMultiValueMap<>();
    body.add("file", new FileSystemResource(new File("path/to/your/file")));
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.MULTIPART_FORM_DATA);

    HttpEntity<MultiValueMap<String, Object>> requestEntity = new HttpEntity<>(body, headers);
    ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.POST, requestEntity, String.class);
}

上述代码中，我们创建了一个 RestTemplate 的实例，并定义了请求的 URL、文件路径和请求体。然后使用 exchange 方法发送 POST 请求，并将响应体转换为 String 类型。

六、文件下载示例

以下是一个使用 RestTemplate 进行文件下载的示例代码：

public void downloadFile() {
    RestTemplate restTemplate = new RestTemplate();
    String url = "http://localhost:8080/file/download";
    File file = restTemplate.execute(url, HttpMethod.GET, null, clientHttpResponse -> {
        InputStream inputStream = clientHttpResponse.getBody();
        File tmpFile = File.createTempFile("tmp", ".jpg");
        FileUtils.copyInputStreamToFile(inputStream, tmpFile);
        return tmpFile;
    });
}

上述代码中，我们创建了一个 RestTemplate 的实例，并定义了请求的 URL。然后使用 execute 方法发送 GET 请求，并将响应体转换为 File 类型，实现文件的下载。

七、总结

RestTemplate 是一个非常方便的 HTTP 请求工具类，可以轻松地进行 GET、POST、DELETE 等常见请求，并支持多种数据类型的请求和响应。在本文中，我们给出了关于 RestTemplate 的基础介绍，并给出了 GET、POST、DELETE 和文件上传下载的示例代码。有了这些知识和示例，相信大家能够更加灵活地使用 RestTemplate 处理 HTTP 请求和响应。