JS實現單個或多個文件批量下載的方法詳解

Posted on by

前言

在前端Web開發中，下載文件是一個很常見的需求，也有一些比較特殊的Case，比如下載文件請求是一個POST、url不是同源的、批量下載文件等。本文就介紹下幾種download解決方案，以及特殊Case的最佳方案選擇。

單個文件Download

方案一：location.href or window.open

<a href={url} target="_blank">download</a>
window.location.href = url; // 當前tab
window.open(url); // 新tab

缺點：

1.隻支持get請求，不支持post請求。

2.瀏覽器會根據header的content-type來判斷是下載文件還是預覽文件。

比如 txt png 等格式文件，會在當前tab或新tab中預覽，而不是下載下來。

3.由於隻支持get，會有url參數過長問題。

4.不能加request header，無法做權限驗證等邏輯。

5.不支持自定義file name。

方案二：通過a標簽的download屬性

通過HTML a標簽的原生屬性，使用瀏覽器下載。

https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/a#attr-download

<a href={url} download={fileName}>download</a>

function downloadFile(url, fileName) {
    const a = document.createElement('a');
    a.style.display = 'none';
    a.href = url;
    a.download = fileName;
    document.body.appendChild(a);
    a.click();
    document.body.removeChild(a);
}

優點：

  • 都是走的瀏覽器下載文件邏輯，不會預覽文件。
  • 當前tab打開方式下載。
  • 支持設置file name。

缺點：

  • 隻支持get請求，不支持post請求。
  • 不能加request header，無法做權限驗證等邏輯。
  • 不支持跨域地址。

方案三：API請求

API發送請求的方式，獲取文件blog對象，然後通過URL.createObjectURL方法獲取download url，然後用方案二的<a download />方式下載。

// 封裝一個fetch download方法
async function fetchDownload(fetchUrl, method = "POST", body = null) {
    const response = await window.fetch(fetchUrl, {
        method,
        body: body ? JSON.stringify(body) : null,
        headers: {
            "Accept": "application/json",
            "Content-Type": "application/json",
            "X-Requested-With": "XMLHttpRequest",
        },
    });
    const fileName = getFileName(response);
    const blob = await response.blob();
    const url = URL.createObjectURL(blob);
    return { blob, url, fileName }; // 返回blob、download url、fileName
}
// 根據response header獲取文件名
function getFileName(response) {
    const disposition = response.headers.get('Content-Disposition');

    // 本例格式是："attachment; filename="img.jpg""
    let fileName = disposition.split('filename=')[1].replaceAll('"', '');

    // 可以根據自己的格式來截取文件名
    // 參考https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Content-Disposition
    // let fileName = '';
    // if (disposition && disposition.indexOf('attachment') !== -1) {
    //     const matches = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/.exec(disposition);
    //     fileName = matches?.[1]?.replace(/['"]/g, '');
    // }
    fileName = decodeURIComponent(fileName);
    return fileName;
}
// 頁面裡調用
// get
fetchDownload('/api/get/file?name=img.jpg', 'GET').then(({ blob, url, fileName }) => {
    downloadFile(url, fileName); // 調用方案二的download方法
});
// post
fetchDownload('/api/post/file', 'POST', { name: 'img.jpg' }).then(({ blob, url, fileName }) => {
    downloadFile(url, fileName);
});

URL.createObjectURL 生成的url如果過多會有效率問題，可以在合適的時機（download後）釋放掉。參考：developer.mozilla.org/zh-CN/docs/…

if (window.URL) {
    window.URL.revokeObjectURL(url);
} else {
    window.webkitURL.revokeObjectURL(url);
}

優點：

  • 因為最後用的是方案二，所以滿足方案二的優點。
  • 支持post請求、支持跨域（fetch本身支持）。
  • 可以加request header。

缺點：

  • 低版本瀏覽器不支持，可以通過'download' in document.createElement('a')判斷是否支持。
  • 瀏覽器兼容可能有問題，比如Safari、IOS Safari。

