DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> JavaScript入門知識 >> AJAX入門 >> AJAX詳解
Ajax 搭配 JSF 自訂組件實作高效能檔案上傳(一):問題與過濾器設計
編輯:AJAX詳解     

一、引言

以瀏覽器進行檔案上傳——特別是透過 <input type="file"> 標籤實作的那種——一直存在嚴重的效能問題。超過 10MB 的檔案往往帶來非常痛苦的體驗:使用者一按下提交,瀏覽器在把檔案送到伺服器的過程中,畫面看起來就像卡住不動。因為一切都發生在背景,許多不耐煩的使用者會以為伺服器當機了,於是又按一次提交,情況自然越來越糟。

為了讓上傳感覺友善一些,很多網站會在上傳開始後顯示一段中間過程動畫(例如旋轉圖示)。這招聊勝於無,但提供的狀態資訊實在太少。另一種解法是做一個以 FTP 上傳的 applet,缺點是使用者必須有支援 Java 的瀏覽器。

本文要實作一個具備 Ajax 能力的組件,它不只把檔案上傳到伺服器,還能「即時」監看整個上傳過程。組件的四個階段如下:

圖 1. 階段 1:選擇檔案上傳

圖 2. 階段 2:上傳檔案到伺服器

圖 3. 階段 3:上傳完成

圖 4. 階段 4:檔案上傳摘要

二、實作該組件

先建立多部分過濾器,讓我們能攔截並監看檔案上傳;接著實作 JavaServer Faces 組件,以 Ajax 進度條的方式給使用者連續回饋。

(一)多部分過濾器:UploadMultipartFilter

過濾器的任務是攔截進來的檔案上傳,把檔案寫到伺服器的暫存目錄,同時統計已接收的位元組數以推算上傳進度。幸運的是 Jakarta-Commons 的 FileUpload 這套開源庫已經能勝任解析 HTTP 多部分請求並把檔案存到伺服器的工作,我們要做的只是擴充它、加上監視位元組數的「鉤子」。

public class UploadMultipartFilter implements Filter {
    public void doFilter(ServletRequest request, ServletResponse response,
                         FilterChain chain) throws IOException, ServletException {
        HttpServletRequest hRequest = (HttpServletRequest) request;
        // 判斷是否為多部分請求
        String contentHeader = hRequest.getHeader("content-type");
        boolean isMultipart = (contentHeader != null
            && contentHeader.indexOf("multipart/form-data") != -1);
        if (isMultipart == false) {
            chain.doFilter(request, response);
        } else {
            UploadMultipartRequestWrapper wrapper =
                new UploadMultipartRequestWrapper(hRequest);
            chain.doFilter(wrapper, response);
        }
    }
}

如你所見,過濾器只是檢查目前請求是否為多部分請求。若不含檔案上傳,就原封不動往下一個過濾器傳;否則包成 UploadMultipartRequestWrapper。

(二)UploadMultipartRequestWrapper 類別

public class UploadMultipartRequestWrapper extends HttpServletRequestWrapper {
    private Map<String, String> formParameters;
    private Map<String, FileItem> fileParameters;

    public UploadMultipartRequestWrapper(HttpServletRequest request) {
        super(request);
        try {
            ServletFileUpload upload = new ServletFileUpload();
            upload.setFileItemFactory(new ProgressMonitorFileItemFactory(request));
            List fileItems = upload.parseRequest(request);
            formParameters = new HashMap<String, String>();
            fileParameters = new HashMap<String, FileItem>();
            for (int i = 0; i < fileItems.size(); i++) {
                FileItem item = (FileItem) fileItems.get(i);
                if (item.isFormField() == true) {
                    formParameters.put(item.getFieldName(), item.getString());
                } else {
                    fileParameters.put(item.getFieldName(), item);
                    request.setAttribute(item.getFieldName(), item);
                }
            }
        } catch (FileUploadException fe) {
            // 請求逾時——使用者可能已跳到別的頁面
        }
    }
}

ServletFileUpload 負責解析請求並把檔案寫到伺服器的預設暫存目錄,它會為請求中的每個欄位建立一個 FileItem 實例(同時涵蓋檔案上傳與一般表單元素)。之後 FileItem 可用來取出提交欄位的屬性,或在檔案上傳的情況下取得底層暫存檔的 InputStream。總之,這個 wrapper 負責解析並把上傳的 FileItem 設為請求屬性,供 JSF 組件後續取用,而一般表單欄位的行為完全不受影響。

預設情況下,通用 FileUpload 庫用 DiskFileItem 處理檔案上傳。DiskFileItem 在管理整個暫存檔務上很好用,但對「這個檔案已經處理到哪裡」幾乎沒有支援。自 1.1 版起,FileUpload 允許開發者自訂建立 FileItem 的工廠,我們就用 ProgressMonitorFileItemFactory 與 ProgressMonitorFileItem 來接管預設行為並監看進度。

(三)ProgressMonitorFileItemFactory 類別

public class ProgressMonitorFileItemFactory extends DiskFileItemFactory {
    private File temporaryDirectory;
    private HttpServletRequest requestRef;
    private long requestLength;

    public ProgressMonitorFileItemFactory(HttpServletRequest request) {
        super();
        temporaryDirectory = (File) request.getSession().getServletContext()
            .getAttribute("javax.servlet.context.tempdir");
        requestRef = request;
        String contentLength = request.getHeader("content-length");
        if (contentLength != null) {
            requestLength = Long.parseLong(contentLength.trim());
        }
    }

    public FileItem createItem(String fieldName, String contentType,
                               boolean isFormField, String fileName) {
        if (isFormField == false) {  // 這必須是檔案上傳
            SessionUpdatingProgressObserver observer =
                new SessionUpdatingProgressObserver(fieldName, fileName);
            return new ProgressMonitorFileItem(fieldName, contentType, isFormField,
                fileName, 2048, temporaryDirectory, observer, requestLength);
        }
        return super.createItem(fieldName, contentType, isFormField, fileName);
    }

    public class SessionUpdatingProgressObserver implements ProgressObserver {
        private String fieldName;
        private String fileName;

        public void setProgress(double progress) {
            if (requestRef != null) {
                requestRef.getSession().setAttribute(
                    "FileUpload.Progress." + fieldName, progress);
                requestRef.getSession().setAttribute(
                    "FileUpload.FileName." + fieldName, fileName);
            }
        }
    }
}

Content-Length 標頭由瀏覽器設定,並被視為上傳檔案的精確長度。這種推算方式有個限制:瀏覽器只送出一個 Content-Length,不會因而不同檔案數而改變,因此若同一次請求中編碼了多個檔案,這個值就不精準。

除了建立 ProgressMonitorFileItem,工廠還註冊了一個 ProgressObserver,由 ProgressMonitorFileItem 在上傳過程中回報更新。我們用的實作(SessionUpdatingProgressObserver)會依提交欄位的 id,把進度百分比寫進使用者工作階段;接著 JSF 組件就能讀取這個值,把更新推送給使用者。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved