前端文件下載的正確打開方式

前端涉及到的文件下載還是很多應(yīng)用場景的,那么前端文件下載有多少種方式呢?每種方式有什么優(yōu)缺點呢?下面就來一一介紹。

1. a 標簽
通過a標簽的download屬性來實現(xiàn)文件下載,這種方式是最簡單的,也是我們比較常用的方式,先來看示例代碼:

<a download="baidu.html">下載</a>

就上面的這個示例,我們點擊下載,發(fā)現(xiàn)是跳轉(zhuǎn)到了百度的首頁,并沒有真的下載文件。

因為a標簽下載只能下載同源的文件,如果是跨域的文件,這里包括圖片、音視頻等媒體文件,都是預(yù)覽,也無法下載。

上面的代碼是直接通過書寫a標簽來實現(xiàn)文件下載,我們也可以通過js來實現(xiàn),代碼如下:

const a = document.createElement('a')
a.
a.download = 'baidu.html'
a.click()

效果和上面的一樣,都是跳轉(zhuǎn)到百度的首頁,沒有下載文件。

這里的重點是a標簽的download屬性,這個屬性是HTML5新增的。

它的作用是指定下載的文件名,如果不指定,那么下載的文件名就會根據(jù)請求內(nèi)容的Content-Disposition來確定,如果沒有Content-Disposition,那么就會使用請求的URL的最后一部分作為文件名。

2. window.open
上面使用a標簽的案例也可以通過window.open來實現(xiàn),效果是一樣的,代碼如下:

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.

這種方式擁有window.open的所有缺陷,所以不推薦使用,這里只當作了解,所以不做過多的講解。

4. location.?其他屬性
這里的其他指代的都是能跳轉(zhuǎn)頁面的屬性,比如location.assign、location.replace、location.reload等,這些屬性都是可以實現(xiàn)文件下載的,代碼如下:

location.assign('http://www.baidu.com')
location.replace('http://www.baidu.com')
location.reload('http://www.baidu.com')

這里的location.reload是有點特殊的,它的作用是重新加載當前頁面,但是它也可以接受一個參數(shù),這個參數(shù)就是要跳轉(zhuǎn)的頁面,所以也可以實現(xiàn)文件下載。

當然同location.href一樣,這些方式的缺點都一樣,同時還有屬于每個屬性自身的特性,這里只當拓展知識,不做過多的講解。

5. XMLHttpRequest
這種方式就是我們常說的ajax下載,包括axios、fetch等都是相同的,代碼如下:

const xhr = new XMLHttpRequest()
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相關(guān)的知識了,只講和文件下載相關(guān)的部分。

這里主要的邏輯是當我們的請求成功后,我們會拿到響應(yīng)體的response,這個response就是我們要下載的內(nèi)容,然后我們把它轉(zhuǎn)換成blob對象,然后通過URL.createObjectURL來創(chuàng)建一個url,然后通過a標簽的download屬性來實現(xiàn)文件下載。

這里的知識點就有兩個,一個是blob對象,一個是URL.createObjectURL。

5.1 blob
下面是blob對象的定義,來自MDN:

Blob對象表示一個不可變、原始數(shù)據(jù)的類文件對象。它的數(shù)據(jù)可以按文本或二進制的格式進行讀取,也可以轉(zhuǎn)換成 ReadableStream 來用于數(shù)據(jù)操作。

Blob表示的不一定是JavaScript原生格式的數(shù)據(jù)。File 接口基于 Blob,繼承了blob的功能并將其擴展以支持用戶系統(tǒng)上的文件。

blob對象是html5新增的對象,它的作用是用來存儲二進制數(shù)據(jù)的,比如圖片、視頻、音頻等,它的使用方法如下:

/**
 * @param {Array} array 二進制數(shù)據(jù)
 * @param {Object} options 配置項
 *      @param {String} options.type 文件類型,它代表了將會被放入到 blob 中的數(shù)組內(nèi)容的 MIME 類型。
 *      @param {String} options.endings 用于指定包含行結(jié)束符\n的字符串如何被寫入。默認為transparent,表示不會修改行結(jié)束符。還可以指定為native,表示會將\n轉(zhuǎn)換為\r\n。
 */
const blob = new Blob([], { type: '' })

這里主要關(guān)注的是type屬性,默認情況下,blob對象是沒有type屬性的,那么這個Blob就是一個無類型的Blob,文件不會損毀,但是無法被正常識別。






5.2 URL.createObjectURL
下面來自MDN:

URL.createObjectURL() 靜態(tài)方法會創(chuàng)建一個 DOMString,其中包含一個表示參數(shù)中給出的對象的 URL。這個 URL 的生命周期和創(chuàng)建它的窗口中的 document 綁定。這個新的 URL 對象表示指定的 File 對象或 Blob 對象。

這個方法是用來創(chuàng)建一個url的,它的作用是把一個blob對象轉(zhuǎn)換成一個url,這個url可以用來下載文件,也可以用來預(yù)覽文件,代碼如下:

const url = URL.createObjectURL(blob)

這里需要注意的是,這個url的生命周期和創(chuàng)建它的窗口中的document綁定,也就是說,當我們的document被銷毀后,這個url就會失效,所以我們需要在合適的時機銷毀它,代碼如下:

URL.revokeObjectURL(url)

回到我們剛才下載的問題,我們是通過blob對象來解決,但是我們的type屬性是寫死的,如果在文件類型是確定的情況下是沒問題的,但是如果這個接口就是下載文件的接口,文件可能是各種類型的,我們應(yīng)該怎么處理?

這里的沒有正確答案,第一個可以和接口提供者進行協(xié)商,協(xié)商方案是不確定的,第二就是通過response的header來獲取文件的type,也是我們要講的:

const type = response.headers['content-type']

const blob = new Blob([response.data], { type })

這里我們通過response的header來獲取type,然后再創(chuàng)建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 })

file-type的使用可以參考這里。

6. 總結(jié)
上面的方案這么多,其實最終還是落到a標簽上,所以不管是通過瀏覽器的內(nèi)置行為進行下載,還是通過ajax進行下載,文件下載的最終還是瀏覽器的行為。

作者:田八

鏈接:https://juejin.cn/post/7156427561302982670

作者:田八


歡迎關(guān)注微信公眾號 :深圳灣碼農(nóng)