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 進一步拓展和優化，如設置下載進度條、下載前的身份認證、下載後的緩存存儲等等。