SpringBoot使用云端资源URL下载文件的接口写法

在现代Web应用程序中，经常需要从云端资源下载文件，比如从云存储服务（如AWS S3、Google Cloud Storage等）下载文件。Spring Boot 提供了简单而灵活的方式来实现这一目标。在本文中，我们将探讨如何使用 Spring Boot 来定义接口，以实现从云端资源URL下载文件的功能。

接口定义

首先，我们需要定义一个接口，该接口将接受云端资源的URL，并将其作为文件发送给客户端。以下是如何在 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.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

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

@RestController
public class FileDownloadController {

    private final RestTemplate restTemplate;

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

    @GetMapping(value = "/download-file")
    public ResponseEntity<Resource> downloadFile(@RequestParam String fileUrl) throws IOException {
        // 从云端资源下载文件
        byte[] fileBytes = downloadFileFromUrl(fileUrl);

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

        // 获取文件名
        String fileName = getFileNameFromUrl(fileUrl);

        // 设置文件下载响应头
        HttpHeaders headers = new HttpHeaders();
        headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=" + fileName);

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

    // 从URL下载文件字节数组
    private byte[] downloadFileFromUrl(String fileUrl) throws IOException {
        // 使用RestTemplate下载文件
        return restTemplate.getForObject(fileUrl, byte[].class);
    }

    // 从URL获取文件名
    private String getFileNameFromUrl(String fileUrl) {
        // 从URL中获取文件名
        String[] parts = fileUrl.split("/");
        return parts[parts.length - 1];
    }
}

在上面的代码中，我们定义了一个 FileDownloadController 类，并在其中定义了一个 downloadFile 方法。该方法接受一个云端资源的URL作为参数，并使用 RestTemplate 从该URL下载文件的字节数组。然后，我们将文件字节数组封装为 ByteArrayResource 对象，并设置了文件下载的响应头，包括从URL中提取的文件名。最后，我们将 Resource 对象作为响应体返回。

测试接口

现在，我们可以测试我们定义的接口。我们可以通过浏览器或使用 cURL 或 Postman 等工具向 /download-file 接口发送 GET 请求，并在查询参数中提供云端资源的URL。服务器将返回文件，浏览器或工具会自动下载该文件。

总结

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