關于前端文件下載各類方式大匯總

更新時間：2022年08月03日 09:33:52 作者：前端@小菜

這篇文章主要介紹了關于前端文件下載各類方式大匯總，具有很好的參考價值，希望對大家有所幫助。

總結：下載文件的方式

a 標簽配置 download 屬性 (適用于下載一些靜態(tài)資源)
window.location.href (適用于下載一些靜態(tài)資源)
a 標簽 + Blob 方式
使用 form 表單提交

1.a 標簽配置 download 屬性

<a href="test.zip" rel="external nofollow"  download="test.zip">download</a>

download 用來命名下載文件，以及防止 txt , jpg , pdf 等瀏覽器支持直接打開的文件不能下載（需要注意的是，href地址不能寫完整的域名，否則只能預覽也不能下載。另外，下載的地址域名和訪問網(wǎng)站的域名必須是同源，否則 download 設置無效）。

2.window.location.href/window.open()

window.location.href = '你的 url';
// 或 
window.open('你的 url');

這種方式比較常見，比如我們在一些網(wǎng)站上下載電子書，安裝包之類的，一般都是這種方式或 a 標簽方式下載的。

3.<a> 標簽 + Blob方式

1.下載 api

export function downloadApi() {
  return request({
    url: '/testApi',
    method: 'get',
    responseType: 'blob'
  })
}

注：這里的 request 是用 axios 封裝的一個方法，詳情可見：vue開發(fā)中 axios 的封裝

2.項目下載操作代碼

    // vue 代碼
    downClick () {
      downloadApi().then(resBlob => {
        this._download(resBlob)
      })
    },
    _downloads (resBlob) {
      const projectName = '項目.zip'
      // IE|Edge
      if (window.navigator && window.navigator.msSaveOrOpenBlob) {
        window.navigator.msSaveBlob(resBlob, projectName)
      } else {
        // 其他瀏覽器
        const blobUrl = window.URL.createObjectURL(resBlob)
        const a = document.createElement('a')
        a.style.display = 'none'
        a.download = projectName
        a.href = blobUrl
        document.body.appendChild(a) // 兼容火狐
        a.click()
        document.body.removeChild(a)
        window.URL.revokeObjectURL(blobUrl)
      }
    },

這里我們使用了 a 標簽加 blob 的方式，這種方式適用于下載響應比較耗時的情況。它會提前將文件下載完成后，再由前端進行下載。比如，后端在下載前需要進行一系列耗時操作來生成下載文件，這會讓用戶誤以為沒有正確點擊下載而重復點擊下載按鈕。通過這種方式我們可以做一些loading 之類的處理。

當然，如果不需要 loading 之類的處理，可以直接通過 a 標簽點擊下載，而無需 blob 方式。

注意：

上面這個 blob 方式在我們下載失敗時仍然會下載文件，當我們要處理后端拋出的錯誤信息時，就行不通了。解決方法兩種：

3.1. 使用 Response（IE不支持）

    downClick () {
      downloadApi().then(async resBlob => {
        let resObj = {}
        if (resBlob.size == 0) {
          // 沒有數(shù)據(jù)可導出
        } else if (resBlob.type == 'application/json') {
          // 返回(錯誤)信息
          resObj = await (new Response(resBlob)).text()
          // 得到錯誤信息
          resObj = JSON.parse(resObj)
        }
        // ... 相關判斷處理
        this._download(resBlob)
      })
    },

3.2. 使用 FileReader

    downClick () {
      downloadApi().then(resBlob => {
        let resObj = {}
        if (resBlob.size == 0) {
          // 沒有數(shù)據(jù)可導出
        } else if (resBlob.type == 'application/json') {
          // 返回(錯誤)信息
          const reader = new FileReader()
          reader.addEventListener('loadend', () => {
            // reader.result 包含被轉化為一個字符串內容的 blob
            resObj = JSON.parse(reader.result)
            if (/* 是錯誤信息 */) {
              // 相關判斷處理
            }
          })
          reader.readAsText(resBlob)
        } else {
          this._download(resBlob)
        }
      })
    },

4.使用 form 表單提交

  /**
   * 使用 form-data -post 方式導出文件
   * @param url 導出地址
   * @param params 參數(shù)
   */
  const postFormDataFile = (url, params) => {
    const form = document.createElement('form')
    form.style.display = 'none'
    form.action = BASE_URL + url
    form.method = 'post'
    document.body.appendChild(form)
    // 動態(tài)創(chuàng)建 input 并給 value 賦值
    for (const key in params) {
      const input = document.createElement('input')
      input.type = 'hidden'
      input.name = key
      input.value = params[key]
      form.appendChild(input)
    }
    form.submit()
    form.remove()
  }

注意：傳給后端的參數(shù)不是 json 對象的形式，而是 currentPage=2&pageSize=20 形式。

5.實現(xiàn)下載進度條

原理：設置 onDownloadProgress 事件

export function downloadProject(projectId) {
  return request({
    url: downloadProjectUrl + projectId,
    method: 'get',
    responseType: 'blob',
    onDownloadProgress: function (event) {
      // 注意: 后端需要設置響應頭 Content-Length, 否則 event.lengthComputable 就會為 false, event.total 為 0
      // event.loaded 得到當前已加載的數(shù)據(jù)大小, event.total 拿到總的數(shù)據(jù)大小, 通過兩者的比值就知道其進度。
      console.log('event', event)
    }
  })
}

event 參數(shù)內容如下：