JS實(shí)現(xiàn)單個(gè)或多個(gè)文件批量下載的方法詳解
前言
在前端Web開發(fā)中,下載文件是一個(gè)很常見的需求,也有一些比較特殊的Case,比如下載文件請求是一個(gè)POST、url不是同源的、批量下載文件等。本文就介紹下幾種download解決方案,以及特殊Case的最佳方案選擇。
單個(gè)文件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.瀏覽器會(huì)根據(jù)header
的content-type
來判斷是下載文件還是預(yù)覽文件。
比如 txt
png
等格式文件,會(huì)在當(dāng)前tab或新tab中預(yù)覽,而不是下載下來。
3.由于只支持get,會(huì)有url參數(shù)過長問題。
4.不能加request header
,無法做權(quán)限驗(yà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):
- 都是走的瀏覽器下載文件邏輯,不會(huì)預(yù)覽文件。
- 當(dāng)前tab打開方式下載。
- 支持設(shè)置file name。
缺點(diǎn):
- 只支持get請求,不支持post請求。
- 不能加
request header
,無法做權(quán)限驗(yàn)證等邏輯。 - 不支持跨域地址。
方案三:API請求
API發(fā)送請求的方式,獲取文件blog
對象,然后通過URL.createObjectURL
方法獲取download url,然后用方案二的<a download />
方式下載。
// 封裝一個(gè)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如果過多會(huì)有效率問題,可以在合適的時(shí)機(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àn)樽詈笥玫氖欠桨付詽M足方案二的優(yōu)點(diǎn)。
- 支持post請求、支持跨域(fetch本身支持)。
- 可以加
request header
。
缺點(diǎn):
- 低版本瀏覽器不支持,可以通過
'download' in document.createElement('a')
判斷是否支持。 - 瀏覽器兼容可能有問題,比如Safari、IOS Safari。
多個(gè)文件批量Download
有些需求是,點(diǎn)一個(gè)按鈕需要把多個(gè)文件同時(shí)download下來,有以下幾個(gè)方案可以實(shí)現(xiàn)。
方案一:按單個(gè)文件download方式,循環(huán)依次下載
downloadFile("/files/file1.txt", "file1.txt"); downloadFile("/files/word1.docx", "word1.docx"); downloadFile("/files/img1.jpg", "img1.jpg");
利用上面的方案二的<a download />
方式下載,會(huì)觸發(fā)瀏覽器是Download multiple files
提示,如果選了Allow
則會(huì)正常下載。
嘗試每個(gè)download之間加延遲,依然會(huì)彈提示。這個(gè)應(yīng)該是瀏覽器機(jī)制問題了,沒辦法避免了。
方案二:前端打包成zip download
前端可以通過一個(gè)第三方庫 jszip
,可以把多個(gè)文件以blob、base64或純文本等形式,按自定義的文件結(jié)構(gòu),壓縮成一個(gè)zip文件,然后通過瀏覽器download下來。
官網(wǎng):stuk.github.io/jszip/ 用法不難,直接看code:
// 先封裝一個(gè)方法,請求返回文件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類型,需要返回?cái)?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
由于走的是純前端壓縮,所以會(huì)有延遲問題,走到最后download時(shí)才會(huì)調(diào)起瀏覽器下載,所以頁面可能需要一個(gè)效果來更新壓縮進(jìn)度。zip.generateAsync
方法就支持第二個(gè)參數(shù),支持進(jìn)度更新:
zip.generateAsync({ type: "blob" }, metadata => { const progress = metadata.percent.toFixed(2); // 保留2位小數(shù) console.log(metadata.currentFile, "progress: " + progress + " %"); }).then(blob => ... );
方案三:后端壓縮成zip,然后以文件流url形式,前端調(diào)用download
后臺(tái)加個(gè)api,然后把需要download的文件在后臺(tái)壓縮成zip,然后把文件流輸出出來。然后就和單個(gè)文件download一樣了。
因?yàn)楹笈_(tái)會(huì)先壓縮,會(huì)有延遲才會(huì)把blob返回前臺(tái),而且需要傳多個(gè)文件信息,一般是post請求,所以建議使用單個(gè)文件下載的方案三通過API請求實(shí)現(xiàn),在請求前后加上提示語或loading效果。
總結(jié)
本文介紹了前端單個(gè)文件的下載方案,以及批量多個(gè)文件下載的解決方案。最后整理下方案建議:
單個(gè)文件下載:
- 如果url是同源的,并且是一個(gè)服務(wù)器上的靜態(tài)文件路徑、或者是一個(gè)get請求,推薦方案二即
<a download />
方式下載。 - 反之,方案三即API請求方式。
批量文件下載:
- 如果有zip壓縮需求,選方案二或方案三;
- 如果可以接受彈
Download multiple files
提示,用方案一;反之方案二或方案三;
以上就是JS實(shí)現(xiàn)單個(gè)或多個(gè)文件批量下載的方法詳解的詳細(xì)內(nèi)容,更多關(guān)于JS文件批量下載的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
移動(dòng)端觸屏幻燈片圖片切換插件idangerous swiper.js
這篇文章主要為大家詳細(xì)介紹了移動(dòng)端觸屏幻燈片圖片切換插件idangerous swiper.js的使用方法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-04-04JavaScript簡單實(shí)現(xiàn)彈出拖拽窗口(二)
這篇文章再次為大家詳細(xì)介紹了JavaScript簡單實(shí)現(xiàn)彈出拖拽窗口的相關(guān)資料,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-06-06個(gè)人總結(jié)的一些JavaScript技巧、實(shí)用函數(shù)、簡潔方法、編程細(xì)節(jié)
這篇文章主要介紹了個(gè)人總結(jié)的一些JavaScript技巧、實(shí)用函數(shù)、簡潔方法、編程細(xì)節(jié),本文講解了變量轉(zhuǎn)換、取整同時(shí)轉(zhuǎn)換成數(shù)值型、日期轉(zhuǎn)數(shù)值、類數(shù)組對象轉(zhuǎn)數(shù)組、進(jìn)制之間的轉(zhuǎn)換等方法技巧,需要的朋友可以參考下2015-06-06CocosCreator入門教程之網(wǎng)絡(luò)通信
這篇文章主要介紹了CocosCreator的網(wǎng)絡(luò)通信,內(nèi)容不多,涉及到的細(xì)節(jié),讀者可以根據(jù)實(shí)際情況,自己去延申2021-04-04JavaScript實(shí)現(xiàn)網(wǎng)站訪問次數(shù)統(tǒng)計(jì)代碼
每個(gè)網(wǎng)站管理者,都必須知道每天有多少人訪問了本站,需要一個(gè)網(wǎng)站訪問次數(shù)功能來滿足需求,本篇文章主要介紹了JavsScript實(shí)現(xiàn)網(wǎng)站訪問次數(shù)統(tǒng)計(jì)代碼,需要的朋友可以參考下2015-08-08詳解如何在微信小程序開發(fā)中正確的使用vant ui組件
這篇文章主要介紹了詳解如何在微信小程序開發(fā)中正確的使用vant ui組件,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-09-09Javascript-Mozilla和IE中的一個(gè)函數(shù)直接量的問題分析
Javascript-Mozilla和IE中的一個(gè)函數(shù)直接量的問題分析...2007-08-08javaScript 連接打印機(jī),打印小票的實(shí)例
下面小編就為大家分享一篇javaScript 鏈接打印機(jī),打印小票的實(shí)例,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2017-12-12