SpringBoot使用ResponseEntity下载图片

在许多Web应用程序中，提供下载图片的功能是很常见的需求。Spring Boot 提供了一种简单的方式来实现这一目标。在这篇博文中，我们将探讨如何使用 Spring Boot 来定义接口以实现从服务器下载图片的功能。

接口定义

首先，我们需要定义一个接口，该接口将接受图片的字节数组，并将其作为图片文件发送给客户端。我们可以使用 Spring MVC 来定义这样的接口。以下是如何在 Spring Boot 中定义这样一个接口的示例代码：

import org.springframework.core.io.ByteArrayResource;
import org.springframework.core.io.Resource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

@RestController
public class ImageController {

    @GetMapping(value = "/download-image", produces = MediaType.IMAGE_JPEG_VALUE)
    public ResponseEntity<Resource> downloadImage() throws IOException {
        // 从文件系统或数据库中读取图片字节数组
        byte[] imageBytes = getImageBytesFromSomewhere();

        // 将字节数组封装为Resource对象
        Resource resource = new ByteArrayResource(imageBytes);

        // 设置图片下载响应头
        HttpHeaders headers = new HttpHeaders();
        headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=image.jpg");

        // 构建响应实体并返回
        return ResponseEntity
                .status(HttpStatus.OK)
                .headers(headers)
                .body(resource);
    }

    // 这是一个示例方法，用于从文件系统中读取图片字节数组
    private byte[] getImageBytesFromSomewhere() throws IOException {
        String imagePath = "/path/to/your/image.jpg";
        Path path = Paths.get(imagePath);
        return Files.readAllBytes(path);
    }
}

在上面的代码中，我们定义了一个 ImageController 类，并在其中定义了一个 downloadImage 方法。该方法获取图片的字节数组，将其封装为 ByteArrayResource 对象，并设置了图片下载的响应头，包括文件名为 image.jpg。最后，我们将 Resource 对象作为响应体返回。

测试接口

现在，我们可以测试我们定义的接口。我们可以通过浏览器或使用 cURL 或 Postman 等工具向 /download-image 接口发送 GET 请求。服务器将返回图片文件，浏览器或工具会自动下载该图片。

总结

在本文中，我们学习了如何使用 Spring Boot 来定义一个接口，该接口能够接受图片的字节数组，并将其作为图片文件发送给客户端。我们创建了一个简单的 Spring MVC 控制器，并使用 @GetMapping 注解来定义了一个接口。然后，我们在方法中获取图片的字节数组，并将其封装为 Resource 对象并设置了图片下载的响应头。通过这种方式，我们可以很容易地实现从服务器下载图片的功能。