java返回流下载文件

原创

mob64ca12db3721 2024-08-20 04:32:15 ©著作权

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

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

Java返回流下载文件的实现

在Web应用程序中，下载文件的需求非常常见。用户可能需要下载文档、图片、音频或视频文件。为了实现这一功能，我们可以使用Java编写简单的文件下载代码，并通过HTTP响应将文件流返回给用户。本文将详细解析这一过程，并提供代码示例。

文件下载流程

下载文件的基本流程如下：

客户端发起HTTP请求，要求下载文件。
服务器处理请求，获取要下载的文件。
服务器设置响应头，返回文件流给客户端。
客户端接收并保存文件。

为了更好地理解这个流程，以下是一个序列图展示了客户端和服务器之间的交互：

sequenceDiagram
    participant C as 客户端
    participant S as 服务器
    C->>S: 发起下载请求
    S->>S: 读取文件
    S->>C: 返回文件流

Java实现文件下载

下面我们将使用Java编写一个简单的HTTP文件下载处理程序。假设我们要下载的文件存储在服务器的特定目录中。

代码示例

import java.io.*;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class FileDownloadServlet extends HttpServlet {

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 要下载的文件路径
        String filePath = getServletContext().getRealPath("/files/example.txt");
        File file = new File(filePath);
        
        // 检查文件是否存在
        if (!file.exists()) {
            response.sendError(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
        
        // 设置响应内容类型
        response.setContentType("application/octet-stream");
        response.setHeader("Content-Disposition", "attachment; filename=" + file.getName());

        // 设置响应流
        try (FileInputStream fileInputStream = new FileInputStream(file);
             OutputStream outputStream = response.getOutputStream()) {

            byte[] buffer = new byte[1024];
            int bytesRead;

            // 读取文件流并写入响应流
            while ((bytesRead = fileInputStream.read(buffer)) != -1) {
                outputStream.write(buffer, 0, bytesRead);
            }
        }
    }
}

代码解析

导入必要的类：HttpServlet是一个Java Servlet的基类，HttpServletRequest和HttpServletResponse分别表示HTTP请求和响应。
获取文件路径：使用 getServletContext().getRealPath() 方法从Web应用的上下文中获取文件的绝对路径。
文件存在性检查：通过 File.exists() 方法检查文件是否存在，不存在则返回404错误。
设置响应类型和头信息：
- Content-Type 设置为 application/octet-stream，表明这是一个二进制流文件。
- Content-Disposition 设置为 attachment，使浏览器下载而不是直接打开文件。
读取文件并写入响应流：通过 FileInputStream 读取文件并通过 OutputStream 将其写入HTTP响应。