JS實現(xiàn)單個或多個文件批量下載的方法詳解

更新時間：2023年02月28日 11:36:30 作者：Mark大熊

在前端Web開發(fā)中，下載文件是一個很常見的需求。這篇文章就來和大家介紹下幾種download解決方案，以及特殊Case的最佳方案選擇，希望對大家有所幫助

前言

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

單個文件Download

方案一：location.href or window.open

<a href={url} target="_blank">download</a>

window.location.href = url; // 當(dāng)前tab
window.open(url); // 新tab

缺點(diǎn)：

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

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

比如 txt png 等格式文件，會在當(dāng)前tab或新tab中預(yù)覽，而不是下載下來。

3.由于只支持get，會有url參數(shù)過長問題。

4.不能加request header，無法做權(quán)限驗證等邏輯。

5.不支持自定義file name。

方案二：通過a標(biāo)簽的download屬性

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

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);
}

優(yōu)點(diǎn)：

都是走的瀏覽器下載文件邏輯，不會預(yù)覽文件。
當(dāng)前tab打開方式下載。
支持設(shè)置file name。

缺點(diǎn)：

只支持get請求，不支持post請求。
不能加request header，無法做權(quán)限驗證等邏輯。
不支持跨域地址。

方案三：API請求

API發(fā)送請求的方式，獲取文件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
}
// 根據(jù)response header獲取文件名
function getFileName(response) {
    const disposition = response.headers.get('Content-Disposition');

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

    // 可以根據(jù)自己的格式來截取文件名
    // 參考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;
}

// 頁面里調(diào)用
// get
fetchDownload('/api/get/file?name=img.jpg', 'GET').then(({ blob, url, fileName }) => {
    downloadFile(url, fileName); // 調(diào)用方案二的download方法
});
// post
fetchDownload('/api/post/file', 'POST', { name: 'img.jpg' }).then(({ blob, url, fileName }) => {
    downloadFile(url, fileName);
});

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

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

優(yōu)點(diǎn)：

因為最后用的是方案二，所以滿足方案二的優(yōu)點(diǎn)。
支持post請求、支持跨域（fetch本身支持）。
可以加request header。

缺點(diǎn)：

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

多個文件批量Download

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

方案一：按單個文件download方式，循環(huán)依次下載

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

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

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

方案二：前端打包成zip download

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

官網(wǎng)：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類型，需要返回數(shù)據(jù)類型是 String, Blob, ArrayBuffer, etc
zip.file("img2.jpg", fetchBlob('/api/post/file', 'POST', { name: 'img.jpg' })); // 同樣支持post請求，只要返回類型正確就行

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

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時才會調(diào)起瀏覽器下載，所以頁面可能需要一個效果來更新壓縮進(jìn)度。zip.generateAsync方法就支持第二個參數(shù)，支持進(jìn)度更新：

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