通過Servlet實現文件的下載

　　當我們實現一個文件下載功能時，大多數人是通過Strust等框架實現的。Strust框架把底層的文件下載細節隱藏了起來，使我們不得其要領。下面我通過一個程序示例來再現通過Servlet下載文件的細節和原理。

程序源碼

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>

    <!--可以配置一些Listener 或 Filter 來觀察一些對象的生命周期 -->
    
    <servlet>
        <servlet-name>download_servlet</servlet-name>
        <servlet-class>edu.shao.webapp.sample.DownloadServlet</servlet-class>
        <init-param>
            <param-name>fileRoot</param-name>
            <param-value>d:/</param-value>
        </init-param>
        <init-param>
            <param-name>contentType</param-name>
            <param-value>application/octet-stream</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>download_servlet</servlet-name>
        <url-pattern>/download</url-pattern>
    </servlet-mapping>
</web-app>

DownloadServlet.java

package edu.shao.webapp.sample;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URLEncoder;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class DownloadServlet extends HttpServlet{
    private static final long serialVersionUID = 1L;
    public static Logger logger=LogManager.getLogger(DownloadServlet.class);
    
    private String contentType;
    private String enc="UTF-8";
    private String fileRoot;
    
    @Override
    public void init(ServletConfig config) throws ServletException {
        contentType = config.getInitParameter("contentType");
        fileRoot = config.getInitParameter("fileRoot");
    }

    @Override
    public void doGet(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        logger.debug("Do Get Method.");
        String fileName=req.getParameter("fileName");
        String filePath=fileRoot+File.separator+fileName;
        
        File downloadFile=new File(filePath);
        if (downloadFile.exists()) {
            logger.info("File exist");
            
            resp.setContentType(contentType);
            Long length=downloadFile.length();
            resp.setContentLength(length.intValue());
            fileName = URLEncoder.encode(downloadFile.getName(), enc);
            resp.addHeader("Content-Disposition", "attachment; filename=" + fileName);
            
            ServletOutputStream servletOutputStream=resp.getOutputStream();
            FileInputStream fileInputStream=new FileInputStream(downloadFile);
            BufferedInputStream bufferedInputStream=new BufferedInputStream(fileInputStream);
            int size=0;
            byte[] b=new byte[4096];
            while ((size=bufferedInputStream.read(b))!=-1) {
                logger.info("write to output stream..");
                servletOutputStream.write(b, 0, size);
            }
            servletOutputStream.flush();
            servletOutputStream.close();
            bufferedInputStream.close();
        }else {
            logger.info("File is not exist");
        }
    }

}

解釋：

1、contentType用於定義用戶的瀏覽器如何顯示將要加載的數據，或者如何處理將要加載的數據。如網頁的contentType是text/html，jpeg圖片的contentType是image/jpeg。如果不知道文件類型，可以設置為二進制流文件 application/octet-stream

2、contentType和fileRoot（待下載文件的目錄）通過web.xml配置。

3、resp.setContentType()、resp.setContentLength()、resp.addHeader("Content-Disposition", "attachment; filename=" + fileName); 三個調用設置一些必要的響應報頭（reponse header）。

 

運行結果：

1、瀏覽器地址欄輸入：http://localhost:8080/test/download?fileName=test.mkv　　回車（文件“d:/test.mkv”的大小為700M）

2、瀏覽器彈出下載提示窗口，但未點擊保存。控制台先打印幾條日志，然后停滯，說明已經向輸出流寫入了4kB左右（程序中byte數組的大小為4096B）的數據了。

3、選擇保存位置后，點擊保存。此時控制台開始瘋狂地輸出log。。。

4、最后下載完成，此次Request結束。

小結：

　　文件下載的原理非常簡單，就是把數據從一個輸入流中讀出數據，再寫入一個輸出流。這里的輸入流是FileInputStream（為了提高速度，對其包裝了一個裝飾類BufferedInputStream，以提供緩沖功能），輸出流是ServletOutputStream。

　　源碼中的定義，public abstract class ServletOutputStream extends OutputStream。說明ServletOutputStream繼承了OutputStream，它和FileOutputStream等輸出流是一樣的。