1. 全栈程序员必看首页

如何用 JavaScript 下载文件

全栈程序员-用户IM • • 未分类

如何用 JavaScript 下载文件简介我们知道，下载文件是一个非常常见的需求，但由于浏览器的安全策略的限制，我们通常只能通过一个额外的页面，访问某个文件的url来实现下载功能，但是这种用户体验非常不好。幸好，HTML5里面为  标签添加了一个 download 的属性，我们可以轻易的利用它来实现下载功能，再也不需要用以前的笨办法了。原理我们先看看 download 的使用方法：

大家好，又见面了，我是你们的朋友全栈君。


  • 简介

    我们知道，下载文件是一个非常常见的需求，但由于浏览器的安全策略的限制，我们通常只能通过一个额外的页面，访问某个文件的 url 来实现下载功能，但是这种用户体验非常不好。
    幸好，HTML 5 里面为 <a> 标签添加了一个 download 的属性，我们可以轻易的利用它来实现下载功能，再也不需要用以前的笨办法了。

    原理

    我们先看看 download 的使用方法：

           
       
       
    
        
        
        <a href="http://somehost/somefile.zip" download="filename.zip">Download file
        
        
        </a>

    看看上面的代码，只要为 <a> 标签添加 download 属性，我们点击这个链接的时候就会自动下载文件了~
    顺便说下，download 的属性值是可选的，它用来指定下载文件的文件名。像上面的例子中，我们下载到本地的文件名就会是 filename.zip 拉，如果不指定的话，它就会是 somefile.zip 这个名字拉！

    看到这里，你可能会说，坑爹啊，这明明是用 HTML 5 的新特性来实现下载文件嘛，说好的用 JavaScript 下载文件呢？

    事实上，用 JavaScript 来下载文件也是利用这一特性来实现的，我们的 JavaScript 代码不外乎就是：

  • 1.用 JavaScript 创建一个隐藏的 <a> 标签

  • 2.设置它的 href 属性

  • 3.设置它的 download 属性
  • 4.用 JavaScript 来触发这个它的 click 事件

翻译成 JavaScript 代码就是：

     
     
     

      
      
      var a = 
      
      
      document.createElement(
      
      
      'a');
     
     
     

     
     
     

      
      
      var url = 
      
      
      window.URL.createObjectURL(blob);
     
     
     

     
     
     

      
      
      var filename = 
      
      
      'what-you-want.txt';
     
     
     

     
     
     

      
      
      a.href = url;
     
     
     

     
     
     

      
      
      a.download = filename;
     
     
     

     
     
     

      
      
      a.click();
     
     
     

     
     
     

      
      
      window.URL.revokeObjectURL(url);

好拉，是不是看到有个陌生的东东呢？

window.URL

window.URL 里面有两个方法：

  • createObjectURL 用 blob 对象来创建一个 object URL(它是一个 DOMString)，我们可以用这个 object URL 来表示某个 blob 对象，这个 object URL 可以用在 href 和 src 之类的属性上。
  • revokeObjectURL 释放由 createObjectURL 创建的 object URL，当该 object URL 不需要的时候，我们要主动调用这个方法来获取最佳性能和内存使用。

知道了这两个方法之后，我们再回去看看上面的例子就很容易理解了吧！只是用 blob 对象来创建一条 URL，然后让 <a> 标签引用该 URL，然后触发个点击事件，就可以下载文件了！

那么问题来了，blob 对象哪里来？

Blob 对象

Blob 全称是 Binary large object，它表示一个类文件对象，可以用它来表示一个文件。根据 MDN 上面的说法，File API 也是基于 blob 来实现的。

由于本文的主题是讲 JavaScript 下载文件，那我们构建 blob 的方式就是通过服务器返回的文件来创建 blob 拉！
而最简单的方式就是用 fetch API 了，我们可以整合上面的例子：

     
     
     

      
      
      fetch(
      
      
      'http://somehost/somefile.zip').then(
      
      
      res => res.blob().then(
      
      
      blob => {
     
     
     

     
     
     
    
      
      
      var a = 
      
      
      document.createElement(
      
      
      'a');
     
     
     

     
     
     
    
      
      
      var url = 
      
      
      window.URL.createObjectURL(blob);
     
     
     

     
     
     
    
      
      
      var filename = 
      
      
      'myfile.zip';
     
     
     

     
     
     

      
      
          a.href = url;
     
     
     

     
     
     

      
      
          a.download = filename;
     
     
     

     
     
     

      
      
          a.click();
     
     
     

     
     
     
    
      
      
      window.URL.revokeObjectURL(url);
     
     
     

     
     
     

      
      
      }))

很简单对吧！

你可能会问，何必这么麻烦呢？直接写成下面这样不就好了：

     
     
     

      
      
      <a href="http://somehost/somefile.zip" download="myfile.zip">Download file
      
      
      </a>

