前端利用Blob对象创建指定文件并下载

最新推荐文章于 2023-12-11 10:10:09 发布

何以为皇

最新推荐文章于 2023-12-11 10:10:09 发布

阅读量1.6k

点赞数

分类专栏： js 文章标签： javascript

原文链接：https://segmentfault.com/a/1190000015026760?utm_source=sf-related

版权

js 专栏收录该内容

10 篇文章 0 订阅

订阅专栏

一、Blob对象

Blob对象表示一个不可变、原始数据的类文件对象。Blob 表示的不一定是JavaScript原生格式的数据。File接口基于Blob，继承了blob的功能并将其扩展使其支持用户系统上的文件。

构造函数

var aBlob = new Blob( array, options );

array
是一个由ArrayBuffer（二进制数据缓冲区）、ArrayBufferView（二进制数据缓冲区的array-like视图）、Blob、DOMString等对象构成的Array，或者其他类似对象的混合体，它将会被放进Blob。DOMStrings会被编码为UTF-8。
options 是可选的，它可能会指定如下两个属性：

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'});

二、URL对象

通过创建URL对象指定文件的下载链接。

构造函数

创建新的URL表示指定的File对象或者Blob对象。

objectURL = window.URL.createObjectURL(blob);

window.URL.revokeObjectURL()

在每次调用createObjectURL方法时，都会创建一个新的 URL 对象，即使你已经用相同的对象作为参数创建过。当不再需要这些 URL 对象时，每个对象必须通过调用 URL.revokeObjectURL方法来释放。浏览器会在文档退出的时候自动释放它们，但是为了获得最佳性能和内存使用状况，你应该在安全的时机主动释放掉它们。

window.URL.revokeObjectURL(objectURL);

三、利用`<a>`标签下载

生成一个<a>标签。

const link = document.createElement('a');

href属性指定下载链接

link.href = window.URL.createObjectURL(blob);

dowload属性指定文件名

download 属性规定被下载的超链接目标。在标签中必须设置 href 属性。该属性也可以设置一个值来规定下载文件的名称。所允许的值没有限制，浏览器将自动检测正确的文件扩展名并添加到文件 (.img, .pdf, .txt, .html, 等等)。

link.download = fileName;

click()事件触发下载

link.click();

四、创建并下载

选择相应的MIME类型并设置编码。

const foo = {hello: "world"};
const blob = new Blob([JSON.stringify(foo)], type: 'application/vnd.ms-excel;charset=utf-8');
const fileName = `${new Date().valueOf()}.xls`;
const link = document.createElement('a');
link.href = window.URL.createObjectURL(blob);
link.download = fileName;
link.click();
window.URL.revokeObjectURL(link.href);

注：下载指定扩展名的文件只需要对照MIME 参考手册设置type即可。

五、兼容IE

在IE中要使用window.navigator.msSaveOrOpenBlob来处理Blob对象。

window.navigator.msSaveOrOpenBlob(blob, fileName);

六、Promise写法

基于axios的写法。

axios.get(`url`, {
     responseType: 'arraybuffer',
 }).then(res => {
     if (res.status == 200) {
         let blob = new Blob([res.data], {
             type: 'application/vnd.ms-excel;charset=utf-8'
         });
         let fileName = `yourfile.xls`;
         // for IE
         if (window.navigator && window.navigator.msSaveOrOpenBlob) {
             window.navigator.msSaveOrOpenBlob(blob, fileName);
         } else {
             // for Non-IE
             let objectUrl = URL.createObjectURL(blob);
             let link = document.createElement("a");
             link.href = objectUrl;
             link.setAttribute("download", fileName);
             document.body.appendChild(link);
             link.click();
             window.URL.revokeObjectURL(link.href);
         }
     } else {
         // error handler
     }
 });

七、下载工具类实现

/**
 *
 * @param {*} data blod文件流
 * @param {*} name 下载后的文件名称
 */
export function download (data, name) {
  const blob = new Blob([data])
  const fileName = name
  if ('download' in document.createElement('a')) {
    // 非IE下载
    const elink = document.createElement('a')
    elink.download = fileName
    elink.style.display = 'none'
    elink.href = URL.createObjectURL(blob)
    document.body.appendChild(elink)
    elink.click()
    URL.revokeObjectURL(elink.href) // 释放URL 对象
    document.body.removeChild(elink)
  } else {
    // IE10+下载
    navigator.msSaveBlob(blob, fileName)
  }
}

八、页面实现代码

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Document</title>
  </head>
  <body>
    <div>
      <p>{hello : 'world'}</p>
      <p style="color: red;">you can click this btn to download this Object as a text file</p>
      <button id="download">download</button>
    </div>
    <!-- 浏览器不支持ES6的module直接使用，故在script标签上添加type="module" -->
    <script type="module" src="./utils.js"></script>
    <script type="module" >
     import { download } from './utils.js'
     var btn = document.getElementById("download");
      var obj = {hello : ' world '}
      // 原生dom的点击事件是onclick
      btn.onclick = function(){
        console.log("下载")
        download(JSON.stringify(obj),{type:'application/text;charset=utf-8'},'测试下载.txt')  
      } 
    </script>
  </body>
</html>

何以为皇

关注

0
点赞
踩
5

收藏

觉得还不错? 一键收藏
3
评论
前端利用Blob对象创建指定文件并下载

一、Blob对象Blob对象表示一个不可变、原始数据的类文件对象。Blob 表示的不一定是JavaScript原生格式的数据。File接口基于Blob，继承了blob的功能并将其扩展使其支持用户系统上的文件。构造函数var aBlob = new Blob( array, options );array是一个由ArrayBuffer（二进制数据缓冲区）、ArrayBufferView（二进制数据缓冲区的array-like视图）、Blob、DOMString等对象构成的Array，或者其他类似
复制链接

扫一扫