使用 `RestTemplate` 获取二进制数据并返回 `byte[]`：解决方案与示例

一、前言

在开发微服务或者进行 HTTP 请求时，通常需要处理各种类型的响应数据。尤其是在涉及到下载文件、图片或者其他二进制数据时，如何高效地获取并返回这些数据是一个常见问题。Spring 提供了强大的 RestTemplate 来帮助我们处理 HTTP 请求和响应，但默认情况下，它并没有直接支持处理 InputStream 类型的响应数据。幸运的是，我们可以通过一些简单的配置，使得 RestTemplate 能够正确处理二进制数据。

二、 背景

在 Spring 中，RestTemplate 是一个同步的 HTTP 客户端，它简化了 HTTP 请求的操作，允许开发者以简单的方式发送请求和接收响应。当你发送请求获取图片、音频文件、视频文件或者任何二进制文件时，响应的类型通常是 InputStream 或 byte[]。RestTemplate 默认使用一组 HttpMessageConverter 来解析响应数据，但它并不直接支持将 InputStream 转换为 RestTemplate 的响应对象。

对于二进制数据，通常我们希望使用 byte[] 类型来接收响应，这样更加简便且易于处理。这篇文章将介绍如何使用 RestTemplate 获取二进制数据，并将响应数据处理为 byte[] 类型，最终返回文件内容。

三、 问题描述

假设我们有一个 REST API，它返回一个文件的输入流（InputStream）。我们希望通过 RestTemplate 获取这个文件，并将它以 byte[] 形式返回。由于 RestTemplate 默认并不支持直接将响应处理为 InputStream，我们需要做一些额外的配置和处理。

四、 解决方案

我们将采用将返回类型从 InputStream 修改为 byte[] 来解决这个问题。通过这种方式，RestTemplate 会自动使用 ByteArrayHttpMessageConverter 来处理字节数组响应数据。

1. 步骤一：修改 RestTemplate 请求代码

首先，我们需要修改我们的 RestTemplate 请求代码，使其能够接收二进制数据。在 Spring 中，我们可以使用 getForObject() 方法来发送 GET 请求，并直接接收响应数据。为了确保能够正确地接收二进制数据，我们将响应类型设为 byte[]。

import org.springframework.web.client.RestTemplate;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ImageController {

    private final RestTemplate restTemplate;

    public ImageController(RestTemplate restTemplate) {
        this.restTemplate = restTemplate;
    }

    @GetMapping("/image/{id}")
    public ResponseEntity<byte[]> getImage(@PathVariable String id) {
        // 构造文件获取的URL
        String imageUrl = "http://example.com/api/file/getFileInputStreamById/" + id;

        // 使用 byte[] 获取图片内容
        byte[] imageBytes = restTemplate.getForObject(imageUrl, byte[].class);

        // 设置响应头为图片类型
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.IMAGE_JPEG);  // 根据实际的图片格式调整

        // 返回图片内容
        return ResponseEntity.ok()
                             .headers(headers)
                             .body(imageBytes);
    }
}

2. 关键点分析

1. restTemplate.getForObject(imageUrl, byte[].class)：这行代码发送了一个 GET 请求，并将响应体转换为 byte[] 类型。RestTemplate 会自动使用 ByteArrayHttpMessageConverter 来将响应的数据（通常是图片、音频、视频等二进制数据）转换为 byte[]。

2. ResponseEntity<byte[]>：返回的是一个 ResponseEntity 对象，封装了图片的字节数据（byte[]）以及 HTTP 响应头。我们通过设置响应头 Content-Type 为 MediaType.IMAGE_JPEG 来告知客户端返回的是一个 JPEG 图片（根据实际情况选择正确的类型，例如 image/png 或其他格式）。

3. HttpHeaders：我们通过设置 HttpHeaders 来控制响应的头信息。例如，指定返回内容的类型（Content-Type），确保客户端能够正确处理返回的数据。

3. 步骤二：配置 RestTemplate Bean

如果你使用的是 Spring Boot，可以通过配置一个 RestTemplate Bean，使其可以在整个应用程序中共享使用。这样我们就不需要每次都手动创建 RestTemplate 实例了。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class AppConfig {

    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

4. 步骤三：处理图片文件（可选）

如果你需要将字节数组转换为文件，或者进行其他处理（例如保存文件、展示图片等），可以使用 ByteArrayInputStream 来将字节数组转为输入流，或者将字节数组直接写入文件系统：

import java.io.ByteArrayInputStream;
import java.io.FileOutputStream;
import java.io.IOException;

public void saveImageToFile(byte[] imageBytes, String filePath) throws IOException {
    try (ByteArrayInputStream bis = new ByteArrayInputStream(imageBytes);
         FileOutputStream fos = new FileOutputStream(filePath)) {
        byte[] buffer = new byte[1024];
        int bytesRead;
        while ((bytesRead = bis.read(buffer)) != -1) {
            fos.write(buffer, 0, bytesRead);
        }
    }
}

5. 步骤四：处理不同格式的图片

根据返回的图片格式，你可能需要调整 Content-Type 头。常见的图片格式包括：

• JPEG: MediaType.IMAGE_JPEG
• PNG: MediaType.IMAGE_PNG
• GIF: MediaType.IMAGE_GIF

可以根据实际情况进行调整：

headers.setContentType(MediaType.IMAGE_PNG);  // 如果是 PNG 格式

5. 总结

通过这种方式，我们可以非常方便地使用 RestTemplate 获取二进制数据（如图片、文件等）并返回 byte[] 类型的响应。此方法解决了直接返回 InputStream 的问题，同时通过 byte[] 提供了更加灵活的处理方式。此外，RestTemplate 的简洁 API 使得开发过程更加高效。需要注意的是，在实际开发中，你还可以进一步对响应内容进行处理，例如文件保存、流式展示等。

这种方式是一个非常常见的解决方案，可以广泛应用于 RESTful 服务的客户端实现中。