JS前端建立CSV或Excel文件并浏览器导出下载

时间 2019-12-04

标签前端建立 csv excel 文件浏览器导出下载栏目 JavaScript 繁體版

原文原文链接

长期以来，在作文件下载功能的时候都是前端经过ajax把须要生成的文件的内容参数传递给后端，后端经过Java语言将文件生成在服务器，而后返回一个文件下载的链接地址url。前端经过location.href = url或者window.open(url),完成文件的下载。javascript

前端彷佛在这个过程当中没有产生什么较大的做用，无非是发送请求和打开页面的做用。之前就在寻找这样的文件下载方式，今天终于在业务须要的压力下找到了对应的解决方案。html

HTML与文件下载

若是但愿在前端直接出发某些资源的下载，最方便快捷的方法就是使用HTML5原生的download属性，例如：前端

<a href="large.jpg" download>下载</a>

但显然，若是纯粹利用HTML属性来实现文件的下载（而不是浏览器打开或浏览），对于动态内容，就无能为力。html5

例如，咱们对于页面进行分享的时候，但愿分享图片是页面内容的实时截图，此时，这个图片就是动态的，纯HTML显然没法知足咱们的需求，借助JS和其余一些HTML5特性，例如，将页面元素转换到canvas上，而后在转成图片进行下载。java

单只是完成图片的下载不能知足平常业务的需求，对于业务需求是远远不够的。git

借助HTML5 Blob实现文本信息文件下载

若是对Blob不了解，能够先看看张鑫旭的理解DOMString、Document、FormData、Blob、File、ArrayBuffer数据类型一文。github

原理其实很简单，咱们能够将文本或者JS字符串借助Blob转换成二进制，而后，做为a元素的href属性，配合download属性，实现下载。ajax

代码也比较简单，以下示例（兼容Chrome和FireFox）：json

var funDownload = function(content, filename){
    // 建立隐藏的可下载连接
    var eleLink = document.createElement('a');
    eleLink.download = filename;
    eleLink.style.display = 'none';
    // 字符内容转变成blob地址
    var blob = new Blob([content]);
    eleLink.href = URL.createObjectURL(blob);
    // 触发点击
    document.body.appendChild(eleLink);
    eleLink.click();
    // 而后移除
    document.body.removeChild(eleLink);
};

其中，content指须要下载的文本或者字符串内容，filename指下载到系统中的文件名称。canvas

借助Base64实现任一文件下载

对于非文本文件，也是能够直接JS触发下载的，例如，若是咱们想下载一张图片，能够把这张图片转换成Base64格式，而后下载。

代码示例：

var funDownload = function(domImg, filename){
    // 建立隐藏的可下载连接
    var eleLink = document.createElement('a');
    eleLink.download = filename;
    eleLink.style.display = 'none';
    // 图片base64地址
    var canvas = document.createElement('canvas');
    var context = canvas.getContext('2d');
    var width = domImg.natureWidth;
    var height = domImg.natureHeight;
    context.drawImage(domImg, 0, 0);
    // 若是是PNG图片，则context.toDataURL('image/png');
    eleLink.href = context.toDataURL('image/jpeg');
    // 触发点击
    document.body.appendChild(eleLink);
    eleLink.click();
    // 移除
    document.body.removeChild(eleLink);
};

不止是.html文件，.txt,.json等只要内容是文本的文件，均可以利用这种小技巧实现下载。

在Chrome浏览器下，模拟点击建立的a元素及时不append到页面中，也是能够触发下载的，可是在FireFox浏览器中却不行，所以，上面的funcDownload()方法有一个appendChild和removeChild的处理，就是为了兼容FireFox浏览器。

继续说实如今下CSV文件的方法

咱们经过ajax从后端请求到的数据通常都是json格式，也就是说须要把json数据转成csv格式的数据，通过寻找终于找到了一个比较好用的json转csv的工具。

直接上示例代码：

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>Download</title>
    <link rel="stylesheet" href="">
</head>
<body>
    <div class="demo">
        <p><input type="button" value="做为test.html文件下载"></p>
    </div>
    <script src="json2csv.js" type="text/javascript" charset="utf-8"></script>
    <script type="text/javascript" charset="utf-8">
        // 示例数据
        var fields = ['car', 'price', 'color'];
        var myCars = [
          {
            "car": "Audi",
            "price": 40000,
            "color": "blue"
          }, {
            "car": "BMW",
            "price": 35000,
            "color": "black"
          }, {
            "car": "Porsche",
            "price": 60000,
            "color": "green"
          }
        ];
        // json数据转csv格式
        var csv = json2csv({ data: myCars, fields: fields });

        var eleButton = document.querySelector('input[type="button"]');

        // 下载文件方法
        var funDownload = function (content, filename) {
            var eleLink = document.createElement('a');
            eleLink.download = filename;
            eleLink.style.display = 'none';
            // 字符内容转变成blob地址
            var blob = new Blob([content]);
            eleLink.href = URL.createObjectURL(blob);
            // 触发点击
            document.body.appendChild(eleLink);
            eleLink.click();
            // 而后移除
            document.body.removeChild(eleLink);
        };

        if ('download' in document.createElement('a')) {
            // 做为test.html文件下载
            eleButton.addEventListener('click', function () {
                funDownload(csv, 'test.csv');    
            });
        } else {
            eleButton.onclick = function () {
                alert('浏览器不支持');    
            };
        }
    </script>
</body>
</html>

其中的json2csv.js文件能够在这里下载，或者获取源码。

内容参考来源

1.下载功能主要参考张鑫旭的博客中的一片文章：小tip:JS前端建立html或json文件并浏览器导出下载；

2.json2cav的代码参考来源为：https://github.com/zemirco/json2csv；