java springboot如何返回文件-CFANZ编程社区

Java Spring Boot 如何返回文件

在开发 Web 应用时，常常需要将文件返回给用户。例如，用户下载报告、图片或其他文件。在 Spring Boot 中，返回文件的实现非常简单。本文将详细介绍如何在 Spring Boot 应用中实现文件的返回，包括代码示例和程序流程序列图。

需求背景

假设我们有一个简单的 Spring Boot 应用，需要提供一个 API，通过这个 API 用户可以下载存储在服务器上的 PDF 文件。

实现步骤

1. 创建 Spring Boot 项目

首先，您需要创建一个 Spring Boot 项目。您可以使用 Spring Initializr 或者您的 IDE 来快速集成相关依赖。确保在项目中包含 Spring Web 依赖。

2. 编写控制器

我们将创建一个控制器，处理文件下载请求。控制器会在收到请求时，读取文件并作为响应返回。

以下是控制器的示例代码：

import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
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;

import java.io.File;
import java.io.IOException;

@RestController
public class FileDownloadController {

    @GetMapping("/download/{fileName}")
    public ResponseEntity<Resource> downloadFile(@PathVariable String fileName) {
        // 文件存储路径
        String filePath = "C:/files/" + fileName;

        File file = new File(filePath);
        if (!file.exists()) {
            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
        }

        Resource resource = new FileSystemResource(file);
        HttpHeaders headers = new HttpHeaders();
        headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + file.getName() + "\"");

        return new ResponseEntity<>(resource, headers, HttpStatus.OK);
    }
}

3. 代码说明

导入必要的类：我们需要 File, ResponseEntity, Resource 等类来处理文件和HTTP响应。
定义下载方法：downloadFile 方法接收一个文件名作为参数，构建文件路径并检查文件是否存在。
文件处理与返回：如果文件存在，则将其包装在 FileSystemResource 中，并设置响应头以指定这是一个附件下载。

4. 测试接口

启动您的 Spring Boot 应用后，您可以在浏览器中或使用 Postman 访问 http://localhost:8080/download/sample.pdf，其中 sample.pdf 是存储在 C:/files/ 目录中的 PDF 文件。

序列图

下面给出一个关于用户下载文件的序列图：

sequenceDiagram
    participant User
    participant Controller
    participant File System

    User->>Controller: 请求下载 /download/sample.pdf
    Controller->>File System: 检查文件是否存在
    alt 文件存在
        File System-->>Controller: 返回文件
        Controller-->>User: 返回文件资源
    else 文件不存在
        Controller-->>User: 返回404 Not Found
    end