Java文件下载 – 帮你轻松实现文件下载功能

在开发 Web 应用程序中，文件下载是一项基本的需求。可以通过实现文件服务器或通过将文件附加到 Web 页面并让用户浏览器自动下载。但是，如果您希望提供用户可以从服务器下载任何类型文件的功能，则需要实现文件下载功能。

一、Java 文件下载的基本原理

文件下载的基本原理是读取文件、将其包含在响应中并发送响应。在 Java 中，由于 Servlet 生成响应和响应定义，所以使用 Servlet API 来提供文件下载功能是首选方案。

Servlet API 中提供了两个类：javax.servlet.ServletOutputStream 和 javax.servlet.ServletContext 展现了如何使用 Java 提供文件下载的功能。

二、如何实现 Java 文件下载

1. 准备所需要下载的文件

String fileName = "example.pdf"; // 文件名
String fileDownloadPath = "/usr/local/website/downloads/"; // 下载文件的根目录
String filepath = fileDownloadPath + fileName;

首先，需要准备所要下载的文件及其路径。这里我们假设文件名为example.pdf，将其保存在服务器上本地磁盘的/usr/local/website/downloads目录下。

2. 获得下载文件的 MIME 类型

ServletContext context = getServletContext(); // 获取 web 项目上下文
String mimeType = context.getMimeType(filepath); // 获取文件的 MIME 类型

通过获取文件扩展名，可以使用 ServletContext#getMimeType(filepath) 方法获得文件的 MIME 类型。在 HTTP 响应头中设置正确的 MIME 类型，可以防止浏览器解释文件并准确地处理它。

3. 设置响应的文件类型和头信息

response.setContentType(mimeType); // 设置响应的 MIME 类型
response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\""); // 设置响应头信息

在 Servlet 中，服务器端可以通过设置响应对象的 contentType 和 Content-Disposition 头部字段，在响应头信息中进行配置。

contentType 固定格式为：response.setContentType(“application/octet-stream”);，表示将以单一的二进制流来写出

4. 获取要下载的文件字节流，读取并写出文件

FileInputStream inputStream = new FileInputStream(filepath); 
ServletOutputStream outputStream = response.getOutputStream();
byte[] buffer = new byte[1024];
int len = 0;
while ((len = inputStream.read(buffer)) > 0) {
    outputStream.write(buffer, 0, len);
}
outputStream.flush();
outputStream.close(); 
inputStream.close();

既然要下载文件，那么就需要将文件的内容读取和下载发送到浏览器端。上述代码中，通过 FileInputStream 读取文件，通过 ServletOutputStream 输出文件，buffer 变量为读取或上传文件的缓冲区。

三、Java 文件下载实例代码示例

1. 文件下载的 Servlet 类

@WebServlet("/DownloadFileServlet")
public class DownloadFileServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) 
        throws ServletException, IOException {
        String fileName = request.getParameter("filename");
        if (fileName == null || "".equals(fileName)) {
            throw new ServletException("File Name can't be null or empty");
        }
        String fileDownloadPath = "/usr/local/website/downloads/"; // 下载文件的根目录
        String filepath = fileDownloadPath + fileName;

        File file = new File(filepath);
        if (!file.exists()) {
            throw new ServletException("File doesn't exists on server.");
        }
        String mimeType = getServletContext().getMimeType(filepath);
        if (mimeType == null) {
            mimeType = "application/octet-stream";
        }

        response.setContentType(mimeType);
        response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\"");

        FileInputStream inputStream = new FileInputStream(file);
        OutputStream outputStream = response.getOutputStream();
        byte[] buffer = new byte[1024];
        int len = 0;
        while ((len = inputStream.read(buffer)) > 0) {
            outputStream.write(buffer, 0, len);
        }
        outputStream.flush();
        outputStream.close();
        inputStream.close();
    }
}

2. 文件下载的 JSP 页面代码

Download PDF File

在 JSP 页面上提供文件下载链接，例如上面的代码，其中 example.pdf 为要下载的文件名称，href 指向 DownloadFileServlet Servlet。在用户点击链接时，将向 Servlet 发送文件下载请求，并下载该文件。

结束语

以上是基于 Servlet API 实现文件下载的一般方法。要实现更多的文件下载功能，开发人员可以基于 Servlet API 进一步拓展和优化，如设置下载进度条、下载前的身份认证、下载后的缓存存储等等。