java后端返回给前端文件流

原创

mob64ca12de24b0 2024-12-14 05:36:34 ©著作权

文章标签 文件流 java Java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12de24b0的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java后端返回文件流给前端的实现

在现代Web开发中，后端与前端的交互非常重要，尤其是在涉及文件下载的场景时。本文将教会你如何在Java后端返回文件流到前端，实现文件的下载功能。

整体流程

实现这一功能主要分为几个步骤。以下是简单的流程图和详细步骤介绍：

流程图

flowchart TD
    A[用户点击下载请求] --> B[前端发送请求给后端]
    B --> C[后端接收请求]
    C --> D[读取文件流]
    D --> E[将文件流返回给前端]
    E --> F[前端展示或下载文件]

步骤表

步骤	描述
步骤1	用户点击前端下载链接
步骤2	前端发送下载请求
步骤3	后端接收请求并处理
步骤4	后端读取文件并将其转化为流返回
步骤5	Frontend接收流并触发下载

每一步的实现

步骤1：前端点击下载

在前端实现一个简单的按钮来发送下载请求。可以使用JavaScript的fetch API来实现：

<!DOCTYPE html>
<html>
<head>
    <title>文件下载</title>
</head>
<body>
    <button id="download-btn">下载文件</button>
    <script>
        document.getElementById('download-btn').onclick = function() {
            // 向后端发送GET请求，下载文件
            fetch('/download')  
                .then(response => {
                    if (response.ok) {
                        return response.blob();  // 将返回的文件数据转化为Blob
                    }
                    throw new Error('文件下载失败'); 
                })
                .then(blob => {
                    // 创建下载链接
                    const url = window.URL.createObjectURL(blob); 
                    const a = document.createElement('a');
                    a.href = url;
                    a.download = '文件名.ext'; // 设置下载文件的名称
                    document.body.appendChild(a);
                    a.click(); // 触发下载
                    a.remove(); // 清理
                    window.URL.revokeObjectURL(url); // 释放blob对象
                })
                .catch(error => console.error(error));
        };
    </script>
</body>
</html>

步骤2：后端接收请求

在Java后端使用Spring Boot框架来处理请求，首先需要在控制器中编写一个处理下载请求的方法：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.OutputStream;

@RestController
public class FileDownloadController {

    @GetMapping("/download")  // 映射下载请求
    public void downloadFile(HttpServletResponse response) {
        String filePath = "/path/to/file.ext"; // 文件的实际路径
        try (FileInputStream inStream = new FileInputStream(filePath)) {
            response.setContentType("application/octet-stream"); // 设置response的内容类型
            response.setHeader("Content-Disposition", "attachment; filename=\"file.ext\""); // 设置下载文件的名称
            OutputStream outStream = response.getOutputStream(); // 获取输出流
            byte[] buffer = new byte[1024];
            int bytesRead = -1;

            // 将文件流写入输出流
            while ((bytesRead = inStream.read(buffer)) != -1) {
                outStream.write(buffer, 0, bytesRead);
            }
            outStream.flush(); // 刷新输出流
        } catch (IOException e) {
            e.printStackTrace(); // 异常处理
        }
    }
}