前言
- 有這樣需求，需要下載一個 excel 表格。
- 主要是後端渲染一個 excel 格式的二進位制檔案，介面返回一個 ArrayBuff(一個陣列二進位制物件) 型別的檔案，然後前端提供使用者下載。
- 後端不能直接提供下載的連結，有 token 的保護，我們前端需要進行一下額外的處理。
先了解一下URL.createObjectURL(object)方法 和 blob 物件
createObjectURL
objectURL = URL.createObjectURL(object);
- 用於建立 URL 的 File 物件、Blob 物件或者 MediaSource 物件。
blob
- 什麼是 blob 物件?
- Blob（Binary Large Object）物件代表了一段二進位制資料，提供了一系列操作介面。其他操作二進位制資料的 API（比如 File 物件），都是建立在 Blob 物件基礎上的，繼承了它的屬性和方法。
var aBlob = new Blob( array, options );
-
array是一個由ArrayBuffer, ArrayBufferView, Blob, DOMString 等物件構成的 Array ，或者其他類似物件的混合體，它將會被放進 Blob。DOMStrings會被編碼為UTF-8。 -
options是一個可選的BlobPropertyBag字典，它可能會指定如下兩個屬性： type，預設值為 ""，它代表了將會被放入到blob中的陣列內容的MIME型別。 endings，預設值為"transparent"，用於指定包含行結束符\n的字串如何被寫入。 它是以下兩個值中的一個： "native"，代表行結束符會被更改為適合宿主作業系統檔案系統的換行符，或者 "transparent"，代表會保持blob中儲存的結束符不變
var debug = {hello: "world"};
var blob = new Blob([JSON.stringify(debug, null, 2)],
{type : 'application/json'});
// 得到一個 blob
複製程式碼downloadFile 函式
- 介面返回的 ArrayBuffer 物件
- 主要介面概況
下面就開始來寫主要的程式碼吧
- html
<button onclick="downloadFile(API.getExcel(),{ excel_name: '資料表單' })">點選下載</button>
複製程式碼- js
/**
* @param {*} apiUrl // api 地址
* @param {*} params // 配置項
* @param {*} blobType // 檔案型別，你可以和後端對接傳入合理的 type
* @param {*} fileSuffix // 檔案字尾，具體的字尾視需求而定
*/
function downloadFile(apiUrl, params = { excel_name: 'data' }, blobType = 'application/ynd.ms-excel;charset=UTF-8',excelTypeSuffix:string = 'xls') {
if (!apiUrl) {
console.error('please input API URL!');
return;
}
// 這裡示例使用 axios，apiUrl 為後端提供的相關介面
return axios
.get(apiUrl, {
params,
responseType: 'arraybuffer'
})
.then(
resp => {
// 先把後端返回的 resp 包裝成一個 Blob 型別
let localHref = window.URL.createObjectURL(
new Blob([resp], { type: blobType })
);
// 建立一個 a 標籤用來下載檔案
let ele = document.createElement('a');
ele.href = localHref;
// download 屬性決定下載的檔案的名字
ele.download = `${params.excel_name}.${excelTypeSuffix}`;
document.querySelectorAll('body')[0].appendChild(ele);
ele.click();
// 主動移除這個 a 標籤,來釋放記憶體
setTimeout(() => {
ele.remove();
}, 1000);
},
err => {
console.error(err);
}
)
.finally(() => {
console.log('end')
});
}
複製程式碼- 下載檔案如下圖
怎麼處理檔案流介面返回的錯誤啦？
- 主要問題：因為介面返回的是 ArrayBuffer 格式，我們這裡需要判斷一下返回的 data 有沒有 byteLength，如果有的話，我們使用如下的方面把資料轉換成一個正常的 json 格式，然後就可以正常的彈出 error.error_message
let data = response.data
// 處理responseType: 'arraybuffer'錯誤
if (data && data.byteLength) {
var enc = new TextDecoder('utf-8');
data = JSON.parse(enc.decode(new Uint8Array(response.data))) || {};
}
複製程式碼- 具體使用參考 MDN 吧
- developer.mozilla.org/zh-CN/docs/…