嗯，对于这种写法，我只能说，你做的太正确了！如果你要下载的是已经存在服务器上面的静态文件的话，那么写成这样是最方便的。浏览器会帮你处理整个下载过程，不需要你干涉。如果你用 blob 的方式来下载文件的话，会有下面这些限制的：

限制一：不同浏览器对 blob 对象有不同的限制

具体看看下面这个表格（出自 FileSaver.js）：

Browser Constructs as Filenames Max Blob Size Dependencies
Firefox 20+ Blob Yes 800 MiB None
Firefox < 20 data: URI No n/a Blob.js
Chrome Blob Yes 500 MiB None
Chrome for Android Blob Yes 500 MiB None
Edge Blob Yes ? None
IE 10+ Blob Yes 600 MiB None
Opera 15+ Blob Yes 500 MiB None
Opera < 15 data: URI No n/a Blob.js
Safari 6.1+* Blob No ? None
Safari < 6 data: URI No n/a Blob.js

限制二：构建完 blob 对象后才会转换成文件

这一点限制对小文件(几十kb)可能没什么影响，但对稍微大一点的文件影响就很大了。试想，用户要下载一个 100mb 的文件，如果他点击了下载按钮之后没看到下载提示的话，他肯定会继续按，等他按了几次之后还没看到下载提示时，他就会抱怨我们的网站，然后离开了。

然而事实上下载的的确确发生了，只是要等到下载完文件之后才能构建 blob 对象，再转化成文件。而且，用户再触发多几次下载就会造成一些资源上的浪费。

因此，如果是要下载大文件的话，还是推荐直接创建一个 <a> 标签拉~
写 html 也好，写 JavaScript 动态创建也好，用自己喜欢的方式去创建就好了。

为什么要用 JavaScript 下载文件

好拉，说了半天，其实我们一直说的都是：「不要用 JavaScript 下载文件拉，限制多多，又不好用，直接用 html 就好拉，简单方便又快捷」这个论调。
事实上也确实如此，但有些时候我们确实需要通过 JavaScript 来做一些预处理。

权限校验

有些时候，我们需要对下载做一些限制，最常见的就是权限校验了，如检查该用户是否有下载的权限，是否有高速下载的权限等等。这时候，我们可以利用 JavaScript 做一些预处理。如：

     
     
     

      
      
      fetch(
      
      
      'http://somehost/check-permission', options).then(
      
      
      res => {
     
     
     

     
     
     
    
      
      
      if (res.code === 
      
      
      0) {
     
     
     

     
     
     
        
      
      
      var a = 
      
      
      document.createElement(
      
      
      'a');
     
     
     

     
     
     
        
      
      
      var url = res.data.url;
     
     
     

     
     
     
        
      
      
      var filename = 
      
      
      'myfile.zip';
     
     
     

     
     
     

      
      
              a.href = url;
     
     
     

     
     
     

      
      
              a.download = filename;
     
     
     

     
     
     

      
      
              a.click();
     
     
     

     
     
     

      
      
          } 
      
      
      else {
     
     
     

     
     
     

      
      
              alert(
      
      
      'You have no permission to download the file!');
     
     
     

     
     
     

      
      
          }
     
     
     

     
     
     

      
      
      });

在这个例子里面，我们没有用 blob 来构建 URL，而是通过后端服务器来计算出用户的下载链接，然后再利用之前提到的动态创建 <a> 标签的方式来实现下载，很简单吧！

动态文件

动态生成文件然后返回给客户端也是一个很常见的需求，譬如我们有时候需要做导出数据的功能，把数据库中的某些数据导出到 Excel 中，然后再返回客户端。
这时候我们就不能简单的指定 href 属性，因为对应的 URL 并不存在。
我们只能通过 JavaScript 对服务器发出一个请求，通知它去生成某个文件，然后把对应的 URL 返回给客户端。
有没有感觉这个过程和上面「权限校验」一节很像？肯定拉，因为我们只是对 URL 做了一些预处理而已嘛~

注意事项

由于 download 属性是 HTML 5 的新特性，因此它不支持旧版本的浏览器。

总结

HTML 5 新的 download 特性真的很好用，结合 JavaScript 的动态能力我们可以很方便的做出复杂的下载功能~

参考资料

https://github.com/eligrey/FileSaver.js/blob/master/FileSaver.js
https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL
https://developer.mozilla.org/en-US/docs/Web/API/Blob
http://stackoverflow.com/questions/19327749/javascript-blob-filename-without-link
http://stackoverflow.com/questions/24501358/how-to-set-a-header-for-a-http-get-request-and-trigger-file-download
http://blog.bguiz.com/2014/07/03/file-download-with-http-request-header/

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。

发布者：全栈程序员-用户IM，转载请注明出处：https://javaforall.cn/138766.html原文链接：https://javaforall.cn

【正版授权，激活自己账号】： Jetbrains全家桶Ide使用，1年售后保障，每天仅需1毛

【官方授权 正版激活】： 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

赞 (0)
全栈程序员-用户IM全栈程序员-用户IM
0 0


相关推荐

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号