前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Projects: 前端怎么处理二进制文件下载

Projects: 前端怎么处理二进制文件下载

作者头像
西南_张家辉
发布2021-02-02 10:15:09
8970
发布2021-02-02 10:15:09
举报
文章被收录于专栏:张家辉的树屋

前言

  • 有这样需求,需要下载一个 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中保存的结束符不变

代码语言:javascript
复制
var debug = {hello: "world"};
var blob = new Blob([JSON.stringify(debug, null, 2)],
  {type : 'application/json'});
  
// 得到一个 blob

downloadFile 函数

  • 接口返回的 ArrayBuffer 对象
image
image
  • 主要界面概况
image
image

下面就开始来写主要的代码吧

  • html
代码语言:javascript
复制
<button onclick="downloadFile(API.getExcel(),{ excel_name: '数据表单' })">点击下载button>

复制代码
  • js
代码语言:javascript
复制
 /**
  * @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')
        });
}
 
复制代码
  • 下载文件如下图
image
image

怎么处理文件流接口返回的错误啦?

  • 主要问题:因为接口返回的是 ArrayBuffer 格式,我们这里需要判断一下返回的 data 有没有 byteLength,如果有的话,我们使用如下的方面把数据转换成一个正常的 json 格式,然后就可以正常的弹出 error.error_message
代码语言:javascript
复制
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))) || {};
}

参考

)

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 先了解一下URL.createObjectURL(object)方法 和 blob 对象
    • createObjectURL
    • blob
    • downloadFile 函数
    • 怎么处理文件流接口返回的错误啦?
    • 参考
    领券
    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档