零基础入门，彻底搞懂SpringBoot文件下载的多种方式

2023-09-13 20:06:26

SpringBoot实现文件下载：新手入门指南

简介

文件下载是Java后端开发中的一项基本操作，在SpringBoot框架中，有许多简单高效的方式可以实现文件下载。本文将逐步介绍SpringBoot实现文件下载的入门技巧，帮助新手快速上手。

正确引入依赖

在使用SpringBoot进行文件下载之前，需要在项目中引入必要的依赖，在pom.xml文件中添加以下代码：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>

文件下载姿势大公开

SpringBoot提供了多种实现文件下载的姿势，每种姿势都有其特点：

1. 一键秒传：ResponseEntity

利用ResponseEntity可以实现一键秒传，代码简洁高效：

@GetMapping("/download")
public ResponseEntity<byte[]> downloadFile() throws IOException {
  byte[] bytes = Files.readAllBytes(Paths.get("/path/to/file"));
  return ResponseEntity.ok()
      .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=test.txt")
      .body(bytes);
}

2. 灵活控制：ServletOutputStream

使用ServletOutputStream可以更灵活地控制文件下载过程：

@GetMapping("/download")
public void downloadFile(HttpServletResponse response) throws IOException {
  byte[] bytes = Files.readAllBytes(Paths.get("/path/to/file"));
  response.setContentType("application/ocet-stream");
  response.addHeader(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=test.txt");
  OutputStream os = response.getOutputStream();
  os.write(bytes);
  os.flush();
  os.close();
}

3. 优雅定制：FileController

FileController提供了更加优雅的下载方式：

@Controller
public class FileController {

  @GetMapping("/download")
  public ResponseEntity<Resource> downloadFile() {
    Resource resource = new ClassPathResource("/path/to/file");
    return ResponseEntity.ok()
        .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=test.txt")
        .body(resource);
  }
}