多個文件批量Download

有些需求是，點一個按鈕需要把多個文件同時download下來，有以下幾個方案可以實現。

方案一：按單個文件download方式，循環依次下載

downloadFile("/files/file1.txt", "file1.txt");
downloadFile("/files/word1.docx", "word1.docx");
downloadFile("/files/img1.jpg", "img1.jpg");

利用上面的方案二的<a download />方式下載，會觸發瀏覽器是Download multiple files提示，如果選瞭Allow則會正常下載。

嘗試每個download之間加延遲，依然會彈提示。這個應該是瀏覽器機制問題瞭，沒辦法避免瞭。

方案二：前端打包成zip download

前端可以通過一個第三方庫 jszip，可以把多個文件以blob、base64或純文本等形式，按自定義的文件結構，壓縮成一個zip文件，然後通過瀏覽器download下來。

官網：stuk.github.io/jszip/ 用法不難，直接看code：

// 先封裝一個方法，請求返回文件blob
async function fetchBlob(fetchUrl, method = "POST", body = null) {
    const response = await window.fetch(fetchUrl, {
        method,
        body: body ? JSON.stringify(body) : null,
        headers: {
            "Accept": "application/json",
            "Content-Type": "application/json",
            "X-Requested-With": "XMLHttpRequest",
        },
    });
    const blob = await response.blob();
    return blob;
}

const zip = new JSZip();
zip.file("Hello.txt", "Hello World\n"); // 支持純文本等

zip.file("img1.jpg", fetchBlob('/api/get/file?name=img.jpg', 'GET')); // 支持Promise類型，需要返回數據類型是 String, Blob, ArrayBuffer, etc
zip.file("img2.jpg", fetchBlob('/api/post/file', 'POST', { name: 'img.jpg' })); // 同樣支持post請求，隻要返回類型正確就行

const folder1 = zip.folder("folder01"); // 創建folder
folder1.file("img3.jpg", fetchBlob('/api/get/file?name=img.jpg', 'GET')); // folder裡創建文件

zip.generateAsync({ type: "blob" }).then(blob => {
    const url = window.URL.createObjectURL(blob);
    downloadFile(url, "test.zip");
});

jszip還支持一些別的類型文件壓縮，比如純文本、base64、binary等等，詳見：https://stuk.github.io/jszip/documentation/api_jszip/file_data.html

由於走的是純前端壓縮，所以會有延遲問題，走到最後download時才會調起瀏覽器下載，所以頁面可能需要一個效果來更新壓縮進度。zip.generateAsync方法就支持第二個參數，支持進度更新：

zip.generateAsync({ type: "blob" }, metadata => {
    const progress = metadata.percent.toFixed(2); // 保留2位小數
    console.log(metadata.currentFile, "progress: " + progress + " %");
}).then(blob => ... );

方案三：後端壓縮成zip，然後以文件流url形式，前端調用download

後臺加個api，然後把需要download的文件在後臺壓縮成zip，然後把文件流輸出出來。然後就和單個文件download一樣瞭。

因為後臺會先壓縮，會有延遲才會把blob返回前臺，而且需要傳多個文件信息，一般是post請求，所以建議使用單個文件下載的方案三通過API請求實現，在請求前後加上提示語或loading效果。

總結

本文介紹瞭前端單個文件的下載方案，以及批量多個文件下載的解決方案。最後整理下方案建議：

單個文件下載：

  • 如果url是同源的，並且是一個服務器上的靜態文件路徑、或者是一個get請求，推薦方案二即 <a download />方式下載。
  • 反之，方案三即API請求方式。

批量文件下載：

  • 如果有zip壓縮需求，選方案二或方案三;
  • 如果可以接受彈Download multiple files提示，用方案一；反之方案二或方案三;

以上就是JS實現單個或多個文件批量下載的方法詳解的詳細內容，更多關於JS文件批量下載的資料請關註WalkonNet其它相關文章！

推薦閱讀：