使用Spring Boot实现文件下载功能

使用Spring Boot实现文件下载功能

大家好，我是微赚淘客系统3.0的小编，是个冬天不穿秋裤，天冷也要风度的程序猿！

1. 概述

文件下载是Web应用中常见的功能之一，通过Spring Boot可以很方便地实现文件下载功能。本文将详细介绍如何使用Spring Boot编写一个简单的文件下载接口，包括处理文件下载请求、设置响应头和实现文件流输出等。

2. 实现步骤

2.1 创建Spring Boot项目

首先，我们需要创建一个Spring Boot项目。可以使用Spring Initializr（https://start.spring.io/）快速生成一个基础的Spring Boot项目，添加Web依赖即可。

package cn.juwatech.filedownload;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class FileDownloadApplication {

    public static void main(String[] args) {
        SpringApplication.run(FileDownloadApplication.class, args);
    }
}

2.2 编写文件下载控制器

创建一个RestController来处理文件下载请求，并提供一个接口用于下载文件。

package cn.juwatech.filedownload.controller;

import org.springframework.core.io.InputStreamResource;
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.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;

@RestController
@RequestMapping("/api")
public class FileDownloadController {

    private static final String FILE_PATH = "/path/to/your/file/sample.txt"; // 替换成实际文件路径

    @GetMapping("/download")
    public ResponseEntity<InputStreamResource> downloadFile() throws IOException {
        File file = new File(FILE_PATH);
        InputStreamResource resource = new InputStreamResource(new FileInputStream(file));

        HttpHeaders headers = new HttpHeaders();
        headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=" + file.getName());
        headers.add(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_OCTET_STREAM_VALUE);

        return ResponseEntity.ok()
                .headers(headers)
                .contentLength(file.length())
                .contentType(MediaType.APPLICATION_OCTET_STREAM)
                .body(resource);
    }
}

在上面的代码中：

• /api/download接口用于下载文件。
• FILE_PATH指定了要下载的文件路径，可以根据实际情况修改为你的文件路径。
• 使用ResponseEntity<InputStreamResource>来封装文件的输入流资源，并设置响应头，指定下载文件的文件名和内容类型。

3. 测试文件下载功能

启动Spring Boot应用程序，并访问http://localhost:8080/api/download，即可下载指定路径的文件。

4. 总结

本文介绍了如何使用Spring Boot实现文件下载功能。通过创建一个RestController处理文件下载请求，并设置响应头和输出文件流，实现了简单而有效的文件下载功能。希望本文能帮助读者理解和实现Spring Boot中的文件下载功能。

著作权归聚娃科技微赚淘客系统开发者团队，转载请注明出处！