文件下載是項目中常見的需求,今天推薦大家看看這篇文章,帶你了解文件下載的幾種方式。
以下是正文:
前端涉及到的文件下載還是很多應用場景的,那么前端文件下載有多少種方式呢?每種方式有什么優缺點呢?下面就來一一介紹。
1. a 標簽
通過a
標簽的download
屬性來實現文件下載,這種方式是最簡單的,也是我們比較常用的方式,先來看示例代碼:
<a href="http://www.baidu.com" download="baidu.html">下載</a>
就上面的這個示例,我們點擊下載,發現是跳轉到了百度的首頁,并沒有真的下載文件。
因為a
標簽下載只能下載同源的文件,如果是跨域的文件,這里包括圖片、音視頻等媒體文件,都是預覽,也無法下載。
上面的代碼是直接通過書寫a
標簽來實現文件下載,我們也可以通過js
來實現,代碼如下:
const a = document.createElement('a')
a.href = 'http://www.baidu.com'
a.download = 'baidu.html'
a.click()
效果和上面的一樣,都是跳轉到百度的首頁,沒有下載文件。
這里的重點是a
標簽的download
屬性,這個屬性是HTML5
新增的。
它的作用是指定下載的文件名,如果不指定,那么下載的文件名就會根據請求內容的Content-Disposition
來確定,如果沒有Content-Disposition
,那么就會使用請求的URL
的最后一部分作為文件名。
2. window.open
上面使用a
標簽的案例也可以通過window.open
來實現,效果是一樣的,代碼如下:
window.open('http://www.baidu.com', '_blank')
這里的_blank
是指定打開的方式,如果不指定,那么就會在當前頁面打開,這里指定_blank
,就是在新的頁面打開。
同樣a
標簽的download
屬性也是可以使用的,代碼如下:
window.open('http://www.baidu.com', '_blank', 'download=baidu.html')
當然這種方式也是有缺陷的,對比于a
標簽,這種方式不能下載.html
、.htm
、.xml
、.xhtml
等文件,因為這些文件會被當成html
文件來處理,所以會直接在當前頁面打開。
同樣也不能下載跨域的文件,畢竟是window.open
,不是window.download
(window.download
是假想)。
3. location.href
這種方式和window.open(url)
是一樣的,代碼如下:
location.href = 'http://www.baidu.com'
這種方式擁有window.open
的所有缺陷,所以不推薦使用,這里只當作了解,所以不做過多的講解。
4. location.?其他屬性
這里的其他指代的都是能跳轉頁面的屬性,比如location.assign
、location.replace
、location.reload
等,這些屬性都是可以實現文件下載的,代碼如下:
location.assign('http://www.baidu.com')
location.replace('http://www.baidu.com')
location.reload('http://www.baidu.com')
這里的location.reload
是有點特殊的,它的作用是重新加載當前頁面,但是它也可以接受一個參數,這個參數就是要跳轉的頁面,所以也可以實現文件下載。
當然同location.href
一樣,這些方式的缺點都一樣,同時還有屬于每個屬性自身的特性,這里只當拓展知識,不做過多的講解。
5. XMLHttpRequest
這種方式就是我們常說的ajax
下載,包括axios
、fetch
等都是相同的,代碼如下:
const xhr = new XMLHttpRequest()
xhr.responseType = 'blob'
xhr.open('GET', 'http://www.baidu.com')
xhr.send()
xhr.onload = function () {
const blob = new Blob([xhr.response], { type: 'text/html' })
const a = document.createElement('a')
a.href = URL.createObjectURL(blob)
a.download = 'baidu.html'
a.click()
}
這里就不講和XMLHttpRequest
相關的知識了,只講和文件下載相關的部分。
這里主要的邏輯是當我們的請求成功后,我們會拿到響應體的response
,這個response
就是我們要下載的內容,然后我們把它轉換成blob
對象,然后通過URL.createObjectURL
來創建一個url
,然后通過a
標簽的download
屬性來實現文件下載。
這里的知識點就有兩個,一個是blob
對象,一個是URL.createObjectURL
。
注意:使用xhr
請求需要設置responseType
為blob
,否則下載下來的文件是亂碼,無法正常解析。
上面的代碼可以在任意站點測試,如果需要下載圖片,注意修改blob
的type
屬性,如果沒有跨域的問題應該都是可以的。
5.1 blob
Blob
對象表示一個不可變、原始數據的類文件對象。它的數據可以按文本或二進制的格式進行讀取,也可以轉換成 ReadableStream
來用于數據操作。
Blob
表示的不一定是JavaScript
原生格式的數據。File
接口基于 Blob
,繼承了blob
的功能并將其擴展以支持用戶系統上的文件。
blob
對象是html5
新增的對象,它的作用是用來存儲二進制數據的,比如圖片、視頻、音頻等,它的使用方法如下:
/**
* @param {Array} array 二進制數據
* @param {Object} options 配置項
* @param {String} options.type 文件類型,它代表了將會被放入到 blob 中的數組內容的 MIME 類型。
* @param {String} options.endings 用于指定包含行結束符\n的字符串如何被寫入。默認為transparent,表示不會修改行結束符。還可以指定為native,表示會將\n轉換為\r\n。
*/
const blob = new Blob([], { type: '' })
這里主要關注的是type
屬性,默認情況下,blob
對象是沒有type
屬性的,那么這個Blob
就是一個無類型的Blob
,文件不會損毀,但是無法被正常識別。
5.2 URL.createObjectURL
下面來自MDN:
URL.createObjectURL() 靜態方法會創建一個 DOMString,其中包含一個表示參數中給出的對象的 URL。這個 URL 的生命周期和創建它的窗口中的 document 綁定。這個新的 URL 對象表示指定的 File 對象或 Blob 對象。
這個方法是用來創建一個url
的,它的作用是把一個blob
對象轉換成一個url
,這個url
可以用來下載文件,也可以用來預覽文件,代碼如下:
const url = URL.createObjectURL(blob)
這里需要注意的是,這個url
的生命周期和創建它的窗口中的document
綁定,也就是說,當我們的document
被銷毀后,這個url
就會失效,所以我們需要在合適的時機銷毀它,代碼如下:
URL.revokeObjectURL(url)
回到我們剛才下載的問題,我們是通過blob
對象來解決,但是我們的type
屬性是寫死的,如果在文件類型是確定的情況下是沒問題的,但是如果這個接口就是下載文件的接口,文件可能是各種類型的,我們應該怎么處理?
這里的沒有正確答案,第一個可以和接口提供者進行協商,協商方案是不確定的,第二就是通過response
的header
來獲取文件的type
,也是我們要講的:
const type = response.headers['content-type']
const blob = new Blob([response.data], { type })
這里我們通過response
的header
來獲取type
,然后再創建blob
對象,這樣就可以正確的下載文件了。
其實content-type
也可能是application/octet-stream
,這個時候我們就需要通過file-type
來獲取文件的type
了。
下面的代碼是通過file-type
來獲取文件的type
:
import {fileTypeFromStream} from 'file-type';
const type = await fileTypeFromStream(response.body);
const blob = new Blob([response.data], { type })
6. 總結
上面的方案這么多,其實最終還是落到a
標簽上,所以不管是通過瀏覽器的內置行為進行下載,還是通過ajax
進行下載,文件下載的最終還是瀏覽器的行為。
本文轉自 https://juejin.cn/post/7156427561302982670
如有侵權,請聯系刪除。
該文章在 2025/1/2 17:21:15 編輯過