DIV CSS 佈局教程網

基於 Blob 的 Ajax 檔案下載與進度條實作
編輯:AJAX基礎知識     

瀏覽器原生的下載方式

在 Web 開發中,要實作下載功能,最常見的做法是新開一個視窗或塞一個隱藏的 iframe:

<a target="_blank" href="download.zip">點擊下載</a>

<!-- 或者 -->
<iframe style="display:none" src="download.zip"></iframe>

使用者點擊後,瀏覽器收到帶有附件標頭的回應,就會跳出下載提示框。所謂附件下載,就是瀏覽器讀到回應標頭之後產生提示框,使用者確認後繼續接收檔案。檔案本質上是一個資料流,瀏覽器會自動管理這個傳輸過程,自動產生進度條、暫停、繼續、取消、已下載位元組數等 UI——這些都是瀏覽器幫我們做的,整個過程我們無法介入。

為什麼要用 Ajax 下載

瀏覽器的下載支援其實已經能滿足大多數情境,一般情況下探索別的做法意義不大。但有些需求是原生下載做不到的:

  • 要監控下載進度,例如太慢時主動提供替代方案。
  • 下載完成後要觸發特定事件。
  • 程式要能主動取消下載。
  • 想用 Web Worker 在背景執行下載。

這些情況就可以採用基於 Blob 的 Ajax 下載。

Ajax 下載的關鍵設定

Ajax 下載與上傳一樣,需要瀏覽器支援 Ajax 2.0(即 XMLHttpRequest 的進階 API)。本質上,下載跟一般 Ajax 請求沒有兩樣,都是對某個 URL 發請求;差別在於下載的是二或多同位元檔案,而不是文字或 JSON,因此需要一个能承載二進位資料的型別——這就是 Blob。做法是把 responseType 設為 'blob':

var xhr = new XMLHttpRequest();
xhr.open(option.type ? option.type.toUpperCase() : 'GET', url, true);
xhr.responseType = 'blob';

Blob 物件是什麼

MDN 的描述是:Blob 物件是包含唯讀原始資料的類檔案物件。Blob 中的資料不一定是 JavaScript 的原生形式;File 介面基於 Blob,繼承了 Blob 的功能,並擴充支援使用者電腦上的本機檔案。透過 Blob,我們可以把一個二進位流封裝成一個物件。

如果你看過 HTML5 的 File 相關 API,對 Blob 應該不陌生。把 XHR 的 responseType 設為 blob,就能把回應本文當成 Blob 物件處理:

xhr.onload = function () {
    // 對於重定向的文件不予理會
    if (this.status >= 200 && this.status < 300) {
        var blob = new Blob([this.response], { type: this.response.type });
    }
};

把 Blob 存到硬碟

檔案已經下載並快取在瀏覽器記憶體中,怎麼讓使用者存到本機?做法是效仿瀏覽器:動態產生一個 a 標籤,用 URL.createObjectURL(blob) 產生一個虛擬 URL,觸發點擊,瀏覽器就會跳出另存新檔的視窗。

createObjectURL 支援 Blob 與 File,能產生一個讓當前頁面存取該物件的暫時網址。它與從伺服器下載不同——這是純用戶端的操作,不走網路 IO,所以幾乎是瞬間完成。用完之後要呼叫 URL.revokeObjectURL() 釋放,否則 Blob 資源不會被垃圾回收。IE 則有自己的策略:navigator.msSaveOrOpenBlob 與 msSaveBlob。

// IE 的下載
if (window.navigator.msSaveOrOpenBlob) {
    navigator.msSaveBlob(blob, fileName);
} else {
    // 非 IE 的下載
    var link = document.createElement('a');
    link.href = window.URL.createObjectURL(blob);
    link.download = fileName;
    link.click();
    window.URL.revokeObjectURL(link.href);
}

進度條與取消下載

XMLHttpRequest 本身就有 progress 事件,只是我們平常寫 Ajax 時都忽略它——畢竟一般請求是瞬間完成的。但下載附件需要時間,這時進度條就很有必要了。監聽 progress 事件即可取得已載入與總量:

xhr.onprogress = function (e) {
    if (e.lengthComputable) {
        var percent = Math.round((e.loaded / e.total) * 100);
        progressBar.style.width = percent + '%';
    }
};

// 取消下載
cancelButton.onclick = function () {
    xhr.abort();
};

xhr.onload = function () { /* 下載完成 */ };
xhr.onerror = function () { /* 下載失敗 */ };

也就是說,Ajax 下載所用的事件與方法,跟一個普通的 Ajax 請求完全一樣。

效能優化與同源政策

Ajax 下載和長連線一樣,會佔用比較多頻寬,下載大檔時尤其明顯,可能會阻塞其他 Ajax 請求。因此建議把可下載的資源放在與 API 不同的網域上——但這麼一來就會碰到同源政策。

同源政策是瀏覽器安全的基石,若沒有它,任何網站都能隨意發出跨站請求。當被請求的 URL 與當前頁面不同源時,就會被瀏覽器攔下,因此需要做 Ajax 跨域處理。相較之下,iframe 與新分頁的下載方式不受同源政策影響(iframe 雖也有同源限制,但下載不涉及讀取對方內容的操作),而 Ajax 下載本質上仍是 Ajax,所以會受限。若下載的是不同源的附件,就需要伺服器支援 CORS;如果需要帶 cookie,還要把 withCredentials 設為 true。

反過來說,我們通常不能用 Ajax 下載第三方資源,因為一般的下載服務不會特地做 CORS 處理。這大幅限制了 Ajax 下載的適用範圍。

總結:適用場景

  1. 需要監控下載進度的場景,例如發現速度過慢時主動提供其他方案。
  2. 需要在下載完成後觸發特定事件,例如跳出桌面通知(Notification)。
  3. 需要背景預先下載:使用者開啟網頁時先把附件抓下來快取,真正要下載時直接存到本機。搭配 Web Worker 還能避免影響頁面渲染。
  4. 下載後不落地,直接由 Web App 處理附件,例如 pdf.js 就是採用 Ajax 下載。

最後附上筆者實作的 Ajax 下載範例:ajaxDownloadDemo_jb51.rar。

以上就是本文的全部內容,希望對大家的學習有所幫助。

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